SignDoc SDK (C++)  5.0.0
SignDocWeightedFrame Class Reference

A frame and its weight. More...

#include <SignDocSDK-cpp.h>

Inheritance diagram for SignDocWeightedFrame:
SignDocImageRect

Public Member Functions

 SignDocWeightedFrame ()
 Constructor. More...
 
 SignDocWeightedFrame (int aX1, int aY1, int aX2, int aY2, double aWeight)
 Constructor. More...
 
 SignDocWeightedFrame (const SignDocWeightedFrame &aSource)
 Copy constructor. More...
 
 ~SignDocWeightedFrame ()
 Destructor. More...
 
double getWeight () const
 Get the weight. More...
 
- Public Member Functions inherited from SignDocImageRect
 SignDocImageRect ()
 Constructor. More...
 
 SignDocImageRect (int aX1, int aY1, int aX2, int aY2)
 Constructor. More...
 
 SignDocImageRect (const SignDocImageRect &aSource)
 Copy constructor. More...
 
void set (int aX1, int aY1, int aX2, int aY2)
 Set the coordinates of the rectangle. More...
 
 ~SignDocImageRect ()
 Destructor. More...
 
int getWidth () const
 Get the width of the rectangle. More...
 
int getHeight () const
 Get the height of the rectangle. More...
 
void normalize ()
 Normalize the rectangle. More...
 
bool isEmpty () const
 Check if the rectangle is empty. More...
 
void intersectWith (const SignDocImageRect &aOther)
 Intersect this rectangle with another one. More...
 
void uniteWith (const SignDocImageRect &aOther)
 Unite this rectangle with another one. More...
 
int getX1 () const
 Get the first X coordinate. More...
 
int getY1 () const
 Get the first Y coordinate. More...
 
int getX2 () const
 Get the second X coordinate. More...
 
int getY2 () const
 Get the second Y coordinate. More...
 

Data Fields

double mWeight
 The weight (0.0 through 1.0). More...
 
- Data Fields inherited from SignDocImageRect
int mX1
 The first X coordinate. More...
 
int mY1
 The first Y coordinate. More...
 
int mX2
 The second X coordinate. More...
 
int mY2
 The second Y coordinate. More...
 

Detailed Description

A frame and its weight.

This class uses images coordinates, see Coordinate Systems.

Constructor & Destructor Documentation

Constructor.

All coordinates and the weight will be 0.

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

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).
SignDocWeightedFrame ( const SignDocWeightedFrame aSource)
inline

Copy constructor.

Parameters
[in]aSourceThe object to be copied.
~SignDocWeightedFrame ( )
inline

Destructor.

Member Function Documentation

double getWeight ( ) const
inline

Get the weight.

Returns
The weight.

Field Documentation

double mWeight

The weight (0.0 through 1.0).


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