SignDocImageRect Class Reference

A rectangle for use with SignDocImage. More...

Inheritance diagram for SignDocImageRect:

Public Member Functions
	SignDocImageRect ()
	Constructor. More...
	SignDocImageRect (int aX1, int aY1, int aX2, int aY2)
	Constructor. More...
void	set (int aX1, int aY1, int aX2, int aY2)
	Set the coordinates of the rectangle. More...
void	normalize ()
	Normalize the rectangle. More...
int	getWidth ()
	Get the width of the rectangle. More...
int	getHeight ()
	Get the height of the rectangle. More...
boolean	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...
String	toString ()

Public Attributes
int	mX1
int	mY1
int	mX2
int	mY2

Detailed Description

A rectangle for use with SignDocImage.

The origin is in the upper left corner, the right and bottom coordinates are exclusive, see Coordinate Systems.

This class uses image coordinates, see Coordinate Systems.

The edges of the rectangle are parallel to the axes.

Constructor & Destructor Documentation

SignDocImageRect

(

)

Constructor.

All coordinates are set to 0.

SignDocImageRect	(	int	aX1,
		int	aY1,
		int	aX2,
		int	aY2
	)

Constructor.

Parameters

[in]	aX1	The first X coordinate.
[in]	aY1	The first Y coordinate.
[in]	aX2	The second X coordinate.
[in]	aY2	The second Y coordinate.

Member Function Documentation

int getHeight

(

)

Get the height of the rectangle.

Returns

The height of the rectangle.

int getWidth

(

)

Get the width of the rectangle.

Returns

The width of the rectangle.

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.

Parameters

[in]

aOther

The other rectangle.

See also

isEmpty(), uniteWith()

boolean 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 upper-left and lower-right corners assuming that the origin is in the upper-left corner of the page.

void set	(	int	aX1,
		int	aY1,
		int	aX2,
		int	aY2
	)

Set the coordinates of the rectangle.

Parameters

[in]	aX1	The first X coordinate.
[in]	aY1	The first Y coordinate.
[in]	aX2	The second X coordinate.
[in]	aY2	The second Y coordinate.

String toString

(

)

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.

Parameters

[in]

aOther

The other rectangle.

See also

intersectWith(), isEmpty()

Member Data Documentation

int mX1

int mX2

int mY1

int mY2

---

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

• de/softpro/doc/SignDocImageRect.java