1. Epic GamesDeveloper
  3. TIntRect

TIntRect

Structure for integer rectangles in 2-d space.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Math

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Math/IntRect.h
Include #include "Math/IntRect.h"
Source /Engine/Source/Runtime/Core/Public/Math/MathFwd.h

Syntax

template<typename IntType >  
struct TIntRect

Remarks

Structure for integer rectangles in 2-d space.

Variables

  Type Name Description
Public variable union UE::Math::TIntRect    
Public variable IntPointType Max Holds the last pixel line/row (like in Win32 RECT).
Public variable IntPointType Min Holds the first pixel line/row (like in Win32 RECT).
Public variable IntPointType[2] MinMax  

Constructors

  Type Name Description
Public function   Constructor
Public function  

TIntRect ( const TIntRect& Other
)

  
Public function  

TIntRect ( TIntRect< OtherIntType > Other
)

 Converts to another int type. Checks that the cast will succeed.
Public function   Constructor
Public function  

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

 Constructor

Functions

  Type Name Description
Public function Const IntType

Area ()

 Calculates the area of this rectangle.
Public function Const TIntRect

Bottom ( IntType InHeight
)

 Creates a rectangle from the bottom part of this rectangle.
Public function void

Clip ( const TIntRect& R
)

 Clip a rectangle using the bounds of another rectangle.
Public function Const bool Test whether this rectangle contains a point.
Public function Static TIntRect  
Public function Static TIntRect Divides a rectangle and rounds up to the nearest integer.
Public function Const void

GetCenterAndExtents ( IntPointType& OutCenter,
IntPointType& OutExtent
)

 Gets the Center and Extents of this rectangle.
Public function Const IntType

Height ()

 Gets the Height of the rectangle.
Public function void
Include

( IntPointType Point
)

 Adds to this rectangle to include a given point.
Public function void

InflateRect ( IntType Amount
)

 Inflates or deflates the rectangle.
Public function Const TIntRect

Inner ( IntPointType Shrink
)

 Gets a new rectangle from the inner of this one.
Public function Const bool

Intersect ( const TIntRect& Other
)

 Returns true if the two rects have any overlap.
Public function Const bool

IsEmpty ()

 Returns true if the rectangle is 0 x 0.
Public function Static int32

Num ()

 Gets number of points in the Rectangle.
Public function Const TIntRect

Right ( IntType InWidth
)

 Creates a rectangle from the right hand side of this rectangle.
Public function Const TIntRect

Scale ( double Fraction
)

 Scales a rectangle using a floating point number.
Public function Const IntPointType

Size ()

 Gets the distance from one corner of the rectangle to the other.
Public function Const FString Get a textual representation of this rectangle.
Public function void

Union ( const TIntRect& R
)

 Combines the two rectanges.
Public function Const IntType

Width ()

 Gets the width of the rectangle.

Operators

  Type Name Description
Public function Const TIntRect

operator- ( const TIntRect& Other
)

 Gets the result of subtracting a rectangle from this one.
Public function Const TIntRect

operator- ( const IntPointType& Point
)

 Gets the result of subtracting a point from this rectangle.
Public function Const bool

operator!= ( const TIntRect& Other
)

 Compares Rectangles for inequality.
Public function TIntRect &

operator() ( int32 PointIndex
)

 Gets a specific point in this rectangle.
Public function Const const TIntRect &

operator() ( int32 PointIndex
)

 Gets a specific point in this rectangle.
Public function Const TIntRect

operator* ( IntType Scale
)

 Gets the result of scaling on this rectangle.
Public function TIntRect &

operator*= ( IntType Scale
)

 Applies scaling to this rectangle.
Public function Const TIntRect

operator/ ( const IntPointType& Point
)

 Gets the result of dividing a point with this rectangle.
Public function Const TIntRect

operator/ ( IntType Div
)

 Gets the result of division on this rectangle.
Public function Const TIntRect

operator+ ( const TIntRect& Other
)

 Gets the result of adding two rectangles together.
Public function Const TIntRect

operator+ ( const IntPointType& Point
)

 Gets the result of adding a point to this rectangle.
Public function TIntRect &

operator+= ( const IntPointType& Point
)

 Adds a point to this rectangle.
Public function TIntRect &

operator= ( const TIntRect& Other
)

  
Public function TIntRect &

operator-= ( const IntPointType& Point
)

 Subtracts a point from this rectangle.
Public function Const bool

operator== ( const TIntRect& Other
)

 Compares Rectangles for equality.

Typedefs

Name Description
IntPointType  
IntType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page