CRect:Class Description

CRect Class

The CRect class encapsulates functionality for a rectangle object used for computing statistics, setting window boundaries, setting up the image cursor for measurements, and plots, and for other uses. The rectangle is described in terms of pixel coordinates.

Usage

Construction	Object = CRect:new()
Destruction	Object:delete()

Properties

This class has 4 properties that describe the rectangle. They may be accessed directly; for example, if the class object is R, then the minimum x value is accessed by R.xmin. However, it would be a generally better programming style to access it using the accessor methods Xmin and SetXmin.

xmin	The minimum x value of the rectangle.
xmax	The maximum x value of the rectangle.
ymin	The minimum y value of the rectangle.
ymax	The maximum y value of the rectangle.

Methods

Construction

new	Creates a new instance of the CRect class. Various constructors are available.
delete	Deletes the instance of the CRect object.

Accessing Properties

In addition to using the properties by name, like R.xmin, the methods below allow you to set or get all the properties in one operation.

Get	Returns the 4 properties corresponding to the min and max x and the min and max y of the rectangle.
Set	Sets the 4 properties for the x and y limits of the rectangle.

Operations

Floor	Truncates all rectangle limits to the next lower integer value.
Height	Returns the height of the rectangle.
Inflate	Inflates a rectangle by pulling outward on all 4 sides.
Intersection	Returns a rectangle having the 4 inner dimensions of 2 overlapping rectangles.
Normalize	Normalizes the CRect so that the minimum is less than the maximum value in each direction.
Offset	Offsets a rectangle's sides to move and/or resize it.
PtInside	Returns true if the specified point x,y is inside the rectangle.
PtInsideInt	Returns true if the specified point x,y is inside the rectangle.
RectInside	Returns true if the specified rectangle is completely enclosed with the rectangle.
Round	Rounds the rectanble limits to the nearest integer value.
Size	Returns the width and height of the rectangle.
Union	Returns a rectangle having the 4 outer dimensions of 2 overlapping rectangles.
Width	Returns the width of the rectangle.