SignDoc SDK (C)
5.0.0
|
A frame and its weight. More...
#include <SignDocSDK-c.h>
Public Attributes | |
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... | |
double | mWeight |
The weight (0.0 through 1.0). More... | |
A frame and its weight.
The origin is in the upper left corner, the right and bottom coordinates are exclusive.
This class uses image coordinates, see Coordinate Systems.
void SIGNDOC_WeightedFrame_assign | ( | struct SIGNDOC_WeightedFrame * | aObj, |
const struct SIGNDOC_WeightedFrame * | aSource | ||
) |
SIGNDOC_WeightedFrame assignment operator.
[in] | aObj | A pointer to the SIGNDOC_WeightedFrame object. |
[in] | aSource | A pointer to the source SIGNDOC_WeightedFrame object. |
struct SIGNDOC_WeightedFrame * SIGNDOC_WeightedFrame_clone | ( | struct SIGNDOC_Exception ** | aEx, |
const struct SIGNDOC_WeightedFrame * | aObj | ||
) |
Clone a SIGNDOC_WeightedFrame object.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_WeightedFrame object. |
void SIGNDOC_WeightedFrame_delete | ( | struct SIGNDOC_WeightedFrame * | aObj | ) |
SIGNDOC_WeightedFrame destructor.
[in] | aObj | A pointer to the SIGNDOC_WeightedFrame object. must not be a pointer returned by SIGNDOC_WeightedFrameArray_at(). |
int SIGNDOC_WeightedFrame_getHeight | ( | const struct SIGNDOC_WeightedFrame * | aObj | ) |
Get the height of the rectangle.
[in] | aObj | A pointer to the SIGNDOC_WeightedFrame object. |
double SIGNDOC_WeightedFrame_getWeight | ( | const struct SIGNDOC_WeightedFrame * | aObj | ) |
Get the weight.
[in] | aObj | A pointer to the SIGNDOC_WeightedFrame object. |
int SIGNDOC_WeightedFrame_getWidth | ( | const struct SIGNDOC_WeightedFrame * | aObj | ) |
Get the width of the rectangle.
[in] | aObj | A pointer to the SIGNDOC_WeightedFrame object. |
int SIGNDOC_WeightedFrame_getX1 | ( | const struct SIGNDOC_WeightedFrame * | aObj | ) |
Get the first X coordinate of a SIGNDOC_WeightedFrame object.
[in] | aObj | A pointer to the SIGNDOC_WeightedFrame object. |
int SIGNDOC_WeightedFrame_getX2 | ( | const struct SIGNDOC_WeightedFrame * | aObj | ) |
Get the second X coordinate of a SIGNDOC_WeightedFrame object.
[in] | aObj | A pointer to the SIGNDOC_WeightedFrame object. |
int SIGNDOC_WeightedFrame_getY1 | ( | const struct SIGNDOC_WeightedFrame * | aObj | ) |
Get the first Y coordinate of a SIGNDOC_WeightedFrame object.
[in] | aObj | A pointer to the SIGNDOC_WeightedFrame object. |
int SIGNDOC_WeightedFrame_getY2 | ( | const struct SIGNDOC_WeightedFrame * | aObj | ) |
Get the second Y coordinate of a SIGNDOC_WeightedFrame object.
[in] | aObj | A pointer to the SIGNDOC_WeightedFrame object. |
struct SIGNDOC_WeightedFrame * SIGNDOC_WeightedFrame_new | ( | struct SIGNDOC_Exception ** | aEx | ) |
SIGNDOC_WeightedFrame constructor.
All coordinates and the weight will be 0.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
struct SIGNDOC_WeightedFrame * SIGNDOC_WeightedFrame_newXY | ( | struct SIGNDOC_Exception ** | aEx, |
int | aX1, | ||
int | aY1, | ||
int | aX2, | ||
int | aY2, | ||
double | aWeight | ||
) |
SIGNDOC_WeightedFrame constructor.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aX1 | The first X coordinate. |
[in] | aY1 | The first Y coordinate. |
[in] | aX2 | The second X coordinate. |
[in] | aY2 | The second Y coordinate. |
[in] | aWeight | The weight (0.0 through 1.0, not checked). |
void SIGNDOC_WeightedFrame_normalize | ( | struct SIGNDOC_WeightedFrame * | aObj | ) |
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.
[in] | aObj | A pointer to the SIGNDOC_WeightedFrame object. |
double mWeight |
The weight (0.0 through 1.0).
int mX1 |
The first X coordinate.
int mX2 |
The second X coordinate.
int mY1 |
The first Y coordinate.
int mY2 |
The second Y coordinate.