SignDoc SDK (C)  5.0.0
SIGNDOC_Point Class Reference

A point (page coordinates or canvas coordinates depending on context). More...

#include <SignDocSDK-c.h>

Public Member Functions

struct SIGNDOC_PointSIGNDOC_Point_new (struct SIGNDOC_Exception **aEx)
 SIGNDOC_Point constructor. More...
 
struct SIGNDOC_PointSIGNDOC_Point_newXY (struct SIGNDOC_Exception **aEx, double aX, double aY)
 SIGNDOC_Point constructor. More...
 
struct SIGNDOC_PointSIGNDOC_Point_clone (struct SIGNDOC_Exception **aEx, const struct SIGNDOC_Point *aObj)
 Clone a SIGNDOC_Point object. More...
 
void SIGNDOC_Point_delete (struct SIGNDOC_Point *aObj)
 SIGNDOC_Point destructor. More...
 
void SIGNDOC_Point_assign (struct SIGNDOC_Point *aObj, const struct SIGNDOC_Point *aRHS)
 SIGNDOC_Point assignment operator. More...
 
void SIGNDOC_Point_setXY (struct SIGNDOC_Point *aObj, double aX, double aY)
 Set the coordinates of a SIGNDOC_Point object. More...
 
double SIGNDOC_Point_getX (const struct SIGNDOC_Point *aObj)
 Get the X coordinate of a SIGNDOC_Point object. More...
 
void SIGNDOC_Point_setX (struct SIGNDOC_Point *aObj, double aX)
 Set the X coordinate of a SIGNDOC_Point object. More...
 
double SIGNDOC_Point_getY (const struct SIGNDOC_Point *aObj)
 Get the Y coordinate of a SIGNDOC_Point object. More...
 
void SIGNDOC_Point_setY (struct SIGNDOC_Point *aObj, double aY)
 Set the Y coordinate of a SIGNDOC_Point object. More...
 

Public Attributes

double mX
 The X coordinate. More...
 
double mY
 The Y coordinate. More...
 

Detailed Description

A point (page coordinates or canvas coordinates depending on context).

See Coordinate Systems.

Member Function Documentation

void SIGNDOC_Point_assign ( struct SIGNDOC_Point aObj,
const struct SIGNDOC_Point aRHS 
)

SIGNDOC_Point assignment operator.

Parameters
[in]aObjA pointer to the SIGNDOC_Point object.
[in]aRHSA pointer to the source SIGNDOC_Point object.
struct SIGNDOC_Point * SIGNDOC_Point_clone ( struct SIGNDOC_Exception **  aEx,
const struct SIGNDOC_Point aObj 
)

Clone a SIGNDOC_Point object.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aObjA pointer to the SIGNDOC_Point object.
Returns
A pointer to the new SIGNDOC_Point object.
void SIGNDOC_Point_delete ( struct SIGNDOC_Point aObj)

SIGNDOC_Point destructor.

Parameters
[in]aObjA pointer to the SIGNDOC_Point object.
double SIGNDOC_Point_getX ( const struct SIGNDOC_Point aObj)

Get the X coordinate of a SIGNDOC_Point object.

Parameters
[in]aObjA pointer to the SIGNDOC_Point object.
Returns
The X coordinate.
double SIGNDOC_Point_getY ( const struct SIGNDOC_Point aObj)

Get the Y coordinate of a SIGNDOC_Point object.

Parameters
[in]aObjA pointer to the SIGNDOC_Point object.
Returns
The Y coordinate.
struct SIGNDOC_Point * SIGNDOC_Point_new ( struct SIGNDOC_Exception **  aEx)

SIGNDOC_Point constructor.

All coordinates will be 0.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
Returns
A pointer to the new SIGNDOC_Point object.
struct SIGNDOC_Point * SIGNDOC_Point_newXY ( struct SIGNDOC_Exception **  aEx,
double  aX,
double  aY 
)

SIGNDOC_Point constructor.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.
[in]aXThe X coordinate.
[in]aYThe Y coordinate.
Returns
A pointer to the new SIGNDOC_Point object.
void SIGNDOC_Point_setX ( struct SIGNDOC_Point aObj,
double  aX 
)

Set the X coordinate of a SIGNDOC_Point object.

Parameters
[in]aObjA pointer to the SIGNDOC_Point object.
[in]aXThe X coordinate.
void SIGNDOC_Point_setXY ( struct SIGNDOC_Point aObj,
double  aX,
double  aY 
)

Set the coordinates of a SIGNDOC_Point object.

Parameters
[in]aObjA pointer to the SIGNDOC_Point object.
[in]aXThe X coordinate.
[in]aYThe Y coordinate.
void SIGNDOC_Point_setY ( struct SIGNDOC_Point aObj,
double  aY 
)

Set the Y coordinate of a SIGNDOC_Point object.

Parameters
[in]aObjA pointer to the SIGNDOC_Point object.
[in]aYThe Y coordinate.

Member Data Documentation

double mX

The X coordinate.

double mY

The Y coordinate.


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