Documentation

Rectangle - Open Dev Kit Documentation

Open Dev Kit Documentation :: General :: Rectangle

Root.Rect
Rectangle in 2D space

Functions

Constructor ( X Float, Y Float, Width Float, Height Float )
Creates a rectangle from a set of co-ordinates and dimension values
Constructor ( Top Left 2D Vector, Size 2D Vector )
Constructor ( Size 2D Vector )
Contains Vector ( Point 2D Vector, Include Bottom Right Edges Boolean ) Boolean
Returns true if this rectangle contains a point
Intersect Rect ( Rectangle Rectangle ) Boolean
Expand Rect ( Rectangle Rectangle )
Expands a rectangle based on specified values from a rectangle structure
Portioned ( Sub Rectangle Rectangle ) Rectangle
Returns the portion of the rectangle using factors from another rectangle whos values will generally range from 0.0 to 1.0
Transform Position ( Position 2D Vector, Area Rectangle ) 2D Vector
Returns a source Position within a source Area transformed relative to the rectangle's dimensions

Properties

X Float
X co-ordinate of the top-left corner
Y Float
X co-ordinate of the top-left corner
Width Float
width of the rectangle
Height Float
height of the rectangle
Left Float
X co-ordinate of the left edge
Top Float
Y co-ordinate of the top edge
Right Float
X co-ordinate of the right edge
Bottom Float
Y co-ordinate of the bottom edge
Top Left 2D Vector
co-ordinates of the top-left corner
Top Right 2D Vector
co-ordinates of the top-right corner
Bottom Left 2D Vector
co-ordinates of the bottom-left corner
Bottom Right 2D Vector
co-ordinates of the bottom-right corner
Position 2D Vector
co-ordinates of the rectangle's top-left corner position
Center 2D Vector
co-ordinates of the rectangle's center posiiton
Size 2D Vector
size of the rectangle
Scaled by Dpi Rectangle
vector with system's dpi factored (screen co-ordinates)
Unscaled by Dpi Rectangle
vector with system's dpi inversely factored (logical co-ordinates)

If you think anything is missing, please feel free to: submit documentation feedback on this page