Rect

Rect
Scaleform::Render::Rect
Declaration
template <class T>
class Rect : public RectData<T>;
Description

Rect defines a two-dimensional rectangle that is defined by its left-most top corner and right-most bottom corner. This class contains four components that make up these two points: x1, y1, x2 and y2. The coordinates are inclusive, public, and accessed directly; they can be set either directly or by calling the SetRect function.

Enumerations
Enumeration 
Description 
Specifies that the rectangle should not be initialized to identity upon construction. 
An enumeration used by SetRect and Rect constructors to initialize the rectangle with the minimum (Min) or maximum (Max) rectangle values. 
Methods
Method 
Description 
Area 
Returns the area of the rectangle. 
Returns the left-most bottom point in the rectangle. 
Returns the right-most bottom point in the rectangle. 
Returns a new rectangle representing the bottom of the local rectangle by default. 
Returns the center of the local rectangle. 
Returns the height of the local rectangle. 
Returns the width and height of the local rectangle. 
Returns the width of the local rectangle. 
Clamps the local rectangle with a passed rectangle by comparing their components. The greater x1 and y1, and lesser x2 and y2 components are chosen. 
Clamps a point to the rectangle and returns a new point inside the rectangle. 
Sets the current rectangle's left-most top coordinate to (0,0) and it's size (width and height) to 0. 
Contracts each side of the local rectangle by a set value. 
Determines whether a geometric shape exists completely inside of the current rectangle. 
Expands each side of the local rectangle by a set value. 
Expand the rectangle to enclose the given point. 
Sets the local rectangle to a passed rectangle in point/size form. 
Obtains the size (width and height) of the current rectangle. 
Returns a value representing the center of the width. 
Clamps the Left and Right values of a rectangle with alternate values. 
Contracts the local rectangle horizontally. 
Returns the height of the local rectangle. 
Expands the rectangle horizontally. 
Stores the intersection of two rectangles. 
Determines whether two rectangles intersect. 
Determines whether two rectangles intersect and calculates that intersection. 
Determines whether a rectangle touches the edge of another rectangle. 
Determines whether a rectangle is normal. 
Returns a new rectangle representing the left side of the current rectangle by default. 
Returns a normalized copy of the current rectangle. 
Normalizes the current rectangle. 
Normalizes the Left and Right components of the current rectangle. 
Normalizes the Top and Bottom components of the current rectangle. 
Offsets the current rectangle. 
Offsets the Left and Right components of a current rectangle. 
Offsets the Top and Bottom components of a current rectangle. 
Determines whether a rectangle is empty. 
Determines whether a rectangle is NULL. 
Rect 
Initializes a new instance of a rectangle. 
Returns a new rectangle representing the right side of the current rectangle by default. 
Sets the Bottom and Left components of the current rectangle. 
Sets the Bottom and Right components of the current rectangle. 
Sets the center of a rectangle. 
Sets the height of the rectangle by adjusting the position of Bottom. 
Sets the x value of the rectangle's center. 
Sets the range of the current rectangle by setting its Left and Right components. 
Set to a + (b - a) * t 
Initializes the Left, Top, Right, and Bottom components of the current rectangle. 
Sets the size (width and height) of the current rectangle. 
Sets the Top and Left components of the current rectangle. 
Sets the Top and Right components of the current rectangle. 
Sets the y value of the rectangle's center. 
Sets the Top and Bottom elements of the current rectangle. 
Sets the width of the current rectangle. 
Swap 
Swaps the components of the current rectangle with those of a passed rectangle. 
Returns a point representing the top left corner of the current rectangle. 
Returns a point representing the top right corner of the current rectangle. 
Returns a new rectangle representing the top side of the current rectangle by default. 
Converts the current rectangle into a rectangle in point/size form. 
Determines the union of two rectangles. 
Determines the union of two rectangles. 
Returns a value representing the y component of the center of the current rectangle. 
Clamps the Top and Bottom values of a rectangle with alternate values. 
Contracts the local rectangle vertically. 
Expands the rectangle vertically. 
Returns the current rectangle's width. 
X1 
Returns the Left value of the current rectangle. 
X2 
Returns the Right value of the current rectangle. 
Y1 
Returns the Top value of the current rectangle. 
Y2 
Returns the Bottom value of the current rectangle. 
Operators
Operator 
Description 
!= 
Determines the inequality of two rectangles. 
&= 
Determines the intersection of two rectangles. 
|= 
Determines the union of two rectangles. 
+= 
Offsets a rectangle positively (towards the bottom right-most corner). 
= 
Sets the x1, y1, x2, and y2 components of the local rectangle. 
-= 
Offsets a rectangle negatively (towards the top left-most corner). 
== 
Determines the equality of two rectangles. 
- 
Negates the rectangle. 
& 
Determines the intersection of two rectangles. 
| 
Determines the union of two rectangles. 
+ 
Determines the union of two rectangles. 
+ 
Offsets a rectangle positively (towards the bottom right-most corner). 
 
File

Render_Types2D.h