SignDoc SDK (.NET with exceptions)  5.0.0
Rect Class Reference

A rectangle (document coordinates). More...

Public Member Functions

 ~Rect ()
 Destructor. More...
 
 !Rect ()
 Finalizer. More...
 
 Rect ()
 Constructor. More...
 
 Rect (Rect aSource)
 Copy constructor. More...
 
 Rect (double aX1, double aY1, double aX2, double aY2)
 Constructor. More...
 
void set (double aX1, double aY1, double aX2, double aY2)
 Set the coordinates of the rectangle. More...
 
void normalize ()
 Normalize the rectangle. More...
 
void scale (double aFactor)
 Scale the rectangle. More...
 
double getWidth ()
 Get the width of the rectangle. More...
 
double getHeight ()
 Get the height of the rectangle. More...
 
bool isEmpty ()
 Check if the rectangle is empty. More...
 
void intersectWith (Rect aOther)
 Intersect this rectangle with another one. More...
 
void uniteWith (Rect aOther)
 Unite this rectangle with another one. More...
 
double getX1 ()
 Get the first X coordinate. More...
 
double getY1 ()
 Get the first Y coordinate. More...
 
double getX2 ()
 Get the second X coordinate. More...
 
double getY2 ()
 Get the second Y coordinate. More...
 

Detailed Description

A rectangle (document coordinates).

If coordinates are given in pixels (this is true for TIFF documents), the right and top coordinates are exclusive.

The edges of the rectangle are parallel to the axes.

See Coordinate Systems.

Constructor & Destructor Documentation

~Rect ( )

Destructor.

!Rect ( )

Finalizer.

Rect ( )

Constructor.

All coordinates will be 0.

Rect ( Rect  aSource)

Copy constructor.

Parameters
[in]aSourceThe object to be copied.
Rect ( double  aX1,
double  aY1,
double  aX2,
double  aY2 
)

Constructor.

Parameters
[in]aX1The first X coordinate.
[in]aY1The first Y coordinate.
[in]aX2The second X coordinate.
[in]aY2The second Y coordinate.

Member Function Documentation

double getHeight ( )

Get the height of the rectangle.

Returns
The height of the rectangle.
double getWidth ( )

Get the width of the rectangle.

Returns
The width of the rectangle.
double getX1 ( )

Get the first X coordinate.

Returns
The first X coordinate
double getX2 ( )

Get the second X coordinate.

Returns
The second X coordinate.
double getY1 ( )

Get the first Y coordinate.

Returns
The first Y coordinate.
double getY2 ( )

Get the second Y coordinate.

void intersectWith ( Rect  aOther)

Intersect this rectangle with another one.

If either rectangle is empty, this rectangle will be empty. The resulting rectangle will be normalized.

Parameters
[in]aOtherThe other rectangle.
See also
isEmpty(), uniteWith()
bool isEmpty ( )

Check if the rectangle is empty.

A rectangle is empty if the two X coordinates are equal or if the two Y coordinates are equal.

Returns
true iff the rectangle is empty.
void normalize ( )

Normalize the rectangle.

Normalize the rectangle to the one with lower-left and upper-right corners assuming that the origin is in the lower-left corner of the page.

This function assumes that document coordinates are used, see Coordinate Systems).

void scale ( double  aFactor)

Scale the rectangle.

Parameters
[in]aFactorThe factor by which the rectangle is to be scaled.
void set ( double  aX1,
double  aY1,
double  aX2,
double  aY2 
)

Set the coordinates of the rectangle.

Parameters
[in]aX1The first X coordinate.
[in]aY1The first Y coordinate.
[in]aX2The second X coordinate.
[in]aY2The second Y coordinate.
void uniteWith ( Rect  aOther)

Unite this rectangle with another one.

Replace this rectangle with the smallest rectangle that contains both retangles.

If this rectangle is empty, it will be set to aOther. If aOther is empty, this rectangle won't be modified. The resulting rectangle will be normalized.

Parameters
[in]aOtherThe other rectangle.
See also
intersectWith(), isEmpty()

The documentation for this class was generated from the following file: