ofRectanglefile

ofRectangleclass

A class representing a 2D rectangle.

ofRectangle is a simple container for describing the position and size of a 2D rectangle. Since the width and height variables can be negative, the x/y-position is not guaranteed to represent the upper right hand corner. For example, two visually identical rectangles can be represented in the following ways:

ofRectangle myRect(0, 0, 100, 100);

ofRectangle myRect(100, 100, -100, -100);

While both representations will yield the same visual results in all openFrameworks renderers, the results of some method operations that modify x, y, width and height (such as scaling) produce mathematically correct, but visually different results for each of the above representations.

To avoid this ambiguity, users should should prefer "standardized" rectangles. "Standardized" rectangles are rectangles whose width >= 0 and height >= 0. The ofRectangle::standardize() method can be used to ensure that the is in it the "standard" form.

Warning: While ofRectangle takes ofPoint (a typedef for ofVec3f, a 3D vector), all ofRectangle operations are 2D only, ignoring the z-component.

Constructor

ofRectangle ()

~ofRectangle ()

Setters

set ()

setX ()

setY ()

setWidth ()

setHeight ()

setPosition ()

setFromCenter ()

Transformation

translate ()

translateX ()

translateY ()

scale ()

scaleWidth ()

scaleHeight ()

scaleFromCenter ()

scaleTo ()

void scaleTo(const ofRectangle &targetRect, ofScaleMode scaleMode=OF_SCALEMODE_FIT)

Scale the rectanle using a target ofRectangle and ofScaleMode.

Adjusts the ofRectangle to match the provided ofRectangle using the provided ofScaleMode.

Assuming the ofRectangle as the Subject and the passed-in ofRectangle as the Target:

OF_SCALEMODE_FIT:

This centers the Subject rectangle within the Target rectangle and resizes the Subject rectangle to completely fit within the Target Rectangle.

It fits the Subject rectangle inside the target rectangle.
It preserves Subject's aspect ratio.
The Subject's final area <= the Target's area.
The Subject's center == the Target's center.

OF_SCALEMODE_FILL:

This centers the Subject rectangle within the Target rectangle and resizes the Subject rectangle to completely encompass the Target Rectangle.

It fills the Target rectangle with the Subject rectangle.
It preserves the Subject's aspect ratio.
The Subject's Area >= the Target's area.
The Subject's center == the Target's center.

OF_SCALEMODE_CENTER:

This centers the Subject rectangle within the Target rectangle and does not modify the Subject's scale.

It preserves the Subject's aspect ratio.
The Subject's area is unchanged.
The Subject's center == Target's center.

OF_SCALEMODE_STRETCH_TO_FILL:

This simply modifies the Subject rectangle to match the Target Rectangle's dimensions.

It can change the Subject's aspect ratio.
The Subject's area == the Target's area.
The Subject's center == the Target's center.

For an example of the various ofScaleModes, see the graphics/rectangleAlignmentAndScaling/ example within the examples directory.

Parameters

targetRect	The Target Rectangle to scale to.
scaleMode	The scale mode to use when scaling.

void scaleTo(const ofRectangle &targetRect, ofAspectRatioMode subjectAspectRatioMode, ofAlignHorz sharedHorzAnchor=OF_ALIGN_HORZ_CENTER, ofAlignVert sharedVertAnchor=OF_ALIGN_VERT_CENTER)

Scale the rectangle using a target ofRectangle and parameters.

Scales the ofRectangle to match the target ofRectangle. It will use the ofAspectRatioMode to scale the ofRectangle and will use the use the alignment anchor parameters to position the rectangle.

This is a convenience method when both the target and subject rectangles are using the same alignment anchors. For a more complete explanation, see void scaleTo(const ofRectangle& targetRect, ofAspectRatioMode subjectAspectRatioMode, ofAlignHorz modelHorzAnchor, ofAlignVert modelVertAnchor, ofAlignHorz subjectHorzAnchor, ofAlignVert subjectVertAnchor);

For a working example of how to use ofAspectRatioMode, ofAlignVert, and ofAlignHorz, see the graphics/rectangleAlignmentAndScaling/ example within the examples directory.

Parameters

targetRect	The Target Rectangle to scale to.
subjectAspectRatioMode	Aspect ratio scaling mode.
sharedHorzAnchor	The horizontal alignment method.
sharedVertAnchor	The vertical alignment method.

void scaleTo(const ofRectangle &targetRect, ofAspectRatioMode subjectAspectRatioMode, ofAlignHorz modelHorzAnchor, ofAlignVert modelVertAnchor, ofAlignHorz subjectHorzAnchor, ofAlignVert subjectVertAnchor)

Scale the rectangle using a target ofRectangle and parameters.

Adjusts the ofRectangle to match the passed-in ofRectangle. It will use the ofAspectRatioMode to scale the ofRectangle, and will use the use the alignment anchor parameters to position the rectangle.

Assuming the ofRectangle as the Subject and the passed-in ofRectangle as the Target:

ofAspectRatioMode Options:

OF_ASPECT_RATIO_IGNORE : Sets the Subject rectangle's width and height to match those of the Target.
OF_ASPECT_RATIO_KEEP : Resizes the Subject rectangle to completely fit within the Target rectangle.
OF_ASPECT_RATIO_KEEP_BY_EXPANDING : Resizes the Subject rectangle to completely enclose the Target rectangle.

ofAlignHorz Options:

OF_ALIGN_HORZ_IGNORE : Does not perform any horizontal alignment.
OF_ALIGN_HORZ_LEFT : Uses the left edge of the rectangle to horizontally anchor the alignment.
OF_ALIGN_HORZ_RIGHT : Uses the right edge of the rectangle to horizontally anchor the alignment.
OF_ALIGN_HORZ_CENTER : Uses the center of the rectangle to horizontally anchor the alignment.

ofAlignVert Options:

OF_ALIGN_VERT_IGNORE : Does not perform any vertical alignment.
OF_ALIGN_VERT_TOP : Uses the upper edge of the rectangle to vertically anchor the alignment.
OF_ALIGN_VERT_BOTTOM : Uses the bottom edge of the rectangle to vertically anchor the alignment.
OF_ALIGN_VERT_CENTER : Uses the center of the rectangle to vertically anchor the alignment.

For an example of how to use ofAspectRatioMode, ofAlignVert, and ofAlignHorz, see the graphics/rectangleAlignmentAndScaling/ example within the examples directory.

Parameters

targetRect	The Target Rectangle to scale to.
subjectAspectRatioMode	Aspect ratio scaling mode.
modelHorzAnchor	The target horizontal alignment method.
modelVertAnchor	The target vertical alignment method.
subjectHorzAnchor	The subject horizontal alignment method.
subjectVertAnchor	The subject vertical alignment method.

Alignment

alignToHorz ()

void alignToHorz(const float &targetX, ofAlignHorz thisHorzAnchor=OF_ALIGN_HORZ_CENTER)

Horizontally align a rectangle using a position and anchor edge.

Aligns the horizontal position of the ofRectangle to the given x- position using an ofAlignHorz constant. If a constant is not passed in this will align the center of the rectangle.

ofAlignHorz Constants:

OF_ALIGN_HORZ_IGNORE : Does not perform any horizontal alignment.
OF_ALIGN_HORZ_LEFT : Uses the left edge of the rectangle to horizontally anchor the alignment.
OF_ALIGN_HORZ_RIGHT : Uses the right edge of the rectangle to horizontally anchor the alignment.
OF_ALIGN_HORZ_CENTER : Uses the center of the rectangle to horizontally anchor the alignment.

For an example of how to use ofAlignHorz, see the graphics/rectangleAlignmentAndScaling/ example within the examples directory.

Parameters

targetX	The x-position to align this rectangle to.
thisHorzAnchor	The edge of this rectangle to align.

void alignToHorz(const ofRectangle &targetRect, ofAlignHorz sharedAnchor=OF_ALIGN_HORZ_CENTER)

Horizontally align two rectangles.

Aligns the horizontal position of the ofRectangle to that of the passed-in ofRectangle. Can take an ofAlignHorz constant.

If a constant is not passed in, this will align the horizontal centers of the rectangles.

If a constant is passed in, it will use that constant for both rectangles.

Parameters

targetRect	The target rectangle to align this rectangle to.
thisHorzAnchor	The common edge of the rectangles to align.

void alignToHorz(const ofRectangle &targetRect, ofAlignHorz targetHorzAnchor, ofAlignHorz thisHorzAnchor)

Horizontally align two rectangles.

Aligns the horizontal position of the ofRectangle to that of the passed-in ofRectangle. Takes two ofAlignHorz constants.

Will align the chosen anchor in the ofRectangle with the chosen anchor in the passed-in ofRectangle.

Parameters

targetRect	The target rectangle to align this rectangle to.
targetHorzAnchor	The edge of the other rectangle to align.
thisHorzAnchor	The edge of this rectangle to align.

alignToVert ()

alignTo ()

void alignTo(const ofPoint &targetPoint, ofAlignHorz thisHorzAnchor=OF_ALIGN_HORZ_CENTER, ofAlignVert thisVertAnchor=OF_ALIGN_VERT_CENTER)

Align this ofRectangle to an ofPoint in both x- and y dimentions.

Aligns the position of the ofRectangle to the given point using an ofAlignHorz constant and an ofAlignVert constant. If neither constant is passed in, this will align the center of the rectangle.

ofAlignHorz Constants:

OF_ALIGN_HORZ_IGNORE : Does not perform any horizontal alignment.
OF_ALIGN_HORZ_LEFT : Uses the left edge of the rectangle to horizontally anchor the alignment.
OF_ALIGN_HORZ_RIGHT : Uses the right edge of the rectangle to horizontally anchor the alignment.
OF_ALIGN_HORZ_CENTER : Uses the center of the rectangle to horizontally anchor the alignment.

ofAlignVert Constants:

OF_ALIGN_VERT_IGNORE : Does not perform any vertical alignment.
OF_ALIGN_VERT_TOP : Uses the upper edge of the rectangle to vertically anchor the alignment.
OF_ALIGN_VERT_BOTTOM : Uses the bottom edge of the rectangle to vertically anchor the alignment.
OF_ALIGN_VERT_CENTER : Uses the center of the rectangle to vertically anchor the alignment.

For a working example of how to use ofAlignVert and ofAlignHorz, see the graphics/rectangleAlignmentAndScaling/ example within the examples directory.

Warning: The z-component of the passed ofPoint is ignored.

Parameters

targetPoint	The target ofPoint to align to.
thisHorzAnchor	The horizontal alignment anchor.
thisVertAnchor	The vertical alignment anchor.

void alignTo(const ofRectangle &targetRect, ofAlignHorz sharedHorzAnchor=OF_ALIGN_HORZ_CENTER, ofAlignVert sharedVertAnchor=OF_ALIGN_VERT_CENTER)

Vertically align this ofRectangle to another target ofRectangle.

Aligns the position of the ofRectangle to that of the passed-in ofRectangle. Can take an ofAlignHorz constant and an ofAlignVert constant.

If neither constant is passed in, this will align the centers of the rectangles.

If constants are passed in, it will use those constants for both rectangles.

Parameters

targetRect	The target ofRectangle to align this rectangle to.
sharedHorzAnchor	The alignment anchor for both rectangles.
sharedVertAnchor	The alignment anchor for both rectangles.

void alignTo(const ofRectangle &targetRect, ofAlignHorz targetHorzAnchor, ofAlignVert targetVertAnchor, ofAlignHorz thisHorzAnchor, ofAlignVert thisVertAnchor)

Vertically align this ofRectangle to another target ofRectangle.

Aligns the position of the ofRectangle to that of the passed-in ofRectangle. Takes two ofAlignHorz constants and two ofAlignVert constants.

Will align the chosen anchors in the ofRectangle with the chosen anchors in the passed-in ofRectangle.

Parameters

targetRect	The target ofRectangle to align this rectangle to.
targetHorzAnchor	The vertical alignment anchor for the target rectangle.
targetVertAnchor	The horizontal alignment anchor for the target rectangle.
thisHorzAnchor	The horizontal alignment anchor for this rectangle.
thisVertAnchor	The vertical alignment anchor for this rectangle.

Intersection

inside ()

intersects ()

growToInclude ()

getIntersection ()

getUnion ()

Standardization

standardize ()

getStandardized ()

isStandardized ()

Getters

getArea ()

getPerimeter ()

getAspectRatio ()

isEmpty ()

getMin ()

getMax ()

getMinX ()

getMaxX ()

getMinY ()

getMaxY ()

getLeft ()

getRight ()

getTop ()

getBottom ()

getTopLeft ()

getTopRight ()

getBottomLeft ()

getBottomRight ()

getHorzAnchor ()

getVertAnchor ()

getPosition ()

getPositionRef ()

getCenter ()

getX ()

getY ()

getWidth ()

getHeight ()

Operators

operator= ()

operator+ ()

operator== ()

operator!= ()

isZero ()

Properties

position variable

x variable

y variable

width variable

height variable

px	The x-position of the rectangle.
py	The y-position of the rectangle.
w	The width of the rectangle.
h	The height of the rectangle.

p0	An ofPoint representing the upper left hand corner.
p1	An ofPoint representing the lower right hand corner.

px	The new x-position.
py	The new y-position.
w	The new width.
h	The new height.

p0	The ofPoint representing the upper left hand corner.
p1	The ofPoint representing the lower right hand corner.

px	The new x-position.
py	The new y-position.

p	The ofPoint representing the position of the rectangle.
w	The width of the rectangle.
h	The height of the rectangle.

px	The x-position of the rectangle's center.
py	The y-position of the rectangle's center.
w	The width of the rectangle.
h	The height of the rectangle.

p	The position of the rectangle's center as an ofPoint.
w	The width of the rectangle.
h	The height of the rectangle.

dx	The amount to translate in the x direction.
dy	The amount to translate in the y direction.

targetY	The target y-position to align this rectangle to.
sharedAnchor	The alignment position of this ofRectangle to use.

px	The x-coordinate to include.
py	The y-coordiante to include.

sX	The width-scaling factor.
sY	The height-scaling factor.

sX	the width-scaling factor.
sY	the height-scaling factor.