SignDoc SDK (.NET without exceptions)  5.0.0
SignDocWeightedFrame Class Reference

A frame and its weight. More...

Public Member Functions

 ~SignDocWeightedFrame ()
 Destructor. More...
 
 !SignDocWeightedFrame ()
 Finalizer. More...
 
 SignDocWeightedFrame ()
 Constructor. More...
 
 SignDocWeightedFrame (int aX1, int aY1, int aX2, int aY2, double aWeight)
 Constructor. More...
 
 SignDocWeightedFrame (SignDocWeightedFrame aSource)
 Copy constructor. More...
 
int getWidth ()
 Get the width of the rectangle. More...
 
int getHeight ()
 Get the height of the rectangle. 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...
 
double getWeight ()
 Get the weight. More...
 

Detailed Description

A frame and its weight.

This class uses image coordinates, see Coordinate Systems.

Constructor & Destructor Documentation

Destructor.

Finalizer.

Constructor.

All coordinates and the weight will be 0.

SignDocWeightedFrame ( int  aX1,
int  aY1,
int  aX2,
int  aY2,
double  aWeight 
)

Constructor.

Parameters
[in]aX1The first X coordinate.
[in]aY1The first Y coordinate.
[in]aX2The second X coordinate.
[in]aY2The second Y coordinate.
[in]aWeightThe weight (0.0 through 1.0, not checked).

Copy constructor.

Parameters
[in]aSourceThe object to be copied.

Member Function Documentation

int getHeight ( )

Get the height of the rectangle.

Returns
The height of the rectangle.
double getWeight ( )

Get the weight.

Returns
The weight.
int getWidth ( )

Get the width of the rectangle.

Returns
The width of the rectangle.
int getX1 ( )

Get the first X coordinate.

Returns
The first X coordinate
int getX2 ( )

Get the second X coordinate.

Returns
The second X coordinate.
int getY1 ( )

Get the first Y coordinate.

Returns
The first Y coordinate.
int getY2 ( )

Get the second Y coordinate.

Returns
The second Y coordinate.

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