SignDoc SDK (.NET with exceptions)
5.0.0
|
A rectangle for use with SignDocImage. More...
Public Member Functions | |
~SignDocImageRect () | |
Destructor. More... | |
!SignDocImageRect () | |
Finalizer. More... | |
SignDocImageRect () | |
Constructor. More... | |
SignDocImageRect (int aX1, int aY1, int aX2, int aY2) | |
Constructor. More... | |
SignDocImageRect (SignDocImageRect aSource) | |
Copy constructor. More... | |
void | set (int aX1, int aY1, int aX2, int aY2) |
Set the coordinates of the rectangle. More... | |
int | getWidth () |
Get the width of the rectangle. More... | |
int | getHeight () |
Get the height of the rectangle. More... | |
void | normalize () |
Normalize the rectangle. More... | |
bool | isEmpty () |
Check if the rectangle is empty. More... | |
void | intersectWith (SignDocImageRect aOther) |
Intersect this rectangle with another one. More... | |
void | uniteWith (SignDocImageRect aOther) |
Unite this rectangle with another one. More... | |
int | getX1 () |
Get the first X coordinate. More... | |
int | getY1 () |
Get the first Y coordinate. More... | |
int | getX2 () |
Get the second X coordinate. More... | |
int | getY2 () |
Get the second Y coordinate. More... | |
A rectangle for use with SignDocImage.
The origin is in the upper left corner, the right and bottom coordinates are exclusive.
This class uses image coordinate, see Coordinate Systems.
The edges of the rectangle are parallel to the axes.
~SignDocImageRect | ( | ) |
Destructor.
!SignDocImageRect | ( | ) |
Finalizer.
SignDocImageRect | ( | ) |
Constructor.
All coordinates will be 0.
SignDocImageRect | ( | int | aX1, |
int | aY1, | ||
int | aX2, | ||
int | aY2 | ||
) |
Constructor.
[in] | aX1 | The first X coordinate. |
[in] | aY1 | The first Y coordinate. |
[in] | aX2 | The second X coordinate. |
[in] | aY2 | The second Y coordinate. |
SignDocImageRect | ( | SignDocImageRect | aSource | ) |
Copy constructor.
[in] | aSource | The object to be copied. |
int getHeight | ( | ) |
Get the height of the rectangle.
int getWidth | ( | ) |
Get the width of the rectangle.
int getX1 | ( | ) |
Get the first X coordinate.
int getX2 | ( | ) |
Get the second X coordinate.
int getY1 | ( | ) |
Get the first Y coordinate.
int getY2 | ( | ) |
Get the second Y coordinate.
void intersectWith | ( | SignDocImageRect | aOther | ) |
Intersect this rectangle with another one.
If either rectangle is empty, this rectangle will be empty. The resulting rectangle will be normalized.
[in] | aOther | The other rectangle. |
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.
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.
void set | ( | int | aX1, |
int | aY1, | ||
int | aX2, | ||
int | aY2 | ||
) |
Set the coordinates of the rectangle.
[in] | aX1 | The first X coordinate. |
[in] | aY1 | The first Y coordinate. |
[in] | aX2 | The second X coordinate. |
[in] | aY2 | The second Y coordinate. |
void uniteWith | ( | SignDocImageRect | 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.
[in] | aOther | The other rectangle. |