de::softpro::doc::Rect Class Reference

A rectangle (page coordinates). More...

#include <SignDocSDK-cpp.h>

Public Member Functions
	Rect ()
	Constructor.
	Rect (double aX1, double aY1, double aX2, double aY2)
	Constructor.
	Rect (const Rect &aSrc)
	Copy constructor.
	~Rect ()
	Destructor.
void	get (double &aX1, double &aY1, double &aX2, double &aY2) const
	Get the coordinates of the rectangle.
void	set (double aX1, double aY1, double aX2, double aY2)
	Set the coordinates of the rectangle.
double	getWidth () const
	Get the width of the rectangle.
double	getHeight () const
	Get the height of the rectangle.
void	normalize ()
	Normalizes the rectangle.
void	scale (double aFactor)
	Scale the rectangle.
void	scale (double aFactorX, double aFactorY)
	Scale the rectangle.
double	getX1 () const
	Get the first X coordinate.
double	getY1 () const
	Get the first Y coordinate.
double	getX2 () const
	Get the second X coordinate.
double	getY2 () const
	Get the second Y coordinate.
Data Fields
double	mX1
	The first X coordinate.
double	mY1
	The first Y coordinate.
double	mX2
	The second X coordinate.
double	mY2
	The second Y coordinate.

---

Detailed Description

A rectangle (page coordinates).

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

---

Constructor & Destructor Documentation

de::softpro::doc::Rect::Rect

(

)

[inline]

Constructor.

All coordinates will be 0.

de::softpro::doc::Rect::Rect	(	double	aX1,
		double	aY1,
		double	aX2,
		double	aY2
	)		[inline]

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.

de::softpro::doc::Rect::Rect

(

const Rect &

aSrc )

[inline]

Copy constructor.

Parameters:

[in]

aSrc

The object to be copied.

de::softpro::doc::Rect::~Rect

(

)

[inline]

Destructor.

---

Member Function Documentation

void de::softpro::doc::Rect::get	(	double &	aX1,
		double &	aY1,
		double &	aX2,
		double &	aY2
	)		const [inline]

Get the coordinates of the rectangle.

Parameters:

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

double de::softpro::doc::Rect::getHeight

(

)

const [inline]

Get the height of the rectangle.

Returns:

The height of the rectangle.

double de::softpro::doc::Rect::getWidth

(

)

const [inline]

Get the width of the rectangle.

Returns:

The width of the rectangle.

double de::softpro::doc::Rect::getX1

(

)

const [inline]

Get the first X coordinate.

double de::softpro::doc::Rect::getX2

(

)

const [inline]

Get the second X coordinate.

double de::softpro::doc::Rect::getY1

(

)

const [inline]

Get the first Y coordinate.

double de::softpro::doc::Rect::getY2

(

)

const [inline]

Get the second Y coordinate.

void de::softpro::doc::Rect::normalize

(

)

[inline]

Normalizes the rectangle.

Normalizes 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 de::softpro::doc::Rect::scale

(

double

aFactor )

[inline]

Scale the rectangle.

Parameters:

[in]

aFactor

The factor by which the rectangle is to be scaled.

void de::softpro::doc::Rect::scale	(	double	aFactorX,
		double	aFactorY
	)		[inline]

Scale the rectangle.

Parameters:

[in]	aFactorX	The factor by which the rectangle is to be scaled horizontally.
[in]	aFactorY	The factor by which the rectangle is to be scaled vertically.

void de::softpro::doc::Rect::set	(	double	aX1,
		double	aY1,
		double	aX2,
		double	aY2
	)		[inline]

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.

---

Field Documentation

double de::softpro::doc::Rect::mX1

The first X coordinate.

double de::softpro::doc::Rect::mX2

The second X coordinate.

double de::softpro::doc::Rect::mY1

The first Y coordinate.

double de::softpro::doc::Rect::mY2

The second Y coordinate.

---

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

• SignDocSDK-cpp.h