A frame and its weight. More...

#include <SignDocSDK-c.h>

Public Member Functions
struct SIGNDOC_WeightedFrame *	SIGNDOC_WeightedFrame_new (struct SIGNDOC_Exception **aEx)
	SIGNDOC_WeightedFrame constructor. More...

struct SIGNDOC_WeightedFrame *	SIGNDOC_WeightedFrame_newXY (struct SIGNDOC_Exception **aEx, int aX1, int aY1, int aX2, int aY2, double aWeight)
	SIGNDOC_WeightedFrame constructor. More...

struct SIGNDOC_WeightedFrame *	SIGNDOC_WeightedFrame_clone (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_WeightedFrame aObj)
	Clone a SIGNDOC_WeightedFrame object. More...

void	SIGNDOC_WeightedFrame_delete (struct SIGNDOC_WeightedFrame *aObj)
	SIGNDOC_WeightedFrame destructor. More...

void	SIGNDOC_WeightedFrame_assign (struct SIGNDOC_WeightedFrame aObj, const struct SIGNDOC_WeightedFrame aSource)
	SIGNDOC_WeightedFrame assignment operator. More...

int	SIGNDOC_WeightedFrame_getX1 (const struct SIGNDOC_WeightedFrame *aObj)
	Get the first X coordinate of a SIGNDOC_WeightedFrame object. More...

int	SIGNDOC_WeightedFrame_getY1 (const struct SIGNDOC_WeightedFrame *aObj)
	Get the first Y coordinate of a SIGNDOC_WeightedFrame object. More...

int	SIGNDOC_WeightedFrame_getX2 (const struct SIGNDOC_WeightedFrame *aObj)
	Get the second X coordinate of a SIGNDOC_WeightedFrame object. More...

int	SIGNDOC_WeightedFrame_getY2 (const struct SIGNDOC_WeightedFrame *aObj)
	Get the second Y coordinate of a SIGNDOC_WeightedFrame object. More...

int	SIGNDOC_WeightedFrame_getWidth (const struct SIGNDOC_WeightedFrame *aObj)
	Get the width of the rectangle. More...

int	SIGNDOC_WeightedFrame_getHeight (const struct SIGNDOC_WeightedFrame *aObj)
	Get the height of the rectangle. More...

double	SIGNDOC_WeightedFrame_getWeight (const struct SIGNDOC_WeightedFrame *aObj)
	Get the weight. More...

void	SIGNDOC_WeightedFrame_normalize (struct SIGNDOC_WeightedFrame *aObj)
	Normalize the rectangle. More...

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...

Detailed Description

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.

Member Function Documentation

void SIGNDOC_WeightedFrame_assign	(	struct SIGNDOC_WeightedFrame *	aObj,
		const struct SIGNDOC_WeightedFrame *	aSource
	)

SIGNDOC_WeightedFrame assignment operator.

Parameters

[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.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_WeightedFrame object.

Returns: A pointer to the new SIGNDOC_WeightedFrame object.

void SIGNDOC_WeightedFrame_delete ( struct SIGNDOC_WeightedFrame * aObj )

SIGNDOC_WeightedFrame destructor.

Parameters

[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.

Parameters

[in] aObj A pointer to the SIGNDOC_WeightedFrame object.

Returns: The height of the rectangle.

double SIGNDOC_WeightedFrame_getWeight ( const struct SIGNDOC_WeightedFrame * aObj )

Get the weight.

Parameters

[in] aObj A pointer to the SIGNDOC_WeightedFrame object.

Returns: The weight.

int SIGNDOC_WeightedFrame_getWidth ( const struct SIGNDOC_WeightedFrame * aObj )

Get the width of the rectangle.

Parameters

[in] aObj A pointer to the SIGNDOC_WeightedFrame object.

Returns: The width of the rectangle.

int SIGNDOC_WeightedFrame_getX1 ( const struct SIGNDOC_WeightedFrame * aObj )

Get the first X coordinate of a SIGNDOC_WeightedFrame object.

Parameters

[in] aObj A pointer to the SIGNDOC_WeightedFrame object.

Returns: The first X coordinate.

int SIGNDOC_WeightedFrame_getX2 ( const struct SIGNDOC_WeightedFrame * aObj )

Get the second X coordinate of a SIGNDOC_WeightedFrame object.

Parameters

[in] aObj A pointer to the SIGNDOC_WeightedFrame object.

Returns: The second X coordinate.

int SIGNDOC_WeightedFrame_getY1 ( const struct SIGNDOC_WeightedFrame * aObj )

Get the first Y coordinate of a SIGNDOC_WeightedFrame object.

Parameters

[in] aObj A pointer to the SIGNDOC_WeightedFrame object.

Returns: The first Y coordinate.

int SIGNDOC_WeightedFrame_getY2 ( const struct SIGNDOC_WeightedFrame * aObj )

Get the second Y coordinate of a SIGNDOC_WeightedFrame object.

Parameters

[in] aObj A pointer to the SIGNDOC_WeightedFrame object.

Returns: The second Y coordinate.

struct SIGNDOC_WeightedFrame * SIGNDOC_WeightedFrame_new ( struct SIGNDOC_Exception ** aEx )

SIGNDOC_WeightedFrame constructor.

All coordinates and the weight will be 0.

Parameters

[out] aEx Any exception will be returned in the object pointed to by this parameter.

Returns: A pointer to the new SIGNDOC_WeightedFrame object.

struct SIGNDOC_WeightedFrame * SIGNDOC_WeightedFrame_newXY	(	struct SIGNDOC_Exception **	aEx,
		int	aX1,
		int	aY1,
		int	aX2,
		int	aY2,
		double	aWeight
	)

SIGNDOC_WeightedFrame constructor.

Parameters

[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).

Returns: A pointer to the new SIGNDOC_WeightedFrame object.

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.

Parameters

[in] aObj A pointer to the SIGNDOC_WeightedFrame object.

Member Data Documentation

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.

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

SignDocSDK-c.h

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation