SFXRectangle

Class which represents a rectangle.

#include <SFXRectangle.h.hpp>

class SFXRectangle;

SFMTYPEDEFCLASS(SFXRectangle)

Collaboration diagram

Member

Constructor/Destructor
SFXRectangle( `Void` ) Constructor of the SFXRectangle.
SFXRectangle( `SFXRectangleConstRef` param ) Constructor of the SFXRectangle.
SFXRectangle( `SFXGridConstRef` origin , `SFXSizeConstRef` size ) Constructor of the SFXRectangle.
SFXRectangle( `SFXGridConstRef` origin , `SInt16` width , `SInt16` height ) Constructor of the SFXRectangle.
SFXRectangle( `SInt16` x , `SInt16` y , `SFXSizeConstRef` size ) Constructor of the SFXRectangle.
SFXRectangle( `SInt16` x , `SInt16` y , `SInt16` width , `SInt16` height ) Constructor of the SFXRectangle.
SFXRectangle( `SFXPixelConstRef` start , `SFXPixelConstRef` end ) Constructor of the SFXRectangle.

Public Functions
`SFXRectangleRef`	AddBottom( `SInt16` param ) Add the specified value to the Y coordinate of bottom edge.
`SFXRectangleRef`	AddHeight( `SInt16` param ) Add the specified value to the height.
`SFXRectangleRef`	AddLeft( `SInt16` param ) Add the specified value to the X coordinate of left edge.
`SFXRectangleRef`	AddLeftBottom( `SFXGridConstRef` param ) Add the specified value to the coordinates of left-bottom vertex.
`SFXRectangleRef`	AddLeftBottom( `SInt16` x , `SInt16` y ) Add the specified value to the coordinates of left-bottom vertex.
`SFXRectangleRef`	AddLeftTop( `SFXGridConstRef` param ) Add the specified value to the coordinates of left-top vertex.
`SFXRectangleRef`	AddLeftTop( `SInt16` x , `SInt16` y ) Add the specified value to the coordinates of left-top vertex.
`SFXRectangleRef`	AddOrigin( `SFXGridConstRef` param ) Add the specified value to the coordinates of the origin (left-top vertex).
`SFXRectangleRef`	AddOrigin( `SInt16` x , `SInt16` y ) Add the specified value to the coordinates of the origin (left-top vertex).
`SFXRectangleRef`	AddRight( `SInt16` param ) Add the specified value to the X coordinate of right edge.
`SFXRectangleRef`	AddRightBottom( `SFXGridConstRef` param ) Add the specified value to the coordinates of right-bottom vertex.
`SFXRectangleRef`	AddRightBottom( `SInt16` x , `SInt16` y ) Add the specified value to the coordinates of right-bottom vertex.
`SFXRectangleRef`	AddRightTop( `SFXGridConstRef` param ) Add the specified value to the coordinates of right-top vertex.
`SFXRectangleRef`	AddRightTop( `SInt16` x , `SInt16` y ) Add the specified value to the coordinates of right-top vertex.
`SFXRectangleRef`	AddSize( `SFXSizeConstRef` param ) Add the specified value to the size.
`SFXRectangleRef`	AddSize( `SInt16` width , `SInt16` height ) Add the specified value to the size.
`SFXRectangleRef`	AddTop( `SInt16` param ) Add the specified value to the Y coordinate of top edge.
`SFXRectangleRef`	AddWidth( `SInt16` param ) Add the specified value to the width.
`SFXRectangleRef`	AddX( `SInt16` param ) Add the specified value to the X coordinate of left-top vertex.
`SFXRectangleRef`	AddY( `SInt16` param ) Add the specified value to the Y coordinate of left-top vertex.
`SFXRectangleRef`	Deflate( `SFXMarginConstRef` param ) Deflate this rectangle by the specified value.
`SFXRectangleRef`	Deflate( `SFXSizeConstRef` lt , `SFXSizeConstRef` rb ) Deflate this rectangle by the specified value.
`SFXRectangleRef`	Deflate( `SFXSizeConstRef` lt , `SInt16` right , `SInt16` bottom ) Deflate this rectangle by the specified value.
`SFXRectangleRef`	Deflate( `SInt16` left , `SInt16` top , `SFXSizeConstRef` rb ) Deflate this rectangle by the specified value.
`SFXRectangleRef`	Deflate( `SInt16` left , `SInt16` top , `SInt16` right , `SInt16` bottom ) Deflate this rectangle by the specified value.
`SFXRectangleRef`	Deflate( `SInt16` horizontal , `SInt16` vertical ) Deflate this rectangle by the specified value.
`SFXRectangleRef`	DivBottom( `SInt16` param ) Divide the Y coordinate of bottom edge by the specified value.
`SFXRectangleRef`	DivHeight( `SInt16` param ) Divide the height by the specified value.
`SFXRectangleRef`	DivLeft( `SInt16` param ) Divide the X coordinate of left edge by the specified value.
`SFXRectangleRef`	DivLeftBottom( `SInt16` x , `SInt16` y ) Divide the coordinates of left-bottom vertex by the specified value.
`SFXRectangleRef`	DivLeftBottom( `SInt16` param ) Divide the coordinates of left-bottom vertex by the specified value.
`SFXRectangleRef`	DivLeftTop( `SInt16` x , `SInt16` y ) Divide the coordinates of left-top vertex by the specified value.
`SFXRectangleRef`	DivLeftTop( `SInt16` param ) Divide the coordinates of left-top vertex by the specified value.
`SFXRectangleRef`	DivOrigin( `SInt16` x , `SInt16` y ) Divide the coordinates of the origin (left-top vertex) by the specified value.
`SFXRectangleRef`	DivOrigin( `SInt16` param ) Divide the coordinates of the origin (left-top vertex) by the specified value.
`SFXRectangleRef`	DivRight( `SInt16` param ) Divide the X coordinate of right edge by the specified value.
`SFXRectangleRef`	DivRightBottom( `SInt16` x , `SInt16` y ) Divide the coordinates of right-bottom vertex.
`SFXRectangleRef`	DivRightBottom( `SInt16` param ) Divide the coordinates of right-bottom vertex.
`SFXRectangleRef`	DivRightTop( `SInt16` x , `SInt16` y ) Divide the coordinates of right-top vertex by the specified value.
`SFXRectangleRef`	DivRightTop( `SInt16` param ) Divide the coordinates of right-top vertex by the specified value.
`SFXRectangleRef`	DivSize( `SInt16` width , `SInt16` height ) Divide the size by the specified value.
`SFXRectangleRef`	DivSize( `SInt16` param ) Divide the size by the specified value.
`SFXRectangleRef`	DivTop( `SInt16` param ) Divide the Y coordinate of top edge by the specified value.
`SFXRectangleRef`	DivWidth( `SInt16` param ) Divide the width by the specified value.
`SFXRectangleRef`	DivX( `SInt16` param ) Divide the X coordinate of left-top vertex by the specified value.
`SFXRectangleRef`	DivY( `SInt16` param ) Divide the Y coordinate of left-top vertex by the specified value.
static `SFXRectangleConstRef`	EmptyInstance( `Void` ) Get an empty rectangle.
`Bool`	Equals( `SFXRectangleConstRef` param ) Check whether this rectangle equals the specified rectangle or not.
`Bool`	Equals( `SFXGridConstRef` origin , `SFXSizeConstRef` size ) Check whether this rectangle equals the specified rectangle or not.
`Bool`	Equals( `SFXGridConstRef` origin , `SInt16` width , `SInt16` height ) Check whether this rectangle equals the specified rectangle or not.
`Bool`	Equals( `SInt16` x , `SInt16` y , `SFXSizeConstRef` size ) Check whether this rectangle equals the specified rectangle or not.
`Bool`	Equals( `SInt16` x , `SInt16` y , `SInt16` width , `SInt16` height ) Check whether this rectangle equals the specified rectangle or not.
`SInt16`	GetBottom( `Void` ) Get the Y coordinate of the bottom edge.
`SInt16`	GetCenter( `Void` ) Get the X coordinate of the center of rectangle.
`SFXGrid`	GetCenterBottom( `Void` ) Get the grid coordinate of the bottom edge of rectangle.
`SFXGrid`	GetCenterMiddle( `Void` ) Get the grid coordinate of the center of rectangle.
`SFXGrid`	GetCenterTop( `Void` ) Get the grid coordinate of the top edge of rectangle.
`SFXLine`	GetEdgeBottom( `Void` ) Get the bottom edge as a line.
`SFXLine`	GetEdgeLeft( `Void` ) Get the left edge as a line.
`SFXLine`	GetEdgeRight( `Void` ) Get the right edge as a line.
`SFXLine`	GetEdgeTop( `Void` ) Get the top edge as a line.
`SInt16`	GetHeight( `Void` ) Get the height.
`SInt16`	GetLeft( `Void` ) Get the X coordinate of the left edge.
`SFXGrid`	GetLeftBottom( `Void` ) Get the grid coordinates of left-bottom vertex.
`SFXGrid`	GetLeftMiddle( `Void` ) Get the grid coordinate of the center of the left edge of rectangle.
`SFXGrid`	GetLeftTop( `Void` ) Get the grid coordinates of left-top vertex.
`SInt16`	GetMiddle( `Void` ) Get the Y coordinate of the center of rectangle.
`SFXGridConstRef`	GetOrigin( `Void` ) Get the grid coordinate of the origin (left-top vertex).
`SInt16`	GetRight( `Void` ) Get the X coordinate of the right edge.
`SFXGrid`	GetRightBottom( `Void` ) Get the grid coordinate of right-bottom vertex.
`SFXGrid`	GetRightMiddle( `Void` ) Get the grid coordinate of the center of the right edge of rectangle.
`SFXGrid`	GetRightTop( `Void` ) Get the grid coordinates of right-top vertex.
`SFXSizeConstRef`	GetSize( `Void` ) Get the size.
`SInt16`	GetTop( `Void` ) Get the Y coordinate of the top edge.
`SFXPixel`	GetVertexLeftBottom( `Void` ) Get the pixel coordinate of left-bottom vertex.
`SFXPixel`	GetVertexLeftTop( `Void` ) Get the pixel coordinate of left-top vertex.
`SFXPixel`	GetVertexRightBottom( `Void` ) Get the pixel coordinates of right-bottom vertex.
`SFXPixel`	GetVertexRightTop( `Void` ) Get the pixel coordinate of right-top vertex.
`SInt16`	GetWidth( `Void` ) Get the width.
`SInt16`	GetX( `Void` ) Get the X coordinate of left-top vertex.
`SInt16`	GetY( `Void` ) Get the Y coordinate of left-top vertex.
`SFXRectangleRef`	Inflate( `SFXMarginConstRef` param ) Inflate this rectangle by the specified value.
`SFXRectangleRef`	Inflate( `SFXSizeConstRef` lt , `SFXSizeConstRef` rb ) Inflate this rectangle by the specified value.
`SFXRectangleRef`	Inflate( `SFXSizeConstRef` lt , `SInt16` right , `SInt16` bottom ) Inflate this rectangle by the specified value.
`SFXRectangleRef`	Inflate( `SInt16` left , `SInt16` top , `SFXSizeConstRef` rb ) Inflate this rectangle by the specified value.
`SFXRectangleRef`	Inflate( `SInt16` left , `SInt16` top , `SInt16` right , `SInt16` bottom ) Inflate this rectangle by the specified value.
`SFXRectangleRef`	Inflate( `SInt16` horizontal , `SInt16` vertical ) Inflate this rectangle by the specified value.
`SFXRectangleRef`	Intersection( `SFXRectangleConstRef` param ) Get the intersection of this rectangle with the specified rectangle.
`Bool`	IntersectsWith( `SFXRectangleConstRef` param ) Check whether this rectangle intersects with the specified rectangle or not.
`Bool`	IsEmpty( `Void` ) Check whether or not this rectangle is empty.
`Bool`	IsInsideOf( `SFXRectangleConstRef` param ) Check whether this rectangle is inside of the specified rectangle or not.
`SFXMargin`	MarginTo( `SFXRectangleConstRef` param ) Get the margin between this rectangle and the specified rectangle.
`SFXRectangleRef`	ModBottom( `SInt16` param ) Set the Y coordinate of the bottom edge to the remainder of the division of this coordinate by the specified value.
`SFXRectangleRef`	ModHeight( `SInt16` param ) Set the height to the remainder of the division of the height by the specified value.
`SFXRectangleRef`	ModLeft( `SInt16` param ) Set the X coordinate of the left edge to the remainder of the division of this coordinate by the specified value.
`SFXRectangleRef`	ModLeftBottom( `SInt16` x , `SInt16` y ) Set the coordinates of left-bottom vertex to the remainder of the division of this coordinates by the specified value.
`SFXRectangleRef`	ModLeftBottom( `SInt16` param ) Set the coordinates of left-bottom vertex to the remainder of the division of this coordinates by the specified value.
`SFXRectangleRef`	ModLeftTop( `SInt16` x , `SInt16` y ) Set the coordinates of left-top vertex to the remainder of the division of this coordinates by the specified value.
`SFXRectangleRef`	ModLeftTop( `SInt16` param ) Set the coordinates of left-top vertex to the remainder of the division of this coordinates by the specified value.
`SFXRectangleRef`	ModOrigin( `SInt16` x , `SInt16` y ) Set the origin coordinates (left-top vertex) to the remainder of the division of this coordinates by the specified value.
`SFXRectangleRef`	ModOrigin( `SInt16` param ) Set the origin coordinates (left-top vertex) to the remainder of the division of this coordinates by the specified value.
`SFXRectangleRef`	ModRight( `SInt16` param ) Set the X coordinate of the right edge to the remainder of the division of this coordinate by the specified value.
`SFXRectangleRef`	ModRightBottom( `SInt16` x , `SInt16` y ) Set the coordinates of right-bottom vertex to the remainder of the division of this coordinates by the specified value.
`SFXRectangleRef`	ModRightBottom( `SInt16` param ) Set the coordinates of right-bottom vertex to the remainder of the division of this coordinates by the specified value.
`SFXRectangleRef`	ModRightTop( `SInt16` x , `SInt16` y ) Set the coordinates of right-top vertex to the remainder of the division of this coordinates by the specified value.
`SFXRectangleRef`	ModRightTop( `SInt16` param ) Set the coordinates of right-top vertex to the remainder of the division of this coordinates by the specified value.
`SFXRectangleRef`	ModSize( `SInt16` width , `SInt16` height ) Set the size to the remainder of the division of this size by the specified value.
`SFXRectangleRef`	ModSize( `SInt16` param ) Set the size to the remainder of the division of this size by the specified value.
`SFXRectangleRef`	ModTop( `SInt16` param ) Set the Y coordinate of top edge to the remainder of the division of this coordinate by the specified value..
`SFXRectangleRef`	ModWidth( `SInt16` param ) Set the width to the remainder of the division of this width by the specified value.
`SFXRectangleRef`	ModX( `SInt16` param ) Set the X coordinate of left-top vertex to the remainder of the division of this coordinate by the specified value.
`SFXRectangleRef`	ModY( `SInt16` param ) Set the Y coordinate of left-top vertex to the remainder of the division of this coordinate by the specified value.
`SFXRectangleRef`	MulBottom( `SInt16` param ) Multiply the Y coordinate of this bottom edge by the specified value.
`SFXRectangleRef`	MulHeight( `SInt16` param ) Multiply the height by the specified value.
`SFXRectangleRef`	MulLeft( `SInt16` param ) Multiply the X coordinate of the left edge by the specified value.
`SFXRectangleRef`	MulLeftBottom( `SInt16` x , `SInt16` y ) Multiply the coordinates of left-bottom vertex by the specified value.
`SFXRectangleRef`	MulLeftBottom( `SInt16` param ) Multiply the coordinates of left-bottom vertex by the specified value.
`SFXRectangleRef`	MulLeftTop( `SInt16` x , `SInt16` y ) Multiply the coordinates of left-top vertex by the specified value.
`SFXRectangleRef`	MulLeftTop( `SInt16` param ) Multiply the coordinates of left-top vertex by the specified value.
`SFXRectangleRef`	MulOrigin( `SInt16` x , `SInt16` y ) Multiply the origin coordinates (left-top vertex) by the specified value.
`SFXRectangleRef`	MulOrigin( `SInt16` param ) Multiply the origin coordinates (left-top vertex) by the specified value.
`SFXRectangleRef`	MulRight( `SInt16` param ) Multiply the X coordinate of the right edge by the specified value.
`SFXRectangleRef`	MulRightBottom( `SInt16` x , `SInt16` y ) Multiply the coordinates of right-bottom vertex by the specified value.
`SFXRectangleRef`	MulRightBottom( `SInt16` param ) Multiply the coordinates of right-bottom vertex by the specified value.
`SFXRectangleRef`	MulRightTop( `SInt16` x , `SInt16` y ) Multiply the coordinates of right-top vertex by the specified value.
`SFXRectangleRef`	MulRightTop( `SInt16` param ) Multiply the coordinates of right-top vertex by the specified value.
`SFXRectangleRef`	MulSize( `SInt16` width , `SInt16` height ) Multiply the size by the specified value.
`SFXRectangleRef`	MulSize( `SInt16` param ) Multiply the size by the specified value.
`SFXRectangleRef`	MulTop( `SInt16` param ) Multiply the Y coordinate of the top edge by the specified value.
`SFXRectangleRef`	MulWidth( `SInt16` param ) Multiply the width by the specified value.
`SFXRectangleRef`	MulX( `SInt16` param ) Multiply the X coordinate of left-top vertex by the specified value.
`SFXRectangleRef`	MulY( `SInt16` param ) Multiply the Y coordinate of left-top vertex by the specified value.
`SFXRectangleRef`	NegBottom( `Void` ) Negate the sign of the Y coordinate of bottom edge.
`SFXRectangleRef`	NegHeight( `Void` ) Negate the sign of the height.
`SFXRectangleRef`	NegLeft( `Void` ) Negate the sign of the X coordinate of left edge.
`SFXRectangleRef`	NegLeftBottom( `Void` ) Negate the sign of the coordinates of left-bottom vertex.
`SFXRectangleRef`	NegLeftTop( `Void` ) Negate the sign of the coordinates of left-top vertex.
`SFXRectangleRef`	NegOrigin( `Void` ) Negate the sign of the coordinates of origin point (left-top vertex).
`SFXRectangleRef`	NegRight( `Void` ) Negate the sign of the X coordinate of right edge.
`SFXRectangleRef`	NegRightBottom( `Void` ) Negate the sign of the coordinate of right-bottom vertex.
`SFXRectangleRef`	NegRightTop( `Void` ) Negate the sign of the coordinate of right-top vertex.
`SFXRectangleRef`	NegSize( `Void` ) Negate the sign of the size.
`SFXRectangleRef`	NegTop( `Void` ) Negate the sign of the Y coordinate of top edge.
`SFXRectangleRef`	NegWidth( `Void` ) Negate the sign of the width.
`SFXRectangleRef`	NegX( `Void` ) Negate the sign of the X coordinate of left-top vertex.
`SFXRectangleRef`	NegY( `Void` ) Negate the sign of the Y coordinate of left-top vertex.
`SFXRectangleRef`	Normalize( `Void` ) Normalize the rectangle.
`SFXRectangleRef`	Offset( `SFXGridConstRef` param ) Add the specified value to the coordinates of the origin point (left-top vertex) and move this rectangle.
`SFXRectangleRef`	Offset( `SInt16` x , `SInt16` y ) Add the specified value to the coordinates of the origin point (left-top vertex) and move this rectangle.
`SFXRectangleRef`	Set( `SFXRectangleConstRef` param ) Set the rectangle.
`SFXRectangleRef`	Set( `SFXGridConstRef` origin , `SFXSizeConstRef` size ) Set the rectangle.
`SFXRectangleRef`	Set( `SFXGridConstRef` origin , `SInt16` width , `SInt16` height ) Set the rectangle.
`SFXRectangleRef`	Set( `SInt16` x , `SInt16` y , `SFXSizeConstRef` size ) Set the rectangle.
`SFXRectangleRef`	Set( `SInt16` x , `SInt16` y , `SInt16` width , `SInt16` height ) Set the rectangle.
`SFXRectangleRef`	Set( `SFXPixelConstRef` start , `SFXPixelConstRef` end ) Set the rectangle.
`SFXRectangleRef`	SetBottom( `SInt16` param ) Set the Y coordinate of buttom edge.
`SFXRectangleRef`	SetHeight( `SInt16` param ) Set the height.
`SFXRectangleRef`	SetLeft( `SInt16` param ) Set the X coordinate of left edge.
`SFXRectangleRef`	SetLeftBottom( `SFXGridConstRef` param ) Set the grid coordinates of left-bottom vertex.
`SFXRectangleRef`	SetLeftBottom( `SInt16` x , `SInt16` y ) Set the grid coordinates of left-bottom vertex.
`SFXRectangleRef`	SetLeftTop( `SFXGridConstRef` param ) Set the grid coordinates of left-top vertex.
`SFXRectangleRef`	SetLeftTop( `SInt16` x , `SInt16` y ) Set the grid coordinates of left-top vertex.
`SFXRectangleRef`	SetOrigin( `SFXGridConstRef` param ) Set the grid coordinates of origin point (left-top vertex).
`SFXRectangleRef`	SetOrigin( `SInt16` x , `SInt16` y ) Set the grid coordinates of origin point (left-top vertex).
`SFXRectangleRef`	SetRight( `SInt16` param ) Set the X coordinate of right edge.
`SFXRectangleRef`	SetRightBottom( `SFXGridConstRef` param ) Set the grid coordinates of right-bottom vertex.
`SFXRectangleRef`	SetRightBottom( `SInt16` x , `SInt16` y ) Set the grid coordinates of right-bottom vertex.
`SFXRectangleRef`	SetRightTop( `SFXGridConstRef` param ) Set the grid coordinates of right-top vertex.
`SFXRectangleRef`	SetRightTop( `SInt16` x , `SInt16` y ) Set the grid coordinates of right-top vertex.
`SFXRectangleRef`	SetSize( `SFXSizeConstRef` param ) Set the size.
`SFXRectangleRef`	SetSize( `SInt16` width , `SInt16` height ) Set the size.
`SFXRectangleRef`	SetTop( `SInt16` param ) Set the Y coordinate of top edge.
`SFXRectangleRef`	SetVertexLeftBottom( `SFXPixelConstRef` param ) Set the pixel coordinates of left-bottom vertex.
`SFXRectangleRef`	SetVertexLeftBottom( `SInt16` x , `SInt16` y ) Set the pixel coordinates of left-bottom vertex.
`SFXRectangleRef`	SetVertexLeftTop( `SFXPixelConstRef` param ) Set the pixel coordinates of left-top vertex.
`SFXRectangleRef`	SetVertexLeftTop( `SInt16` x , `SInt16` y ) Set the pixel coordinates of left-top vertex.
`SFXRectangleRef`	SetVertexRightBottom( `SFXPixelConstRef` param ) Set the pixel coordinates of right-bottom vertex.
`SFXRectangleRef`	SetVertexRightBottom( `SInt16` x , `SInt16` y ) Set the pixel coordinates of right-bottom vertex.
`SFXRectangleRef`	SetVertexRightTop( `SFXPixelConstRef` param ) Set the pixel coordinates of right-top vertex.
`SFXRectangleRef`	SetVertexRightTop( `SInt16` x , `SInt16` y ) Set the pixel coordinates of right-top vertex.
`SFXRectangleRef`	SetWidth( `SInt16` param ) Set the width.
`SFXRectangleRef`	SetX( `SInt16` param ) Set the X coordinate of left-top vertex.
`SFXRectangleRef`	SetY( `SInt16` param ) Set the Y coordinate of left-top vertex.
`SFXRectangleRef`	SnapBottom( `SInt16` param ) Set the Y coordinate of bottom edge and move this rectangle.
`SFXRectangleRef`	SnapCenter( `SInt16` param ) Set the X coordinate of the center of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapCenterBottom( `SFXGridConstRef` param ) Set the center of the bottom edge of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapCenterBottom( `SInt16` x , `SInt16` y ) Set the center of the bottom edge of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapCenterMiddle( `SFXGridConstRef` param ) Set the center of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapCenterMiddle( `SInt16` x , `SInt16` y ) Set the center of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapCenterTop( `SFXGridConstRef` param ) Set the center of the top edge of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapCenterTop( `SInt16` x , `SInt16` y ) Set the center of the top edge of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapLeft( `SInt16` param ) Set the X coordinate of left edge and move this rectangle.
`SFXRectangleRef`	SnapLeftBottom( `SFXGridConstRef` param ) Set the coordinates of left-bottom vertex and move this rectangle.
`SFXRectangleRef`	SnapLeftBottom( `SInt16` x , `SInt16` y ) Set the coordinates of left-bottom vertex and move this rectangle.
`SFXRectangleRef`	SnapLeftMiddle( `SFXGridConstRef` param ) Set the center of the left edge of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapLeftMiddle( `SInt16` x , `SInt16` y ) Set the center of the left edge of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapLeftTop( `SFXGridConstRef` param ) Set the coordinates of left-top vertex and move this rectangle.
`SFXRectangleRef`	SnapLeftTop( `SInt16` x , `SInt16` y ) Set the coordinates of left-top vertex and move this rectangle.
`SFXRectangleRef`	SnapMiddle( `SInt16` param ) Set the Y coordinate of the center of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapRight( `SInt16` param ) Set the X coordinate of right edge and move this rectangle.
`SFXRectangleRef`	SnapRightBottom( `SFXGridConstRef` param ) Set the coordinates of right-bottom vertex and move this rectangle.
`SFXRectangleRef`	SnapRightBottom( `SInt16` x , `SInt16` y ) Set the coordinates of right-bottom vertex and move this rectangle.
`SFXRectangleRef`	SnapRightMiddle( `SFXGridConstRef` param ) Set the center of the right edge of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapRightMiddle( `SInt16` x , `SInt16` y ) Set the center of the right edge of rectangle to the specified value and move the rectangle.
`SFXRectangleRef`	SnapRightTop( `SFXGridConstRef` param ) Set the coordinate of right-top vertex, ,move the rectangle.
`SFXRectangleRef`	SnapRightTop( `SInt16` x , `SInt16` y ) Set the coordinate of right-top vertex, ,move the rectangle.
`SFXRectangleRef`	SnapTop( `SInt16` param ) Set the Y coordinate top edge and move this rectangle.
`SFXRectangleRef`	SubBottom( `SInt16` param ) Subtract the specified value from the Y coordinate of bottom edge.
`SFXRectangleRef`	SubHeight( `SInt16` param ) Subtract the specified value from the Height.
`SFXRectangleRef`	SubLeft( `SInt16` param ) Subtract the specified value from the X coordinate of left edge.
`SFXRectangleRef`	SubLeftBottom( `SFXGridConstRef` param ) Subtract the specified value from the coordinates of left-bottom vertex.
`SFXRectangleRef`	SubLeftBottom( `SInt16` x , `SInt16` y ) Subtract the specified value from the coordinates of left-bottom vertex.
`SFXRectangleRef`	SubLeftTop( `SFXGridConstRef` param ) Subtract the specified value from the coordinates of left-top vertex.
`SFXRectangleRef`	SubLeftTop( `SInt16` x , `SInt16` y ) Subtract the specified value from the coordinates of left-top vertex.
`SFXRectangleRef`	SubOrigin( `SFXGridConstRef` param ) Subtract the specified value from the coordinates of origin point (left-top vertex).
`SFXRectangleRef`	SubOrigin( `SInt16` x , `SInt16` y ) Subtract the specified value from the coordinates of origin point (left-top vertex).
`SFXRectangleRef`	SubRight( `SInt16` param ) Subtract the specified value from the X coordinate of right edge.
`SFXRectangleRef`	SubRightBottom( `SFXGridConstRef` param ) Subtract the specified value from the coordinates of right-bottom vertex.
`SFXRectangleRef`	SubRightBottom( `SInt16` x , `SInt16` y ) Subtract the specified value from the coordinates of right-bottom vertex.
`SFXRectangleRef`	SubRightTop( `SFXGridConstRef` param ) Subtract the specified value from the coordinate of right-top vertex.
`SFXRectangleRef`	SubRightTop( `SInt16` x , `SInt16` y ) Subtract the specified value from the coordinate of right-top vertex.
`SFXRectangleRef`	SubSize( `SFXSizeConstRef` param ) Subtract the specified value from the size.
`SFXRectangleRef`	SubSize( `SInt16` width , `SInt16` height ) Subtract the specified value from the size.
`SFXRectangleRef`	SubTop( `SInt16` param ) Subtract the specified value from the Y coordinate of top edge.
`SFXRectangleRef`	SubWidth( `SInt16` param ) Subtract the specified value from the width.
`SFXRectangleRef`	SubX( `SInt16` param ) Subtract the specified value from the X coordinate of left-top vertex.
`SFXRectangleRef`	SubY( `SInt16` param ) Subtract the specified value from the Y coordinate of left-top vertex.
`Bool`	UnifiesWith( `SFXRectangleConstRef` param ) Check whether this rectangle unifies with another rectangle.
`SFXRectangleRef`	Union( `SFXRectangleConstRef` param ) Union two rectangles.
`SFXRectangleRef`	Unoffset( `SFXGridConstRef` param ) Subtract from the coordinates of origin point (left-top vertex) and move this rectangle.
`SFXRectangleRef`	Unoffset( `SInt16` x , `SInt16` y ) Subtract from the coordinates of origin point (left-top vertex) and move this rectangle.
static `SFXRectangleConstRef`	ZeroInstance( `Void` ) Get the instance that represents 0.
`SFXRectangle`	operator &( `SFXRectangleConstRef` left , `SFXRectangleConstRef` right ) Get the intersection of the left rectangle with the right rectangle.
`SFXRectangleRef`	operator &=( `SFXRectangleConstRef` param ) Get the intersection of the left rectangle with the right rectangle and set it to the left rectangle.
`SFXRectangleRef`	operator+=( `SFXGridConstRef` param ) Add the specified value to the coordinates of left-top vertex and move this rectangle.
`SFXRectangleRef`	operator-=( `SFXGridConstRef` param ) Subtract the specified value from the coordinates of left-top vertex and move this rectangle.
`SFXRectangleRef`	operator=( `SFXRectangleConstRef` param ) Assign a rectangle.
`SFXRectangle`	operator\|( `SFXRectangleConstRef` left , `SFXRectangleConstRef` right ) Get the rectangle that covers the two specified rectangles.
`SFXRectangleRef`	operator\|=( `SFXRectangleConstRef` param ) Get and set to the rectangle that covers the two specified rectangles.
`SFXRectangle::AtomRec *`	atomic_cast( `SFXRectangle *` param ) Convert SFXRectangle into SFXRectangle::AtomRec.
`SFXRectangle::AtomRec const *`	atomic_cast( `SFXRectangle const *` param ) Convert SFXRectangle into SFXRectangle::AtomRec.
`AEERect *`	interface_cast( `SFXRectangle *` param ) Convert SFXRectangle into AEERect.
`AEERect const *`	interface_cast( `SFXRectangle const *` param ) Convert SFXRectangle into AEERect.
`Bool`	operator==( `SFXRectangleConstRef` left , `SFXRectangleConstRef` right ) Check the "==" relation.
`SFXRectangle`	operator-( `SFXRectangleConstRef` left , `SFXGridConstRef` right ) Subtract the specified value from the coordinates of left-bottom vertex and move this rectangle.
`Bool`	operator!=( `SFXRectangleConstRef` left , `SFXRectangleConstRef` right ) Check the "!=" relation.
`SFXRectangle`	operator+( `SFXRectangleConstRef` left , `SFXGridConstRef` right ) Add the specified value to the coordinates of left-top vertex and move this rectangle.

Types
AtomRec Structure that represents a rectangle.

Global Functions
`SFXRectangle::AtomRec *`	atomic_cast( `SFXRectangle *` param ) Convert SFXRectangle into SFXRectangle::AtomRec.
`SFXRectangle::AtomRec const *`	atomic_cast( `SFXRectangle const *` param ) Convert SFXRectangle into SFXRectangle::AtomRec.
`AEERect *`	interface_cast( `SFXRectangle *` param ) Convert SFXRectangle into AEERect.
`AEERect const *`	interface_cast( `SFXRectangle const *` param ) Convert SFXRectangle into AEERect.
`Bool`	operator==( `SFXRectangleConstRef` left , `SFXRectangleConstRef` right ) Check the "==" relation.
`SFXRectangle`	operator-( `SFXRectangleConstRef` left , `SFXGridConstRef` right ) Subtract the specified value from the coordinates of left-bottom vertex and move this rectangle.
`Bool`	operator!=( `SFXRectangleConstRef` left , `SFXRectangleConstRef` right ) Check the "!=" relation.
`SFXRectangle`	operator+( `SFXRectangleConstRef` left , `SFXGridConstRef` right ) Add the specified value to the coordinates of left-top vertex and move this rectangle.

SFXRectangle::SFXRectangle

Constructor of the SFXRectangle.

[ public, explicit ]
SFXRectangle(Void);

[ public ]
SFXRectangle(
    SFXRectangleConstRef param   // the source rectangle
);

[ public, explicit ]
SFXRectangle(
    SFXGridConstRef origin   // coordinates of left-top vertex  
    SFXSizeConstRef size     // size
);

[ public, explicit ]
SFXRectangle(
    SFXGridConstRef origin   // coordinates of left-top vertex  
    SInt16 width             // value
    SInt16 height            // height
);

[ public, explicit ]
SFXRectangle(
    SInt16 x               // X coordinate of left-top vertex  
    SInt16 y               // Y coordinate of left-top vertex  
    SFXSizeConstRef size   // size
);

[ public, explicit ]
SFXRectangle(
    SInt16 x        // X coordinate of left-top vertex  
    SInt16 y        // Y coordinate of left-top vertex  
    SInt16 width    // value
    SInt16 height   // height
);

[ public, explicit ]
SFXRectangle(
    SFXPixelConstRef start   // coordinates of left-top vertex  
    SFXPixelConstRef end     // coordinates of right-bottom vertex  
);

SFXRectangle::AddBottom

Add the specified value to the Y coordinate of bottom edge.

[ public ]
SFXRectangleRef AddBottom(
    SInt16 param   // value to add
);

Reference

SFXRectangle::AddHeight

Add the specified value to the height.

[ public ]
SFXRectangleRef AddHeight(
    SInt16 param   // value to add
);

Reference

SFXRectangle::AddLeft

Add the specified value to the X coordinate of left edge.

[ public ]
SFXRectangleRef AddLeft(
    SInt16 param   // value to add
);

Reference

SFXRectangle::AddLeftBottom

Add the specified value to the coordinates of left-bottom vertex.

[ public ]
SFXRectangleRef AddLeftBottom(
    SFXGridConstRef param   // value to add to the coordinates of left-bottom vertex
);

[ public ]
SFXRectangleRef AddLeftBottom(
    SInt16 x   // value to add to the X coordinate of left-bottom vertex
    SInt16 y   // value to add to the Y coordinate of left-bottom vertex
);

Reference

SFXRectangle::AddLeftTop

Add the specified value to the coordinates of left-top vertex.

[ public ]
SFXRectangleRef AddLeftTop(
    SFXGridConstRef param   // value to add to the coordinates of left-top vertex
);

[ public ]
SFXRectangleRef AddLeftTop(
    SInt16 x   // value to add to the X coordinate of left-top vertex
    SInt16 y   // value to add to the Y coordinate of left-top vertex
);

Example

SFXRectangle rect(10, 20, 30, 40);

rect.AddLeftTop(10, 10);   // add to the coordinates of left-top vertex with (10, 10)
                           // the width and height will be modified after the addition
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 20, y = 30, width = 20, height = 30

Reference

SFXRectangle::AddOrigin

Add the specified value to the coordinates of the origin (left-top vertex).

[ public ]
SFXRectangleRef AddOrigin(
    SFXGridConstRef param   // value to add
);

[ public ]
SFXRectangleRef AddOrigin(
    SInt16 x   // value to add to X coordinate
    SInt16 y   // value to add to Y coordinate
);

Example

SFXRectangle rect(10, 20, 30, 40);

rect.AddOrigin(10, 10);   // add to the origin coordinates with (10, 10)
                          // as the origin has been moved, the entire rectangle is moved, too (the width and height are not changed)
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 20, y = 30, width = 30, height = 40

Reference

SFXRectangle::AddRight

Add the specified value to the X coordinate of right edge.

[ public ]
SFXRectangleRef AddRight(
    SInt16 param   // value to add
);

Reference

SFXRectangle::AddRightBottom

Add the specified value to the coordinates of right-bottom vertex.

[ public ]
SFXRectangleRef AddRightBottom(
    SFXGridConstRef param   // value to add to the coordinates of right-bottom vertex
);

[ public ]
SFXRectangleRef AddRightBottom(
    SInt16 x   // value to add to X coordinate of right-bottom vertex
    SInt16 y   // value to add to Y coordinate of right-bottom vertex
);

Reference

SFXRectangle::AddRightTop

Add the specified value to the coordinates of right-top vertex.

[ public ]
SFXRectangleRef AddRightTop(
    SFXGridConstRef param   // value to add to the coordinates of right-top vertex
);

[ public ]
SFXRectangleRef AddRightTop(
    SInt16 x   // value to add the X coordinate of right-top vertex
    SInt16 y   // value to add the Y coordinate of right-top vertex
);

Reference

SFXRectangle::AddSize

Add the specified value to the size.

[ public ]
SFXRectangleRef AddSize(
    SFXSizeConstRef param   // value to add
);

[ public ]
SFXRectangleRef AddSize(
    SInt16 width    // value to add
    SInt16 height   // value to add
);

Reference

SFXRectangle::AddTop

Add the specified value to the Y coordinate of top edge.

[ public ]
SFXRectangleRef AddTop(
    SInt16 param   // value to add
);

Reference

SFXRectangle::AddWidth

Add the specified value to the width.

[ public ]
SFXRectangleRef AddWidth(
    SInt16 param   // value to add
);

Reference

SFXRectangle::AddX

Add the specified value to the X coordinate of left-top vertex.

[ public ]
SFXRectangleRef AddX(
    SInt16 param   // value to add
);

Reference

SFXRectangle::AddY

Add the specified value to the Y coordinate of left-top vertex.

[ public ]
SFXRectangleRef AddY(
    SInt16 param   // value to add
);

Reference

SFXRectangle::Deflate

Deflate this rectangle by the specified value.

[ public ]
SFXRectangleRef Deflate(
    SFXMarginConstRef param   // value to deflate (margin)
);

[ public ]
SFXRectangleRef Deflate(
    SFXSizeConstRef lt   // value to deflate on left-top
    SFXSizeConstRef rb   // value to deflate on right-bottom
);

[ public ]
SFXRectangleRef Deflate(
    SFXSizeConstRef lt   // value to deflate on left-top
    SInt16 right         // value to deflate on right
    SInt16 bottom        // value to deflate on bottom
);

[ public ]
SFXRectangleRef Deflate(
    SInt16 left          // value to deflate on left
    SInt16 top           // value to deflate on top
    SFXSizeConstRef rb   // value to deflate on right-bottom
);

[ public ]
SFXRectangleRef Deflate(
    SInt16 left     // value to deflate on left
    SInt16 top      // value to deflate on top
    SInt16 right    // value to deflate on right
    SInt16 bottom   // value to deflate on bottom
);

[ public ]
SFXRectangleRef Deflate(
    SInt16 horizontal   // value to deflate on left
    SInt16 vertical     // value to deflate on top
);

Example

SFXRectangle rect(10, 20, 30, 40);

// deflate the rectangle
rect.Deflate(10, 10);

TRACE("x = %d, y = %d, width = %d, height = %d", rect1.GetX(), rect1.GetY(), rect1.GetWidth(), rect1.GetHeight());  // x = 20, y = 30, width = 10, height = 20

Reference

SFXRectangle::Inflate

SFXRectangle::DivBottom

Divide the Y coordinate of bottom edge by the specified value.

[ public ]
SFXRectangleRef DivBottom(
    SInt16 param   // value to divide
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::DivHeight

Divide the height by the specified value.

[ public ]
SFXRectangleRef DivHeight(
    SInt16 param   // value to divide
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::DivLeft

Divide the X coordinate of left edge by the specified value.

[ public ]
SFXRectangleRef DivLeft(
    SInt16 param   // value to divide
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::DivLeftBottom

Divide the coordinates of left-bottom vertex by the specified value.

[ public ]
SFXRectangleRef DivLeftBottom(
    SInt16 x   // divide the X coordinate of left-bottom vertex by this value
    SInt16 y   // divide the Y coordinate of left-bottom vertex by this value
);

[ public ]
SFXRectangleRef DivLeftBottom(
    SInt16 param   // divide the coordinates of left-bottom vertex by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Reference

SFXRectangle::DivLeftTop

Divide the coordinates of left-top vertex by the specified value.

[ public ]
SFXRectangleRef DivLeftTop(
    SInt16 x   // divide the X coordinate of left-top vertex by this value
    SInt16 y   // divide the Y coordinate of left-top vertex by this value
);

[ public ]
SFXRectangleRef DivLeftTop(
    SInt16 param   // divide the coordinates of left-top vertex by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Example

SFXRectangle rect(10, 20, 30, 40);

rect.DivLeftTop(10, 10);   // divide the coordinates of left-top vertex by (10, 10)
                           // the width and height will be modified after the division
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 1, y = 2, width = 39, height = 58

Reference

SFXRectangle::DivOrigin

Divide the coordinates of the origin (left-top vertex) by the specified value.

[ public ]
SFXRectangleRef DivOrigin(
    SInt16 x   // divide the X coordinate by this value
    SInt16 y   // divide the Y coordinate by this value
);

[ public ]
SFXRectangleRef DivOrigin(
    SInt16 param   // divide the origin coordinates by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Example

SFXRectangle rect(10, 20, 30, 40);

rect.DivOrigin(10, 10);   // divide the origin coordinates by (10, 10)
                          // as the origin has been moved, the entire rectangle is moved, too (width and height are not changed)
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 1, y = 2, width = 30, height = 40

Reference

SFXRectangle::DivRight

Divide the X coordinate of right edge by the specified value.

[ public ]
SFXRectangleRef DivRight(
    SInt16 param   // value to divide
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::DivRightBottom

Divide the coordinates of right-bottom vertex.

[ public ]
SFXRectangleRef DivRightBottom(
    SInt16 x   // divide the X coordinate of right-bottom vertex by this value
    SInt16 y   // divide the Y coordinate of right-bottom vertex by this value
);

[ public ]
SFXRectangleRef DivRightBottom(
    SInt16 param   // divide the coordinates of right-bottom vertex by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Reference

SFXRectangle::DivRightTop

Divide the coordinates of right-top vertex by the specified value.

[ public ]
SFXRectangleRef DivRightTop(
    SInt16 x   // divide the X coordinate of right-top vertex by this value
    SInt16 y   // divide the Y coordinate of right-top vertex by this value
);

[ public ]
SFXRectangleRef DivRightTop(
    SInt16 param   // divide the coordinates of right-top vertex by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Reference

SFXRectangle::DivSize

Divide the size by the specified value.

[ public ]
SFXRectangleRef DivSize(
    SInt16 width    // divide the width by this value
    SInt16 height   // divide the height by this value
);

[ public ]
SFXRectangleRef DivSize(
    SInt16 param   //divide the width and height by this value
);

Description

The behaviour is not defined when the value of width, height, or param argument is 0.

Reference

SFXRectangle::DivTop

Divide the Y coordinate of top edge by the specified value.

[ public ]
SFXRectangleRef DivTop(
    SInt16 param   // value to divide
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::DivWidth

Divide the width by the specified value.

[ public ]
SFXRectangleRef DivWidth(
    SInt16 param   // value to divide
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::DivX

Divide the X coordinate of left-top vertex by the specified value.

[ public ]
SFXRectangleRef DivX(
    SInt16 param   // value to divide
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::DivY

Divide the Y coordinate of left-top vertex by the specified value.

[ public ]
SFXRectangleRef DivY(
    SInt16 param   // value to divide
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::EmptyInstance

Get an empty rectangle.

[ public, static ]
SFXRectangleConstRef EmptyInstance(Void);

Return value

Return an empty SFXRectangle instance, which means this shape has no area.

Description

A shape has no area if the value of a length-related variable is less than or equals 0. This instance is used mainly as initial value of the assignment statement or return value of the shape-related function.

SFXRectangle::Equals

Check whether this rectangle equals the specified rectangle or not.

[ public, const ]
Bool Equals(
    SFXRectangleConstRef param   // rectangle to compare
);

[ public, const ]
Bool Equals(
    SFXGridConstRef origin   // coordinates of left-top vertex of the rectangle to compare
    SFXSizeConstRef size     // size of the rectangle to compare
);

[ public, const ]
Bool Equals(
    SFXGridConstRef origin   // coordinates of left-top vertex of the rectangle to compare
    SInt16 width             // width of the rectangle to compare
    SInt16 height            // height of the rectangle to compare
);

[ public, const ]
Bool Equals(
    SInt16 x               // X coordinate of left-top vertex of the rectangle to compare
    SInt16 y               // Y coordinate of left-top vertex of the rectangle to compare
    SFXSizeConstRef size   // size of the rectangle to compare
);

[ public, const ]
Bool Equals(
    SInt16 x        // X coordinate of left-top vertex of the rectangle to compare
    SInt16 y        // Y coordinate of left-top vertex of the rectangle to compare
    SInt16 width    // width of the rectangle to compare
    SInt16 height   // height of the rectangle to compare
);

Return value

If yes: true
Otherwise: false

Reference

operator== | operator!=

SFXRectangle::GetBottom

Get the Y coordinate of the bottom edge.

[ public, const ]
SInt16 GetBottom(Void);

Reference

SFXRectangle::GetCenter

Get the X coordinate of the center of rectangle.

[ public, const ]
SInt16 GetCenter(Void);

Reference

SFXRectangle::SnapCenter

SFXRectangle::GetCenterBottom

Get the grid coordinate of the bottom edge of rectangle.

[ public, const ]
SFXGrid GetCenterBottom(Void);

Reference

SFXRectangle::SnapCenterBottom

SFXRectangle::GetCenterMiddle

Get the grid coordinate of the center of rectangle.

[ public, const ]
SFXGrid GetCenterMiddle(Void);

Reference

SFXRectangle::SnapCenterMiddle

SFXRectangle::GetCenterTop

Get the grid coordinate of the top edge of rectangle.

[ public, const ]
SFXGrid GetCenterTop(Void);

Reference

SFXRectangle::SnapCenterTop

SFXRectangle::GetEdgeBottom

Get the bottom edge as a line.

[ public, const ]
SFXLine GetEdgeBottom(Void);

SFXRectangle::GetEdgeLeft

Get the left edge as a line.

[ public, const ]
SFXLine GetEdgeLeft(Void);

SFXRectangle::GetEdgeRight

Get the right edge as a line.

[ public, const ]
SFXLine GetEdgeRight(Void);

SFXRectangle::GetEdgeTop

Get the top edge as a line.

[ public, const ]
SFXLine GetEdgeTop(Void);

SFXRectangle::GetHeight

Get the height.

[ public, const ]
SInt16 GetHeight(Void);

Reference

SFXRectangle::GetLeft

Get the X coordinate of the left edge.

[ public, const ]
SInt16 GetLeft(Void);

Reference

SFXRectangle::GetLeftBottom

Get the grid coordinates of left-bottom vertex.

[ public, const ]
SFXGrid GetLeftBottom(Void);

Reference

SFXRectangle::GetLeftMiddle

Get the grid coordinate of the center of the left edge of rectangle.

[ public, const ]
SFXGrid GetLeftMiddle(Void);

Reference

SFXRectangle::SnapLeftMiddle

SFXRectangle::GetLeftTop

Get the grid coordinates of left-top vertex.

[ public, const ]
SFXGrid GetLeftTop(Void);

Reference

SFXRectangle::GetMiddle

Get the Y coordinate of the center of rectangle.

[ public, const ]
SInt16 GetMiddle(Void);

Reference

SFXRectangle::SnapMiddle

SFXRectangle::GetOrigin

Get the grid coordinate of the origin (left-top vertex).

[ public, const ]
SFXGridConstRef GetOrigin(Void);

Reference

SFXRectangle::GetRight

Get the X coordinate of the right edge.

[ public, const ]
SInt16 GetRight(Void);

Reference

SFXRectangle::GetRightBottom

Get the grid coordinate of right-bottom vertex.

[ public, const ]
SFXGrid GetRightBottom(Void);

Reference

SFXRectangle::GetRightMiddle

Get the grid coordinate of the center of the right edge of rectangle.

[ public, const ]
SFXGrid GetRightMiddle(Void);

Reference

SFXRectangle::SnapRightMiddle

SFXRectangle::GetRightTop

Get the grid coordinates of right-top vertex.

[ public, const ]
SFXGrid GetRightTop(Void);

Reference

SFXRectangle::GetSize

Get the size.

[ public, const ]
SFXSizeConstRef GetSize(Void);

Reference

SFXRectangle::GetTop

Get the Y coordinate of the top edge.

[ public, const ]
SInt16 GetTop(Void);

Reference

SFXRectangle::GetVertexLeftBottom

Get the pixel coordinate of left-bottom vertex.

[ public, const ]
SFXPixel GetVertexLeftBottom(Void);

Reference

SFXRectangle::GetVertexLeftTop

Get the pixel coordinate of left-top vertex.

[ public, const ]
SFXPixel GetVertexLeftTop(Void);

Reference

SFXRectangle::GetVertexRightBottom

Get the pixel coordinates of right-bottom vertex.

[ public, const ]
SFXPixel GetVertexRightBottom(Void);

Reference

SFXRectangle::GetVertexRightTop

Get the pixel coordinate of right-top vertex.

[ public, const ]
SFXPixel GetVertexRightTop(Void);

Reference

SFXRectangle::GetWidth

Get the width.

[ public, const ]
SInt16 GetWidth(Void);

Reference

SFXRectangle::GetX

Get the X coordinate of left-top vertex.

[ public, const ]
SInt16 GetX(Void);

Reference

SFXRectangle::GetY

Get the Y coordinate of left-top vertex.

[ public, const ]
SInt16 GetY(Void);

Reference

SFXRectangle::Inflate

Inflate this rectangle by the specified value.

[ public ]
SFXRectangleRef Inflate(
    SFXMarginConstRef param   // size to inflate (margin)
);

[ public ]
SFXRectangleRef Inflate(
    SFXSizeConstRef lt   // expand the left-top with this size
    SFXSizeConstRef rb   // expand the right-bottom with this size
);

[ public ]
SFXRectangleRef Inflate(
    SFXSizeConstRef lt   // expand the left-top with this size
    SInt16 right         // expand the right side with this value
    SInt16 bottom        // expand the bottom with this value
);

[ public ]
SFXRectangleRef Inflate(
    SInt16 left          // expand the left side with this value
    SInt16 top           // expand the top with this value
    SFXSizeConstRef rb   // expand the right-bottom vertex with this size
);

[ public ]
SFXRectangleRef Inflate(
    SInt16 left     // expand the left with this value
    SInt16 top      // expand the top with this value
    SInt16 right    // expand the right side with this value
    SInt16 bottom   // expand the bottom with this value
);

[ public ]
SFXRectangleRef Inflate(
    SInt16 horizontal   // expand the left with this value
    SInt16 vertical     // expand the top with this value
);

Example

SFXRectangle rect(10, 20, 30, 40);

// inflate the rectangle
rect.Inflate(20, 20);

TRACE("x = %d, y = %d, width = %d, height = %d", rect1.GetX(), rect1.GetY(), rect1.GetWidth(), rect1.GetHeight());  // x = -10, y = 0, width = 70, height = 80

Reference

SFXRectangle::Deflate

SFXRectangle::Intersection

Get the intersection of this rectangle with the specified rectangle.

[ public ]
SFXRectangleRef Intersection(
    SFXRectangleConstRef param   // rectangle to compare
);

Example

SFXRectangle rect1(10,20,30,40);
SFXRectangle rect2(30,40,50,60);

 // get the intersection of rect1 and rect2 
rect1 = rect1.Intersection(rect2);

TRACE("x = %d, y = %d, width = %d, height = %d", rect1.GetX(), rect1.GetY(), rect1.GetWidth(), rect1.GetHeight());   // x = 30, y = 40, width = 10, height = 20

Reference

SFXRectangle::IntersectsWith | SFXRectangle::operator & | SFXRectangle::operator &=

SFXRectangle::IntersectsWith

Check whether this rectangle intersects with the specified rectangle or not.

[ public, const ]
Bool IntersectsWith(
    SFXRectangleConstRef param   // rectangle to check
);

Description

If yes: true
Otherwise: false

Reference

SFXRectangle::Intersection | SFXRectangle::operator & | SFXRectangle::operator &=

SFXRectangle::IsEmpty

Check whether or not this rectangle is empty.

[ public, const ]
Bool IsEmpty(Void);

Return value

If yes: true
Otherwise: false

Description

This fucntion checks whether or not this rectangle is empty.

If the width or height of this rectangle is less than or equals 0, true will be returned.

Reference

SFXRectangle::EmptyInstance | SFXRectangle::ZeroInstance | SFXRectangle::AtomRec

SFXRectangle::IsInsideOf

Check whether this rectangle is inside of the specified rectangle or not.

[ public, const ]
Bool IsInsideOf(
    SFXRectangleConstRef param   // basic rectangle
);

Return value

If yes: true
Otherwise: false

SFXRectangle::MarginTo

Get the margin between this rectangle and the specified rectangle.

[ public, const ]
SFXMargin MarginTo(
    SFXRectangleConstRef param   // the rectangle outside
);

Description

This function gets the margin between this rectangle and the specified rectangle.

	Note
	This function computes the margin assuming that the param rectangle includes this rectangle. Conversely, if this rectangle includes the param rectangle, a negative margin will be returned.

Reference

SFXMargin

SFXRectangle::ModBottom

Set the Y coordinate of the bottom edge to the remainder of the division of this coordinate by the specified value.

[ public ]
SFXRectangleRef ModBottom(
    SInt16 param   // divide Y coordinate by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::ModHeight

Set the height to the remainder of the division of the height by the specified value.

[ public ]
SFXRectangleRef ModHeight(
    SInt16 param   // divide the height by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::ModLeft

Set the X coordinate of the left edge to the remainder of the division of this coordinate by the specified value.

[ public ]
SFXRectangleRef ModLeft(
    SInt16 param   // divide X coordinate by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::ModLeftBottom

Set the coordinates of left-bottom vertex to the remainder of the division of this coordinates by the specified value.

[ public ]
SFXRectangleRef ModLeftBottom(
    SInt16 x   // divide X coordinate by this value
    SInt16 y   // divide Y coordinate by this value
);

[ public ]
SFXRectangleRef ModLeftBottom(
    SInt16 param   // divide the coordinates by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Reference

SFXRectangle::ModLeftTop

Set the coordinates of left-top vertex to the remainder of the division of this coordinates by the specified value.

[ public ]
SFXRectangleRef ModLeftTop(
    SInt16 x   // divide X coordinate by this value
    SInt16 y   // divide Y coordinate by this value
);

[ public ]
SFXRectangleRef ModLeftTop(
    SInt16 param   // divide the coordinates by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Example

SFXRectangle rect(10, 20, 30, 40);

rect.ModLeftTop(10, 10);   // modular divide the coordinate of left-top vertex by (10, 10)
                           // the width and height will be changed after the division, too
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 0, y = 0, width = 40, height = 60

Reference

SFXRectangle::ModOrigin

Set the origin coordinates (left-top vertex) to the remainder of the division of this coordinates by the specified value.

[ public ]
SFXRectangleRef ModOrigin(
    SInt16 x   // divide X coordinate by this value
    SInt16 y   // divide Y coordinate by this value
);

[ public ]
SFXRectangleRef ModOrigin(
    SInt16 param   // divide the coordinates by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Example

SFXRectangle rect(10, 20, 30, 40);

rect.ModOrigin(10, 10);   // modular divide the origin coordinates by (10, 10)
                          // as the origin point has been moved, the entire rectangle is moved, too (width and height are not changed)
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 0, y = 0, width = 30, height = 40

Reference

SFXRectangle::ModRight

Set the X coordinate of the right edge to the remainder of the division of this coordinate by the specified value.

[ public ]
SFXRectangleRef ModRight(
    SInt16 param   // divide the X coordinate by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::ModRightBottom

Set the coordinates of right-bottom vertex to the remainder of the division of this coordinates by the specified value.

[ public ]
SFXRectangleRef ModRightBottom(
    SInt16 x   // divide X coordinate by this value
    SInt16 y   // divide Y coordinate by this value
);

[ public ]
SFXRectangleRef ModRightBottom(
    SInt16 param   // divide the coordinates by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Reference

SFXRectangle::ModRightTop

Set the coordinates of right-top vertex to the remainder of the division of this coordinates by the specified value.

[ public ]
SFXRectangleRef ModRightTop(
    SInt16 x   // divide X coordinate by this value
    SInt16 y   // divide Y coordinate by this value
);

[ public ]
SFXRectangleRef ModRightTop(
    SInt16 param   // divide the coordinates by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Reference

SFXRectangle::ModSize

Set the size to the remainder of the division of this size by the specified value.

[ public ]
SFXRectangleRef ModSize(
    SInt16 width    // divide the width by this value
    SInt16 height   // divide the height by this value
);

[ public ]
SFXRectangleRef ModSize(
    SInt16 param   // divide the width and height by this value
);

Description

The operation when the value of param, width, height is 0 has not been defined yet.

Reference

SFXRectangle::ModTop

Set the Y coordinate of top edge to the remainder of the division of this coordinate by the specified value..

[ public ]
SFXRectangleRef ModTop(
    SInt16 param   // divide Y coordinate by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::ModWidth

Set the width to the remainder of the division of this width by the specified value.

[ public ]
SFXRectangleRef ModWidth(
    SInt16 param   // divide the width by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::ModX

Set the X coordinate of left-top vertex to the remainder of the division of this coordinate by the specified value.

[ public ]
SFXRectangleRef ModX(
    SInt16 param   // divide X coordinate by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::ModY

Set the Y coordinate of left-top vertex to the remainder of the division of this coordinate by the specified value.

[ public ]
SFXRectangleRef ModY(
    SInt16 param   // divide Y coordinate by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXRectangle::MulBottom

Multiply the Y coordinate of this bottom edge by the specified value.

[ public ]
SFXRectangleRef MulBottom(
    SInt16 param   // multiply the Y coordinate by this value
);

Reference

SFXRectangle::MulHeight

Multiply the height by the specified value.

[ public ]
SFXRectangleRef MulHeight(
    SInt16 param   // multiply the height by this value
);

Reference

SFXRectangle::MulLeft

Multiply the X coordinate of the left edge by the specified value.

[ public ]
SFXRectangleRef MulLeft(
    SInt16 param   // multiply the X coordinate by this value
);

Reference

SFXRectangle::MulLeftBottom

Multiply the coordinates of left-bottom vertex by the specified value.

[ public ]
SFXRectangleRef MulLeftBottom(
    SInt16 x   // multiply X coordinate of left-bottom vertex by this value
    SInt16 y   // multiply Y coordinate of left-bottom vertex by this value
);

[ public ]
SFXRectangleRef MulLeftBottom(
    SInt16 param   // multiply the coordinates of left-bottom vertex by this value
);

Reference

SFXRectangle::MulLeftTop

Multiply the coordinates of left-top vertex by the specified value.

[ public ]
SFXRectangleRef MulLeftTop(
    SInt16 x   // multiply X coordinate of left-top vertex by this value
    SInt16 y   // multiply Y coordinate of left-top vertex by this value
);

[ public ]
SFXRectangleRef MulLeftTop(
    SInt16 param   // multiply the coordinates of left-top vertex by this value
);

Example

SFXRectangle rect(10, 20, 30, 40);

rect.MulLeftTop(2, 2);   // multiply the coordinates of left-top vertex by (2, 2)
                           // the width and height will be changed after multiplication, too
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 20, y = 40, width = 20, height = 20

Reference

SFXRectangle::MulOrigin

Multiply the origin coordinates (left-top vertex) by the specified value.

[ public ]
SFXRectangleRef MulOrigin(
    SInt16 x   // multiply X coordinate by this value
    SInt16 y   // multiply Y coordinate by this value
);

[ public ]
SFXRectangleRef MulOrigin(
    SInt16 param   // multiply the coordinates by this value
);

Example

SFXRectangle rect(10, 20, 30, 40);

rect.MulOrigin(2, 2);   // multiply the coordinates of the origin point by (2, 2)
                        // as the origin has been moved, the entire rectangle is moved, too (the width and height are not changed)
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 20, y = 40, width = 30, height = 40

Reference

SFXRectangle::MulRight

Multiply the X coordinate of the right edge by the specified value.

[ public ]
SFXRectangleRef MulRight(
    SInt16 param   // multiply X coordinate by this value
);

Reference

SFXRectangle::MulRightBottom

Multiply the coordinates of right-bottom vertex by the specified value.

[ public ]
SFXRectangleRef MulRightBottom(
    SInt16 x   // multiply the X coordinate of right-bottom vertex by this value
    SInt16 y   // multiply the Y coordinate of right-bottom vertex by this value
);

[ public ]
SFXRectangleRef MulRightBottom(
    SInt16 param   // multiply the coordinates of right-bottom vertex by this value
);

Reference

SFXRectangle::MulRightTop

Multiply the coordinates of right-top vertex by the specified value.

[ public ]
SFXRectangleRef MulRightTop(
    SInt16 x   // multiply X coordinate of right-top vertex by this value
    SInt16 y   // multiply Y coordinate of right-top vertex by this value
);

[ public ]
SFXRectangleRef MulRightTop(
    SInt16 param   // multiply the coordinates of right-top vertex by this value
);

Reference

SFXRectangle::MulSize

Multiply the size by the specified value.

[ public ]
SFXRectangleRef MulSize(
    SInt16 width    // multiply the width by this value
    SInt16 height   // multiply the height by this value
);

[ public ]
SFXRectangleRef MulSize(
    SInt16 param   // multiply the coordinates by this value
);

Reference

SFXRectangle::MulTop

Multiply the Y coordinate of the top edge by the specified value.

[ public ]
SFXRectangleRef MulTop(
    SInt16 param   // multiply Y coordinate by this value
);

Reference

SFXRectangle::MulWidth

Multiply the width by the specified value.

[ public ]
SFXRectangleRef MulWidth(
    SInt16 param   // multiply the width by this value
);

Reference

SFXRectangle::MulX

Multiply the X coordinate of left-top vertex by the specified value.

[ public ]
SFXRectangleRef MulX(
    SInt16 param   // multiply X coordinate by this value
);

Reference

SFXRectangle::MulY

Multiply the Y coordinate of left-top vertex by the specified value.

[ public ]
SFXRectangleRef MulY(
    SInt16 param   // multiply Y coordinate by this value
);

Reference

SFXRectangle::NegBottom

Negate the sign of the Y coordinate of bottom edge.

[ public ]
SFXRectangleRef NegBottom(Void);

Reference

SFXRectangle::NegHeight

Negate the sign of the height.

[ public ]
SFXRectangleRef NegHeight(Void);

Reference

SFXRectangle::NegLeft

Negate the sign of the X coordinate of left edge.

[ public ]
SFXRectangleRef NegLeft(Void);

Reference

SFXRectangle::NegLeftBottom

Negate the sign of the coordinates of left-bottom vertex.

[ public ]
SFXRectangleRef NegLeftBottom(Void);

Reference

SFXRectangle::NegLeftTop

Negate the sign of the coordinates of left-top vertex.

[ public ]
SFXRectangleRef NegLeftTop(Void);

Example

SFXRectangle rect(-10, 20, 30, 40);

rect.NegLeftTop();   // negate the coordinates of left-top vertex (-10, 20)
                     // according to the negation, the width and the height will be modified, too.
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 10, y = -20, width = 10, height = 80

Reference

SFXRectangle::NegOrigin

Negate the sign of the coordinates of origin point (left-top vertex).

[ public ]
SFXRectangleRef NegOrigin(Void);

Example

SFXRectangle rect(-10, 20, 30, 40);

rect.NegOrigin();   // negate the coordinate of the origin from (10, 20) to (-10, -20)
                    // as the origin has been moved, the rectangle whole moves (do not modify the width and height of rectangle)
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 10, y = -20, width = 30, height = 40

Reference

SFXRectangle::NegRight

Negate the sign of the X coordinate of right edge.

[ public ]
SFXRectangleRef NegRight(Void);

Reference

SFXRectangle::NegRightBottom

Negate the sign of the coordinate of right-bottom vertex.

[ public ]
SFXRectangleRef NegRightBottom(Void);

Reference

SFXRectangle::NegRightTop

Negate the sign of the coordinate of right-top vertex.

[ public ]
SFXRectangleRef NegRightTop(Void);

Reference

SFXRectangle::NegSize

Negate the sign of the size.

[ public ]
SFXRectangleRef (Void);

Reference

SFXRectangle::NegTop

Negate the sign of the Y coordinate of top edge.

[ public ]
SFXRectangleRef NegTop(Void);

Reference

SFXRectangle::NegWidth

Negate the sign of the width.

[ public ]
SFXRectangleRef NegWidth(Void);

Reference

SFXRectangle::NegX

Negate the sign of the X coordinate of left-top vertex.

[ public ]
SFXRectangleRef NegX(Void);

Reference

SFXRectangle::NegY

Negate the sign of the Y coordinate of left-top vertex.

[ public ]
SFXRectangleRef NegY(Void);

Reference

SFXRectangle::Normalize

Normalize the rectangle.

[ public ]
SFXRectangleRef Normalize(Void);

Description

If width and height are positive, do nothing.

If width or the height is negative, negate its sign. The type is not changed.

Example

SFXRectangle rect(10, 20, -30, 40);

if(rect.IsEmpty()){     // check whether the rect is empty
                        // this function returns true since width value is less than 0

    rect.Normalize();   // normalize the rect
}

TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight());  // x = 10, y = 20, width = 30, height = 40

Reference

SFXRectangle::IsEmpty

SFXRectangle::Offset

Add the specified value to the coordinates of the origin point (left-top vertex) and move this rectangle.

[ public ]
SFXRectangleRef Offset(
    SFXGridConstRef param   // value to add to  the coordinates of the origin point(left-top vertex)
);

[ public ]
SFXRectangleRef Offset(
    SInt16 x   // value to add to the X coordinate of the origin point(left-top vertex)
    SInt16 y   // value to add to the Y coordinate of the origin point(left-top vertex)
);

Example

SFXRectangle rect(10, 20, 30, 40);

 // add to the coordinates of the origin point (left-top vertex) and move this rectangle 
rect.Offset(100, 50);
TRACE("x = %d, y = %d, width = %d, height = %d", rect1.GetX(), rect1.GetY(), rect1.GetWidth(), rect1.GetHeight());  // x = 110, y = 70, width = 30, height = 40

Reference

SFXRectangle::Unoffset | operator- | operator+

SFXRectangle::Set

Set the rectangle.

[ public ]
SFXRectangleRef Set(
    SFXRectangleConstRef param   // source rectangle
);

[ public ]
SFXRectangleRef Set(
    SFXGridConstRef origin   // coordinates of left-top vertex 
    SFXSizeConstRef size     // width and height 
);

[ public ]
SFXRectangleRef Set(
    SFXGridConstRef origin   // coordinates of left-top vertex  
    SInt16 width             // width
    SInt16 height            // height
);

[ public ]
SFXRectangleRef Set(
    SInt16 x               // X coordinate of left-top vertex  
    SInt16 y               // Y coordinate of left-top vertex  
    SFXSizeConstRef size   // width and height 
);

[ public ]
SFXRectangleRef Set(
    SInt16 x        // X coordinate of left-top vertex  
    SInt16 y        // Y coordinate of left-top vertex  
    SInt16 width    // width
    SInt16 height   // height
);

[ public ]
SFXRectangleRef Set(
    SFXPixelConstRef start   // coordinates of left-top vertex  
    SFXPixelConstRef end     // coordinates of right-bottom vertex  
);

Reference

SFXRectangle::operator=

SFXRectangle::SetBottom

Set the Y coordinate of buttom edge.

[ public ]
SFXRectangleRef SetBottom(
    SInt16 param   // Y coordinate of buttom edge to set
);

Reference

SFXRectangle::SetHeight

Set the height.

[ public ]
SFXRectangleRef SetHeight(
    SInt16 param   // height to set
);

Reference

SFXRectangle::SetLeft

Set the X coordinate of left edge.

[ public ]
SFXRectangleRef SetLeft(
    SInt16 param   // X coordinate of left edge to set
);

Reference

SFXRectangle::SetLeftBottom

Set the grid coordinates of left-bottom vertex.

[ public ]
SFXRectangleRef SetLeftBottom(
    SFXGridConstRef param   // coordinates of left-bottom vertex to set
);

[ public ]
SFXRectangleRef SetLeftBottom(
    SInt16 x   // X coordinate of left-bottom vertex to set
    SInt16 y   // Y coordinate of left-bottom vertex to set
);

Description

The coordinates of right-top vertex are not changed.

Reference

SFXRectangle::SetLeftTop

Set the grid coordinates of left-top vertex.

[ public ]
SFXRectangleRef SetLeftTop(
    SFXGridConstRef param   // coordinates of left-top vertex to set
);

[ public ]
SFXRectangleRef SetLeftTop(
    SInt16 x   // X coordinate of left-top vertex to set
    SInt16 y   // Y coordinate of left-top vertex to set
);

Description

The coordinates of right-bottom vertex are not changed.

Example

SFXRectangle rect(10, 20, 30, 40);

rect.SetLeftTop(20,10);   // set (20,10) to coordinates of left-top vertex
                          // width and height are also changed 
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 20, y = 10, width = 20, height = 50

Reference

SFXRectangle::SetOrigin

Set the grid coordinates of origin point (left-top vertex).

[ public ]
SFXRectangleRef SetOrigin(
    SFXGridConstRef param   coordinates of left-top vertex to set
);

[ public ]
SFXRectangleRef SetOrigin(
    SInt16 x   // X coordinate of left-top vertex to set
    SInt16 y   // Y coordinate of left-top vertex to set
);

Example

SFXRectangle rect(10, 20, 30, 40);

rect.SetOrigin(20,10);    // set the coordinate of the origin to (20, 10)
                         // as the origin has been moved, the rectangle whole moves (do not modify the width and height of rectangle)
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 20, y = 10, width = 30, height = 40

Reference

SFXRectangle::SetRight

Set the X coordinate of right edge.

[ public ]
SFXRectangleRef SetRight(
    SInt16 param   // X coordinate of right edge to set
);

Reference

SFXRectangle::SetRightBottom

Set the grid coordinates of right-bottom vertex.

[ public ]
SFXRectangleRef SetRightBottom(
    SFXGridConstRef param   // coordinates of right-bottom vertex to set
);

[ public ]
SFXRectangleRef SetRightBottom(
    SInt16 x   // X coordinate of right-bottom vertex to set
    SInt16 y   // Y coordinate of right-bottom vertex to set
);

Description

The coordinates of left-top vertex are not changed.

Reference

SFXRectangle::SetRightTop

Set the grid coordinates of right-top vertex.

[ public ]
SFXRectangleRef SetRightTop(
    SFXGridConstRef param   // coordinates of right-top vertex to set
);

[ public ]
SFXRectangleRef SetRightTop(
    SInt16 x   // X coordinate of right-top vertex to set
    SInt16 y   // Y coordinate of right-top vertex to set
);

Description

The coordinates of left-bottom vertex are not changed.

Reference

SFXRectangle::SetSize

Set the size.

[ public ]
SFXRectangleRef SetSize(
    SFXSizeConstRef param   // size to set
);

[ public ]
SFXRectangleRef SetSize(
    SInt16 width    // width to set
    SInt16 height   // height to set
);

SFXRectangle::SetTop

Set the Y coordinate of top edge.

[ public ]
SFXRectangleRef SetTop(
    SInt16 param   // Y coordinate of top edge to set
);

Reference

SFXRectangle::SetVertexLeftBottom

Set the pixel coordinates of left-bottom vertex.

[ public ]
SFXRectangleRef SetVertexLeftBottom(
    SFXPixelConstRef param   // coordinates of right-bottom vertex to set
);

[ public ]
SFXRectangleRef SetVertexLeftBottom(
    SInt16 x   // X coordinate of right-bottom vertex to set 
    SInt16 y   // Y coordinate of right-bottom vertex to set 
);

Description

The coordinates of right-top vertex are not changed.

Reference

SFXRectangle::SetVertexLeftTop

Set the pixel coordinates of left-top vertex.

[ public ]
SFXRectangleRef SetVertexLeftTop(
    SFXPixelConstRef param   // coordinates of left-top vertex to set
);

[ public ]
SFXRectangleRef SetVertexLeftTop(
    SInt16 x   // X coordinate of left-top vertex to set
    SInt16 y   // Y coordinate of left-top vertex to set
);

Description

The coordinates of right-bottom vertex are not changed.

Reference

SFXRectangle::SetVertexRightBottom

Set the pixel coordinates of right-bottom vertex.

[ public ]
SFXRectangleRef SetVertexRightBottom(
    SFXPixelConstRef param   // coordinates of right-bottom vertex to set
);

[ public ]
SFXRectangleRef SetVertexRightBottom(
    SInt16 x   // X coordinate of right-bottom vertex to set
    SInt16 y   // Y coordinate of right-bottom vertex to set
);

Description

The coordinates of left-top vertex are not changed.

Reference

SFXRectangle::SetVertexRightTop

Set the pixel coordinates of right-top vertex.

[ public ]
SFXRectangleRef SetVertexRightTop(
    SFXPixelConstRef param   // coordinates of right-top vertex to set
);

[ public ]
SFXRectangleRef SetVertexRightTop(
    SInt16 x   // X coordinate of right-top vertex to set
    SInt16 y   // Y coordinate of right-top vertex to set
);

Description

The coordinates of left-bottom vertex are not changed.

Reference

SFXRectangle::SetWidth

Set the width.

[ public ]
SFXRectangleRef SetWidth(
    SInt16 param   // width to set
);

Reference

SFXRectangle::SetX

Set the X coordinate of left-top vertex.

[ public ]
SFXRectangleRef SetX(
    SInt16 param   // X coordinate of left-top vertex to set
);

Reference

SFXRectangle::SetY

Set the Y coordinate of left-top vertex.

[ public ]
SFXRectangleRef SetY(
    SInt16 param   // Y coordinate of left-top vertex to set
);

Reference

SFXRectangle::SnapBottom

Set the Y coordinate of bottom edge and move this rectangle.

[ public ]
SFXRectangleRef SnapBottom(
    SInt16 param   // value 
);

Example

SFXRectangle rect(10, 20, 30, 40);

 // set the Y coordinate of the bottom edge to 100 . 
rect.SnapBottom(100);
TRACE("x = %d, y = %d, width = %d, height = %d", rect1.GetX(), rect1.GetY(), rect1.GetWidth(), rect1.GetHeight());  // x = 10, y = 60, width = 30, height = 40

Reference

SFXRectangle::SnapCenter

Set the X coordinate of the center of rectangle to the specified value and move the rectangle.

[ public ]
SFXRectangleRef SnapCenter(
    SInt16 param   // X coordinate of center of rectangle
);

Reference

SFXRectangle::GetCenter

SFXRectangle::SnapCenterBottom

Set the center of the bottom edge of rectangle to the specified value and move the rectangle.

[ public ]
SFXRectangleRef SnapCenterBottom(
    SFXGridConstRef param   // center of bottom edge
);

[ public ]
SFXRectangleRef SnapCenterBottom(
    SInt16 x   // X coordinate of center of bottom edge
    SInt16 y   // Y coordinate of center of bottom edge
);

Reference

SFXRectangle::GetCenterBottom

SFXRectangle::SnapCenterMiddle

Set the center of rectangle to the specified value and move the rectangle.

[ public ]
SFXRectangleRef SnapCenterMiddle(
    SFXGridConstRef param   // center of rectangle
);

[ public ]
SFXRectangleRef SnapCenterMiddle(
    SInt16 x   // X coordinate of center of rectangle
    SInt16 y   // Y coordinate of center of rectangle
);

Reference

SFXRectangle::GetCenterMiddle

SFXRectangle::SnapCenterTop

Set the center of the top edge of rectangle to the specified value and move the rectangle.

[ public ]
SFXRectangleRef SnapCenterTop(
    SFXGridConstRef param   // center of top edge
);

[ public ]
SFXRectangleRef SnapCenterTop(
    SInt16 x   // X coordinate of center of top edge
    SInt16 y   // Y coordinate coordinate of center of top edge
);

Reference

SFXRectangle::GetCenterTop

SFXRectangle::SnapLeft

Set the X coordinate of left edge and move this rectangle.

[ public ]
SFXRectangleRef SnapLeft(
    SInt16 param   // value to set
);

Reference

SFXRectangle::SnapLeftBottom

Set the coordinates of left-bottom vertex and move this rectangle.

[ public ]
SFXRectangleRef SnapLeftBottom(
    SFXGridConstRef param   // value to set
);

[ public ]
SFXRectangleRef SnapLeftBottom(
    SInt16 x   // X coordinate value 
    SInt16 y   // Y coordinate value 
);

Reference

SFXRectangle::SnapLeftMiddle

Set the center of the left edge of rectangle to the specified value and move the rectangle.

[ public ]
SFXRectangleRef SnapLeftMiddle(
    SFXGridConstRef param   // center of left edge
);

[ public ]
SFXRectangleRef SnapLeftMiddle(
    SInt16 x   // X coordinate of center of left edge
    SInt16 y   // Y coordinate of center of left edge
);

Reference

SFXRectangle::GetLeftMiddle

SFXRectangle::SnapLeftTop

Set the coordinates of left-top vertex and move this rectangle.

[ public ]
SFXRectangleRef SnapLeftTop(
    SFXGridConstRef param   // coordinates of left-top vertex  
);

[ public ]
SFXRectangleRef SnapLeftTop(
    SInt16 x   // X coordinate of left-top vertex  
    SInt16 y   // Y coordinate of left-top vertex  
);

Reference

SFXRectangle::SnapMiddle

Set the Y coordinate of the center of rectangle to the specified value and move the rectangle.

[ public ]
SFXRectangleRef SnapMiddle(
    SInt16 param   // Y coordinate of center of rectangle
);

Reference

SFXRectangle::GetMiddle |

SFXRectangle::SnapRight

Set the X coordinate of right edge and move this rectangle.

[ public ]
SFXRectangleRef SnapRight(
    SInt16 param   // value to set 
);

Reference

SFXRectangle::SnapRightBottom

Set the coordinates of right-bottom vertex and move this rectangle.

[ public ]
SFXRectangleRef SnapRightBottom(
    SFXGridConstRef param   // coordinates of right-bottom vertex  
);

[ public ]
SFXRectangleRef SnapRightBottom(
    SInt16 x   // X coordinate value 
    SInt16 y   // Y coordinate value 
);

Reference

SFXRectangle::SnapRightMiddle

Set the center of the right edge of rectangle to the specified value and move the rectangle.

[ public ]
SFXRectangleRef SnapRightMiddle(
    SFXGridConstRef param   // center of right edge
);

[ public ]
SFXRectangleRef SnapRightMiddle(
    SInt16 x   // X coordinate of center of right edge
    SInt16 y   // Y coordinate of center of right edge
);

Reference

SFXRectangle::GetRightMiddle

SFXRectangle::SnapRightTop

Set the coordinate of right-top vertex, ,move the rectangle.

[ public ]
SFXRectangleRef SnapRightTop(
    SFXGridConstRef param   // value 
);

[ public ]
SFXRectangleRef SnapRightTop(
    SInt16 x   // X coordinate value 
    SInt16 y   // Y coordinate value 
);

Reference

SFXRectangle::SnapTop

Set the Y coordinate top edge and move this rectangle.

[ public ]
SFXRectangleRef SnapTop(
    SInt16 param   // value 
);

Reference

SFXRectangle::SubBottom

Subtract the specified value from the Y coordinate of bottom edge.

[ public ]
SFXRectangleRef SubBottom(
    SInt16 param   // value to subtract
);

Reference

SFXRectangle::SubHeight

Subtract the specified value from the Height.

[ public ]
SFXRectangleRef SubHeight(
    SInt16 param   // value to subtract
);

Reference

SFXRectangle::SubLeft

Subtract the specified value from the X coordinate of left edge.

[ public ]
SFXRectangleRef SubLeft(
    SInt16 param   // value to subtract
);

Reference

SFXRectangle::SubLeftBottom

Subtract the specified value from the coordinates of left-bottom vertex.

[ public ]
SFXRectangleRef SubLeftBottom(
    SFXGridConstRef param   // value to subtract
);

[ public ]
SFXRectangleRef SubLeftBottom(
    SInt16 x   // value to subtract from the X coordinate
    SInt16 y   // value to subtract from the Y coordinate
);

Reference

SFXRectangle::SubLeftTop

Subtract the specified value from the coordinates of left-top vertex.

[ public ]
SFXRectangleRef SubLeftTop(
    SFXGridConstRef param   // value to subtract
);

[ public ]
SFXRectangleRef SubLeftTop(
    SInt16 x   // value to subtract from the X coordinate
    SInt16 y   // value to subtract from the Y coordinate
);

Example

SFXRectangle rect(10, 20, 30, 40);

rect.SubLeftTop(10, 10);   // subtract the coordinate of left-top vertex from (10, 20) with (10, 10)
                           // following the Subtract the specified value fromed value, the width and height will be modified ,too
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 0, y = 10, width = 40, height = 50

Reference

SFXRectangle::SubOrigin

Subtract the specified value from the coordinates of origin point (left-top vertex).

[ public ]
SFXRectangleRef SubOrigin(
    SFXGridConstRef param   // value to subtract
);

[ public ]
SFXRectangleRef SubOrigin(
    SInt16 x   // value to subtract from the X coordinate
    SInt16 y   // value to subtract from the Y coordinate
);

Example

SFXRectangle rect(10, 20, 30, 40);

rect.SubOrigin(10, 10);    // divide the coordinate of the origin from (10, 20) with (10, 10)
                          // as the origin has been moved, the rectangle whole moves (do not modify the width and height of rectangle)
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight()); // x = 0, y = 10, width = 30, height = 40

Reference

SFXRectangle::SubRight

Subtract the specified value from the X coordinate of right edge.

[ public ]
SFXRectangleRef SubRight(
    SInt16 param   // value to subtract
);

Reference

SFXRectangle::SubRightBottom

Subtract the specified value from the coordinates of right-bottom vertex.

[ public ]
SFXRectangleRef SubRightBottom(
    SFXGridConstRef param   // value to subtract
);

[ public ]
SFXRectangleRef SubRightBottom(
    SInt16 x   // value to subtract from the X coordinate
    SInt16 y   // value to subtract from the Y coordinate
);

Reference

SFXRectangle::SubRightTop

Subtract the specified value from the coordinate of right-top vertex.

[ public ]
SFXRectangleRef SubRightTop(
    SFXGridConstRef param   // value to subtract
);

[ public ]
SFXRectangleRef SubRightTop(
    SInt16 x   // value to subtract from the X coordinate
    SInt16 y   // value to subtract from the Y coordinate
);

Reference

SFXRectangle::SubSize

Subtract the specified value from the size.

[ public ]
SFXRectangleRef SubSize(
    SFXSizeConstRef param   // value to subtract
);

[ public ]
SFXRectangleRef SubSize(
    SInt16 width    // value to subtract from the width
    SInt16 height   // value to subtract from the height
);

Reference

SFXRectangle::SubTop

Subtract the specified value from the Y coordinate of top edge.

[ public ]
SFXRectangleRef SubTop(
    SInt16 param   // value to subtract
);

Reference

SFXRectangle::SubWidth

Subtract the specified value from the width.

[ public ]
SFXRectangleRef SubWidth(
    SInt16 param   // value to subtract
);

Reference

SFXRectangle::SubX

Subtract the specified value from the X coordinate of left-top vertex.

[ public ]
SFXRectangleRef SubX(
    SInt16 param   // value to subtract
);

Reference

SFXRectangle::SubY

Subtract the specified value from the Y coordinate of left-top vertex.

[ public ]
SFXRectangleRef SubY(
    SInt16 param   // value to subtract
);

Reference

SFXRectangle::UnifiesWith

Check whether this rectangle unifies with another rectangle.

[ public, const ]
Bool UnifiesWith(
    SFXRectangleConstRef param   // rectangle
);

Return value

Unifies with: true
Does not unify with: false

Reference

SFXRectangle::Union | SFXRectangle::operator| | SFXRectangle::operator|=

SFXRectangle::Union

Union two rectangles.

[ public ]
SFXRectangleRef Union(
    SFXRectangleConstRef param   // rectangle
);

Description

Get the rectangle formed by the most left-top and the most right-bottom coordinates of the two rectangles.

Example

SFXRectangle rect1(10, 20, 30, 40);
SFXRectangle rect2(50, 60, 70, 80);

rect1 = rect1.Union(rect2);   // get rectangle that is union of rect1 and rect2.
TRACE("x = %d, y = %d, width = %d, height = %d", rect1.GetX(), rect1.GetY(), rect1.GetWidth(), rect1.GetHeight());  // x = 10, y = 20, width = 1100, height = 120

Reference

SFXRectangle::UnifiesWith | SFXRectangle::operator| | SFXRectangle::operator|=

SFXRectangle::Unoffset

Subtract from the coordinates of origin point (left-top vertex) and move this rectangle.

[ public ]
SFXRectangleRef Unoffset(
    SFXGridConstRef param   // value to subtract
);

[ public ]
SFXRectangleRef Unoffset(
    SInt16 x   // value to subtract from the X coordinate
    SInt16 y   // value to subtract from the Y coordinate
);

Example

SFXRectangle rect(10, 20, 30, 40);

 // subtract the coordinates of origin point (left-top vertex) and move this rectangle 
rect.Unoffset(10,20);
TRACE("x = %d, y = %d, width = %d, height = %d", rect1.GetX(), rect1.GetY(), rect1.GetWidth(), rect1.GetHeight());  // x = 0, y = 0, width = 30, height = 40

Reference

SFXRectangle::Offset | operator- | operator+

SFXRectangle::ZeroInstance

Get the instance that represents 0.

[ public, static ]
SFXRectangleConstRef ZeroInstance(Void);

Description

This function returns the 0 instance, which means that 0 or null is set to all the member variables of its corresponding AtomRec struct.

Example

SFXRectangle rect(10, 20, 30, 40);

rect = SFXRectangle::ZeroInstance();   // intialize rect
TRACE("x = %d, y = %d, width = %d, height = %d", rect.GetX(), rect.GetY(), rect.GetWidth(), rect.GetHeight());  // x = 0, y = 0, width = 0, height = 0

Reference

SFXRectangle::AtomRec

atomic_cast

Convert SFXRectangle into SFXRectangle::AtomRec.

[ public, friend ]
SFXRectangle::AtomRec * atomic_cast(
    SFXRectangle * param   // rectangle to cast
);

[ public, friend ]
SFXRectangle::AtomRec const * atomic_cast(
    SFXRectangle const * param   // rectangle to cast
);

Reference

SFXRectangle::AtomRec

interface_cast

Convert SFXRectangle into AEERect.

[ public, friend ]
AEERect * interface_cast(
    SFXRectangle * param   // rectangle ro cast
);

[ public, friend ]
AEERect const * interface_cast(
    SFXRectangle const * param   // rectangle ro cast
);

SFXRectangle::operator &=

Get the intersection of the left rectangle with the right rectangle and set it to the left rectangle.

[ public ]
SFXRectangleRef operator &=(
    SFXRectangleConstRef param   // rectangle
);

Description

If there is no intersection, return a rectangle with invalid size.

Reference

SFXRectangle::Intersection | SFXRectangle::IntersectsWith | SFXRectangle::operator &

SFXRectangle::operator &

Get the intersection of the left rectangle with the right rectangle.

[ public, friend ]
SFXRectangle operator &(
    SFXRectangleConstRef left    // rectangle
    SFXRectangleConstRef right   // rectangle
);

Description

If there is no intersection, return the rectangle with an invalid size.

Reference

SFXRectangle::Intersection | SFXRectangle::IntersectsWith | SFXRectangle::operator &=

SFXRectangle::operator=

Assign a rectangle.

[ public ]
SFXRectangleRef operator=(
    SFXRectangleConstRef param   // source rectangle
);

Reference

SFXRectangle::Set

operator==

Check the "==" relation.

[ public, friend ]
Bool operator==(
    SFXRectangleConstRef left    // rectangle to compare
    SFXRectangleConstRef right   // rectangle to compare
);

Return value

If yes: true
Otherwise: false

Reference

SFXRectangle::Equals | operator!=

SFXRectangle::operator-=

Subtract the specified value from the coordinates of left-top vertex and move this rectangle.

[ public ]
SFXRectangleRef operator-=(
    SFXGridConstRef param   // value to subtract
);

Reference

SFXRectangle::Unoffset | operator- | SFXRectangle::operator+=

operator-

Subtract the specified value from the coordinates of left-bottom vertex and move this rectangle.

[ public, friend ]
SFXRectangle operator-(
    SFXRectangleConstRef left   // rectangle to move
    SFXGridConstRef right       // value to subtract
);

Reference

SFXRectangle::Unoffset | SFXRectangle::operator-= | operator+

operator!=

Check the "!=" relation.

[ public, friend ]
Bool operator!=(
    SFXRectangleConstRef left    // rectangle to compare
    SFXRectangleConstRef right   // rectangle to compare
);

Return value

If yes: true
Otherwise: false

Reference

SFXRectangle::Equals | operator==

SFXRectangle::operator|=

Get and set to the rectangle that covers the two specified rectangles.

[ public ]
SFXRectangleRef operator|=(
    SFXRectangleConstRef param   // rectangle
);

Description

Get the coordinates of the most left-top and most right-bottom of the two rectangles, set the rectangle.

Reference

SFXRectangle::Union | SFXRectangle::UnifiesWith | SFXRectangle::operator|

SFXRectangle::operator|

Get the rectangle that covers the two specified rectangles.

[ public, friend ]
SFXRectangle operator|(
    SFXRectangleConstRef left    // rectangle 
    SFXRectangleConstRef right   // rectangle
);

Description

Get the rectangle formed by most left-top and most right-bottom coordinates of the two rectangles.

Reference

SFXRectangle::Union | SFXRectangle::UnifiesWith | SFXRectangle::operator|=

SFXRectangle::operator+=

Add the specified value to the coordinates of left-top vertex and move this rectangle.

[ public ]
SFXRectangleRef operator+=(
    SFXGridConstRef param   // value to add
);

Reference

SFXRectangle::Offset | SFXRectangle::operator-= | operator+

operator+

Add the specified value to the coordinates of left-top vertex and move this rectangle.

[ public, friend ]
SFXRectangle operator+(
    SFXRectangleConstRef left   // rectangle to move
    SFXGridConstRef right       // value to add
);

Reference

SFXRectangle::Offset | operator- | SFXRectangle::operator+=

SFXRectangle::AtomRec

Structure that represents a rectangle.

struct AtomRec {
  SFXGrid::AtomRec  origin ;  // coordinates of left-top vertex
  SFXSize::AtomRec  size;    // width and height 
};