1. Epic GamesDeveloper
  3. TIntRect

TIntRect

Structure for integer rectangles in 2-d space. Represented as half-open bounds [min, max)

API > API/Runtime > API/Runtime/Core

Structure for integer rectangles in 2-d space.

Represented as half-open bounds [min, max)

   
Name TIntRect
Type struct
Header File /Engine/Source/Runtime/Core/Public/Math/IntRect.h
Include Path #include "Math/IntRect.h"
Source /Engine/Source/Runtime/Core/Public/Math/MathFwd.h

Syntax

template<typename IntType>  
struct TIntRect

Constructors

Name Remarks Include Path Unreal Specifiers

TIntRect ( IntPointType InMin,
IntPointType InMax
)

 Constructor Math/IntRect.h  
Constructor Math/IntRect.h  

TIntRect ( const TIntRect& Other
)

   Math/IntRect.h  

TIntRect ( TIntRect< OtherIntType > Other
)

 Converts to another int type. Checks that the cast will succeed. Math/IntRect.h  

TIntRect ( IntType X0,
IntType Y0,
IntType X1,
IntType Y1
)

 Constructor Math/IntRect.h  

Typedefs

Name Type Remarks Include Path
IntPointType TIntPoint< IntType >   Math/IntRect.h
IntType InIntType   Math/IntRect.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Max IntPointType Holds the last pixel line/row (like in Win32 RECT). Math/IntRect.h  
Min IntPointType Holds the first pixel line/row (like in Win32 RECT). Math/IntRect.h  
MinMax IntPointType   Math/IntRect.h  
TIntRect union UE::Math::TIntRect   Math/IntRect.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

IntType Area()

 Calculates the area of this rectangle. Math/IntRect.h  

TIntRect Bottom ( IntType InHeight
) const

 Creates a rectangle from the bottom part of this rectangle. Math/IntRect.h  

void Clip ( const TIntRect& R
)

 Clip a rectangle using the bounds of another rectangle. Math/IntRect.h  

bool Contains ( const FIntRect& Other
) const

 Test whether this rectangle fully contains other rectangle. Math/IntRect.h  

bool Contains ( IntPointType P
) const

 Test whether this rectangle contains a point. Math/IntRect.h  

void GetCenterAndExtents ( IntPointType& OutCenter,
IntPointType& OutExtent
) const

 Gets the Center and Extents of this rectangle. Math/IntRect.h  

IntType Height()

 Gets the Height of the rectangle. Math/IntRect.h  

void Include ( IntPointType Point
)

 Adds to this rectangle to include a given point. Math/IntRect.h  

void InflateRect ( IntType Amount
)

 Inflates or deflates the rectangle. Math/IntRect.h  

TIntRect Inner ( IntPointType Shrink
) const

 Gets a new rectangle from the inner of this one. Math/IntRect.h  

bool Intersect ( const TIntRect& Other
) const

 Returns true if the two rects have any overlap. Math/IntRect.h  

bool IsEmpty()

 Returns true if the rectangle is 0 x 0. Math/IntRect.h  

TIntRect Right ( IntType InWidth
) const

 Creates a rectangle from the right hand side of this rectangle. Math/IntRect.h  

TIntRect Scale ( double Fraction
) const

 Scales a rectangle using a floating point number. Math/IntRect.h  

IntPointType Size()

 Gets the distance from one corner of the rectangle to the other. Math/IntRect.h  

FString ToString()

 Get a textual representation of this rectangle. Math/IntRect.h  

void Union ( const TIntRect& R
)

 Combines the two rectangles. Math/IntRect.h  

IntType Width()

 Gets the width of the rectangle. Math/IntRect.h  

Static

Name Remarks Include Path Unreal Specifiers

static TIntRect DivideAndRoundUp ( TIntRect lhs,
IntPointType Div
)

   Math/IntRect.h  

static TIntRect DivideAndRoundUp ( TIntRect lhs,
IntType Div
)

 Divides a rectangle and rounds up to the nearest integer. Math/IntRect.h  

static int32 Num()

 Gets number of points in the Rectangle. Math/IntRect.h  

Operators

Name Remarks Include Path Unreal Specifiers

TIntRect operator- ( const TIntRect& Other
) const

 Gets the result of subtracting a rectangle from this one. Math/IntRect.h  

TIntRect operator- ( const IntPointType& Point
) const

 Gets the result of subtracting a point from this rectangle. Math/IntRect.h  

bool operator!= ( const TIntRect& Other
) const

 Compares Rectangles for inequality. Math/IntRect.h  

TIntRect & operator() ( int32 PointIndex
)

 Gets a specific point in this rectangle. Math/IntRect.h  

const TIntRect & operator() ( int32 PointIndex
) const

 Gets a specific point in this rectangle. Math/IntRect.h  

TIntRect operator* ( IntType Scale
) const

 Gets the result of scaling on this rectangle. Math/IntRect.h  

TIntRect & operator*= ( IntType Scale
)

 Applies scaling to this rectangle. Math/IntRect.h  

TIntRect operator/ ( const IntPointType& Point
) const

 Gets the result of dividing a point with this rectangle. Math/IntRect.h  

TIntRect operator/ ( IntType Div
) const

 Gets the result of division on this rectangle. Math/IntRect.h  

TIntRect operator+ ( const TIntRect& Other
) const

 Gets the result of adding two rectangles together. Math/IntRect.h  

TIntRect operator+ ( const IntPointType& Point
) const

 Gets the result of adding a point to this rectangle. Math/IntRect.h  

TIntRect & operator+= ( const IntPointType& Point
)

 Adds a point to this rectangle. Math/IntRect.h  

TIntRect & operator= ( const TIntRect& Other
)

   Math/IntRect.h  

TIntRect & operator-= ( const IntPointType& Point
)

 Subtracts a point from this rectangle. Math/IntRect.h  

bool operator== ( const TIntRect& Other
) const

 Compares Rectangles for equality. Math/IntRect.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page