gxTrafo Class Reference

Inheritance diagram for gxTrafo:

List of all members.

---

Detailed Description

Class for the transformation functions.

Public Member Functions
	gxTrafo () throw (gxError)
	Class initialization with default properties.
	gxTrafo (const gxHANDLE &h) throw (gxError)
	Class initialization with a source trafo handle.
	gxTrafo (const gxHANDLE *h) throw (gxError)
	Class initialization with a source trafo handle.
	gxTrafo (const wchar_t *propname, const wchar_t *modname=(const wchar_t *) 0) throw (gxError)
	Class initialization with the place of the properties and name of the module (Unicode version).
	gxTrafo (const char *propname, const char *modname=(const char *) 0) throw (gxError)
	Class initialization with the place of the properties and name of the module (ASCII version).
	gxTrafo (gxTRAFO &src) throw (gxError)
	Class initialization with another trafo structure.
	gxTrafo (gxTRAFO &src, const wchar_t *propname, const wchar_t *modname=(const wchar_t *) 0) throw (gxError)
	Class initialization with another trafo structure, the place of the properties and name of the module (Unicode version).
	gxTrafo (gxTRAFO &src, const char *propname, const char *modname=(const char *) 0) throw (gxError)
	Class initialization with another trafo structure, the place of the properties and name of the module (ASCII version).
	gxTrafo (gxTrafo &src, const wchar_t *propname, const wchar_t *modname=(const wchar_t *) 0) throw (gxError)
	Class initialization with another trafo class, the place of the properties and name of the module (Unicode version).
	gxTrafo (gxTrafo &src, const char *propname, const char *modname=(const char *) 0) throw (gxError)
	Class initialization with another trafo class, the place of the properties and name of the module (ASCII version).
	gxTrafo (gxInStr propname) throw (gxError)
	Class initialization with the place of the properties (Unicode version).
	gxTrafo (gxInStr propname, gxInStr modname) throw (gxError)
	Class initialization with another trafo class, the place of the properties and name of the module (Unicode version).
	gxTrafo (gxInAStr propname) throw (gxError)
	Class initialization with the place of the properties (ASCII version).
	gxTrafo (gxInAStr propname, gxInAStr modname) throw (gxError)
	Class initialization with another trafo class, the place of the properties and name of the module (ASCII version).
	gxTrafo (gxTrafoHandler &h) throw (gxError)
	Class initialization with another trafo handler.
	gxTrafo (gxTrafo &src) throw (gxError)
	Class initialization with another trafo.
	~gxTrafo () throw (gxError)
	Class termination.
void	Dispose (void) throw (gxError)
	It disposes the class.
gxTrafo &	operator= (gxTRAFO &src) throw (gxError)
	Copies a trafo to the class.
gxTrafo &	operator= (gxTrafo &src) throw (gxError)
	Copies a trafo to the class.
	operator gxTRAFO & () throw (gxError)
	Returns a reference to the gxTRAFO structure.
	operator gxTRAFO * () throw (gxError)
	Returns a pointer to the gxTRAFO structure.
	operator const gxTRAFO * () const throw (gxError)
	Returns a pointer to the gxTRAFO structure.
bool	Attach (gxTRAFO *src) throw (gxError)
	Attaches to an allocated trafo.
bool	Detach (void) throw (gxError)
	Detaches the trafo.
bool	Create (const gxPG2 *pairs, int npair, const gxRCT &frame, int resolution) throw (gxError)
	Creates a transformation structure based on the specified parameters.
bool	Load (const wchar_t *filename) throw (gxError)
	Loads data from the specified transformation file to an initialized structure (Unicode version).
bool	Load (const char *filename) throw (gxError)
	Loads data from the specified transformation file to an initialized structure (ASCII version).
bool	Save (const wchar_t *filename) throw (gxError)
	Saves the specified transformation structure to a file (Unicode version).
bool	Save (const char *filename) throw (gxError)
	Saves the specified transformation structure to a file (ASCII version).
bool	Load (gxInStr filename) throw (gxError)
	Loads data from the specified transformation file to an initialized structure (Unicode version).
bool	Save (gxInStr filename) throw (gxError)
	Saves the specified transformation structure to a file (Unicode version).
bool	Load (gxInAStr filename) throw (gxError)
	Loads data from the specified transformation file to an initialized structure (ASCII version).
bool	Save (gxInAStr filename) throw (gxError)
	Saves the specified transformation structure to a file (ASCII version).
bool	Copy (const gxTRAFO *source) throw (gxError)
	Copies one transformation structure to another.
bool	Copy (const gxTrafo *source) throw (gxError)
	Copies one transformation structure to another.
bool	Copy (const gxTRAFO &source) throw (gxError)
	Copies one transformation structure to another.
bool	Copy (const gxTrafo &source) throw (gxError)
	Copies one transformation structure to another.
bool	Trafo (const gxPNT *source, gxPNT *target, int npoints=1) throw (gxError)
	Transforms points from the source sequence with the help of the specified structure then writes the result to the destination sequence list.
bool	Trafo (const gxPG2 *source, gxPNT *target) throw (gxError)
	Transforms two points from the source with the help of the specified structure then writes the result to the destination area.
bool	Trafo (const gxPG4 *source, gxPNT *target) throw (gxError)
	Transforms four points from the source with the help of the specified structure then writes the result to the destination area.
bool	ITrafo (const gxPNT *source, gxPNT *target, int npoints=1) throw (gxError)
	Inverse transformation.
bool	ITrafo (const gxPG2 *source, gxPNT *target) throw (gxError)
	Inverse transformation.
bool	ITrafo (const gxPG4 *source, gxPNT *target) throw (gxError)
	Inverse transformation.
bool	IsValid (void) const
	Checks the specified transformation structure.
bool	FromVariant (gxVariant &variant) throw (gxError)
	Loads an embedded transformation structure from a variant.
gxVariant *	ToVariant (int varid) throw (gxError)
	Embedds the transformation structure into a variant.
bool	Open (const wchar_t *modulename, const wchar_t *groupname=(const wchar_t *) 0) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (const char *modulename, const char *groupname=(const char *) 0) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	Open (gxInStr modulename, gxInStr groupname) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (gxInStr modulename) throw (gxError)
	Opens a GX system compatible module with the default properties (Unicode version).
bool	Open (gxInAStr modulename, gxInAStr groupname) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	Open (gxInAStr modulename) throw (gxError)
	Opens a GX system compatible module with the default properties (ASCII version).
bool	Close (void) throw (gxError)
	Closes a previously opened module.
bool	GetInfo (const gxMODULEINFO **moduleinfo) throw (gxError)
	Gives information about an opened module.
bool	Call (int callcode, void *params)
	Calls a process of the module with its parameters.
bool	GetProperty (const wchar_t *name, wchar_t *string, int maxlen) throw (gxError)
	Gets a property of the specified module (Unicode version).
std::wstring	GetProperty (const wchar_t *name) throw (gxError)
	Gets a property of the specified module (Unicode version).
bool	GetProperty (const char *name, char *string, int maxlen) throw (gxError)
	Gets a property of the specified module (ASCII version).
std::string	GetProperty (const char *name) throw (gxError)
	Gets a property of the specified module (ASCII version).
gxOutStr	GetProperty (gxInStr name) throw (gxError)
	Gets a property of the specified module (Unicode version).
gxOutAStr	GetProperty (gxInAStr name) throw (gxError)
	Gets a property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
bool	GetProperty (const char *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
bool	GetProperty (const char *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
int	GetPropertyInt (const wchar_t *name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (gxInStr name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (const char *name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
int	GetPropertyInt (gxInAStr name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
double	GetPropertyFloat (const wchar_t *name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (gxInStr name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (const char *name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
double	GetPropertyFloat (gxInAStr name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
bool	GetPropertyVersion (const wchar_t *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (const wchar_t *name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (gxInStr name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
bool	GetPropertyVersion (const char *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (const char *name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (gxInAStr name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, const wchar_t *string) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (const char *name, const char *string) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, gxInStr str) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, gxInAStr str) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (const char *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (const char *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SaveProperties (const wchar_t *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (const char *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	SaveProperties (gxInStr name, int level) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInStr name) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInAStr name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	MPStartTransaction (void)
	It starts the property transaction.
bool	MPCommit (void)
	It ends the property transaction and updates your changes to module.
int	ref (void) const throw (gxError)
	Returns the reference counter.
const gxRCT &	source_frame (void) const throw (gxError)
	Returns the source frame.
int	xsize (void) const throw (gxError)
	Returns the horizontal size of the transformation area.
int	ysize (void) const throw (gxError)
	Returns the vertical size of the transformation area.
const gxPNTF *	base (void) const throw (gxError)
	Returns the transformation points.
const gxTRAFO *	trafo (void) const throw (gxError)
	Returns the transformation structure.
	operator gxTRAFO * () const
	Returns a pointer to the transformation structure.
	operator gxTRAFO & () const throw (gxError)
	Returns the reference to the transformation structure.
Public Attributes
gxu32	handle
	Handle of the module.

---

Constructor & Destructor Documentation

gxTrafo

(

)

throw (gxError) [inline]

Class initialization with default properties.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo

(

const gxHANDLE &

h

)

throw (gxError) [inline]

Class initialization with a source trafo handle.

Parameters:

h

Source trafo handle. The reference of this trafo handle will be increased.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo

(

const gxHANDLE *

h

)

throw (gxError) [inline]

Class initialization with a source trafo handle.

Parameters:

h

Source trafo handle. The reference of this trafo handle will be increased.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo	(	const wchar_t *	propname,
		const wchar_t *	modname = (const wchar_t *)0
	)			throw (gxError) [inline]

Class initialization with the place of the properties and name of the module (Unicode version).

Parameters:

	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo	(	const char *	propname,
		const char *	modname = (const char *)0
	)			throw (gxError) [inline]

Class initialization with the place of the properties and name of the module (ASCII version).

Parameters:

	propname	Place of properties in property tree (Name of a property group).
	modname	Name of the module.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo

(

gxTRAFO &

src

)

throw (gxError) [inline]

Class initialization with another trafo structure.

Parameters:

src

Source trafo.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo	(	gxTRAFO &	src,
		const wchar_t *	propname,
		const wchar_t *	modname = (const wchar_t *)0
	)			throw (gxError) [inline]

Class initialization with another trafo structure, the place of the properties and name of the module (Unicode version).

Parameters:

	src	Source trafo.
	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo	(	gxTRAFO &	src,
		const char *	propname,
		const char *	modname = (const char *)0
	)			throw (gxError) [inline]

Class initialization with another trafo structure, the place of the properties and name of the module (ASCII version).

Parameters:

	src	Source trafo.
	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo	(	gxTrafo &	src,
		const wchar_t *	propname,
		const wchar_t *	modname = (const wchar_t *)0
	)			throw (gxError) [inline]

Class initialization with another trafo class, the place of the properties and name of the module (Unicode version).

Parameters:

	src	Source trafo.
	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo	(	gxTrafo &	src,
		const char *	propname,
		const char *	modname = (const char *)0
	)			throw (gxError) [inline]

Class initialization with another trafo class, the place of the properties and name of the module (ASCII version).

Parameters:

	src	Source trafo.
	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo

(

gxInStr

propname

)

throw (gxError) [inline]

Class initialization with the place of the properties (Unicode version).

Parameters:

propname

Place of the properties in the property tree (Name of a property group).

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo	(	gxInStr	propname,
		gxInStr	modname
	)			throw (gxError) [inline]

Class initialization with another trafo class, the place of the properties and name of the module (Unicode version).

Parameters:

	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo

(

gxInAStr

propname

)

throw (gxError) [inline]

Class initialization with the place of the properties (ASCII version).

Parameters:

propname

Place of the properties in the property tree (Name of a property group).

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo	(	gxInAStr	propname,
		gxInAStr	modname
	)			throw (gxError) [inline]

Class initialization with another trafo class, the place of the properties and name of the module (ASCII version).

Parameters:

	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo

(

gxTrafoHandler &

h

)

throw (gxError) [inline]

Class initialization with another trafo handler.

Parameters:

h

The source handler.

References gx_alloctrafo(), and gxHandle::IsValid().

gxTrafo

(

gxTrafo &

src

)

throw (gxError) [inline]

Class initialization with another trafo.

Parameters:

src

The source trafo.

References gx_alloctrafo(), and gxHandle::IsValid().

~gxTrafo

(

)

throw (gxError) [inline]

Class termination.

---

Member Function Documentation

void Dispose

(

void

)

throw (gxError) [inline]

It disposes the class.

call the base class

Reimplemented from gxTrafoData.

References gxHandle::Dispose().

gxTrafo& operator=

(

gxTRAFO &

src

)

throw (gxError) [inline]

Copies a trafo to the class.

Parameters:

src

Source transformation structure.

gxTrafo& operator=

(

gxTrafo &

src

)

throw (gxError) [inline]

Copies a trafo to the class.

Parameters:

src

Source transformation class.

operator gxTRAFO &

(

)

throw (gxError) [inline]

Returns a reference to the gxTRAFO structure.

Returns:

Reference to the gxTRAFO structure.

operator gxTRAFO *

(

)

throw (gxError) [inline]

Returns a pointer to the gxTRAFO structure.

Returns:

Pointer to the gxTRAFO structure.

operator const gxTRAFO *

(

)

const throw (gxError) [inline]

Returns a pointer to the gxTRAFO structure.

Returns:

Pointer to the gxTRAFO structure.

bool Attach

(

gxTRAFO *

src

)

throw (gxError) [inline]

Attaches to an allocated trafo.

Parameters:

src

An allocated gxTRAFO structure.

Returns:

An exception is thrown or false is returned in case of error.

References GX_EINVAL, gx_reftrafo(), gx_seterror(), and gx_unreftrafo().

bool Detach

(

void

)

throw (gxError) [inline]

Detaches the trafo.

Returns:

An exception is thrown or false is returned in case of error.

References gx_alloctrafo(), and gx_unreftrafo().

bool Create	(	const gxPG2 *	pairs,
		int	npair,
		const gxRCT &	frame,
		int	resolution
	)			throw (gxError) [inline]

Creates a transformation structure based on the specified parameters.

Parameters:

	pairs	Pointer to the list point pairs.
	npair	Number of points in the list of point pairs.
	frame	The transformation works with in this frame. The coordinates are defined on the source coordinate system.
	resolution	Distances between two transformation elements.

Returns:

An exception is thrown or false is returned in case of error.

References gx_createtrafo().

bool Load

(

const wchar_t *

filename

)

throw (gxError) [inline]

Loads data from the specified transformation file to an initialized structure (Unicode version).

Parameters:

filename

Name of the file containing the data.

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadtrafo().

bool Load

(

const char *

filename

)

throw (gxError) [inline]

Loads data from the specified transformation file to an initialized structure (ASCII version).

Parameters:

filename

Name of the file containing the data.

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadtrafoa().

bool Save

(

const wchar_t *

filename

)

throw (gxError) [inline]

Saves the specified transformation structure to a file (Unicode version).

Parameters:

filename

Name of the file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_savetrafo().

bool Save

(

const char *

filename

)

throw (gxError) [inline]

Saves the specified transformation structure to a file (ASCII version).

Parameters:

filename

Name of the file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_savetrafoa().

bool Load

(

gxInStr

filename

)

throw (gxError) [inline]

Loads data from the specified transformation file to an initialized structure (Unicode version).

Parameters:

filename

Name of the file containing the data.

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadtrafo().

bool Save

(

gxInStr

filename

)

throw (gxError) [inline]

Saves the specified transformation structure to a file (Unicode version).

Parameters:

filename

Name of the file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_savetrafo().

bool Load

(

gxInAStr

filename

)

throw (gxError) [inline]

Loads data from the specified transformation file to an initialized structure (ASCII version).

Parameters:

filename

Name of the file containing the data.

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadtrafo().

bool Save

(

gxInAStr

filename

)

throw (gxError) [inline]

Saves the specified transformation structure to a file (ASCII version).

Parameters:

filename

Name of the file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_savetrafo().

bool Copy

(

const gxTRAFO *

source

)

throw (gxError) [inline]

Copies one transformation structure to another.

The destination structure must be initialized. Its data will be overwritten. The source structure remains unchanged.

Parameters:

source

Pointer to the source.

Returns:

An exception is thrown or false is returned in case of error.

References gx_copytrafo().

bool Copy

(

const gxTrafo *

source

)

throw (gxError) [inline]

Copies one transformation structure to another.

The destination structure must be initialized. Its data will be overwritten. The source structure remains unchanged.

Parameters:

source

Pointer to the source.

Returns:

An exception is thrown or false is returned in case of error.

References gx_copytrafo().

bool Copy

(

const gxTRAFO &

source

)

throw (gxError) [inline]

Copies one transformation structure to another.

The destination structure must be initialized. Its data will be overwritten. The source structure remains unchanged.

Parameters:

source

Source transformation structure.

Returns:

An exception is thrown or false is returned in case of error.

References gx_copytrafo().

bool Copy

(

const gxTrafo &

source

)

throw (gxError) [inline]

Copies one transformation structure to another.

The destination structure must be initialized. Its data will be overwritten. The source structure remains unchanged.

Parameters:

source

Source transformation structure.

Returns:

An exception is thrown or false is returned in case of error.

References gx_copytrafo().

bool Trafo	(	const gxPNT *	source,
		gxPNT *	target,
		int	npoints = 1
	)			throw (gxError) [inline]

Transforms points from the source sequence with the help of the specified structure then writes the result to the destination sequence list.

Parameters:

	source	List of source points.
	target	Place of transformed points.
	npoints	Number of points in the list.

Returns:

An exception is thrown or false is returned in case of error.

References gx_trafo().

bool Trafo	(	const gxPG2 *	source,
		gxPNT *	target
	)			throw (gxError) [inline]

Transforms two points from the source with the help of the specified structure then writes the result to the destination area.

Parameters:

	source	Pointer to the source.
	target	Place of transformed area.

Returns:

An exception is thrown or false is returned in case of error.

References gx_trafo().

bool Trafo	(	const gxPG4 *	source,
		gxPNT *	target
	)			throw (gxError) [inline]

Transforms four points from the source with the help of the specified structure then writes the result to the destination area.

Parameters:

	source	Pointer to the source.
	target	Place of transformed area.

Returns:

An exception is thrown or false is returned in case of error.

References gx_trafo().

bool ITrafo	(	const gxPNT *	source,
		gxPNT *	target,
		int	npoints = 1
	)			throw (gxError) [inline]

Inverse transformation.

Parameters:

	source	List of source points.
	target	Place of the transformed points.
	npoints	Number of points in the list.

Returns:

An exception is thrown or false is returned in case of error.

References gx_itrafo().

bool ITrafo	(	const gxPG2 *	source,
		gxPNT *	target
	)			throw (gxError) [inline]

Inverse transformation.

Parameters:

	source	Pointer to the source.
	target	Place of the transformed area.

Returns:

An exception is thrown or false is returned in case of error.

References gx_itrafo().

bool ITrafo	(	const gxPG4 *	source,
		gxPNT *	target
	)			throw (gxError) [inline]

Inverse transformation.

Parameters:

	source	Pointer to the source.
	target	Place of the transformed area.

Returns:

An exception is thrown or false is returned in case of error.

References gx_itrafo().

bool IsValid

(

void

)

const [inline]

Checks the specified transformation structure.

Returns:

In case of existing structure the return value is non-zero.

Reimplemented from gxHandle.

References gx_isvalidtrafo(), and gxHandle::IsValid().

bool FromVariant

(

gxVariant &

variant

)

throw (gxError) [inline]

Loads an embedded transformation structure from a variant.

Parameters:

variant

Variant with an embedded transformation structure.

Returns:

On error false is returned or an exception is thrown.

References gx_trafofromvariant(), and gx_unreftrafo().

gxVariant* ToVariant

(

int

varid

)

throw (gxError) [inline]

Embedds the transformation structure into a variant.

Parameters:

varid

The id for the created variant.

Returns:

The variant class. On error false is returned and an exception is thrown.

References GX_ENOMEM, gx_trafotovariant(), gx_unrefvariant(), and gxSystem::SetError().

bool Open	(	const wchar_t *	modulename,
		const wchar_t *	groupname = (const wchar_t *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	const char *	modulename,
		const char *	groupname = (const char *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	gxInStr	modulename,
		gxInStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open

(

gxInStr

modulename

)

throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (Unicode version).

Parameters:

modulename

Name of the module.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodule().

bool Open	(	gxInAStr	modulename,
		gxInAStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodulea().

bool Open

(

gxInAStr

modulename

)

throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (ASCII version).

Parameters:

modulename

Name of the module.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodulea().

bool Close

(

void

)

throw (gxError) [inline, inherited]

Closes a previously opened module.

It decreases the reference counter of the handle. The function closes the module if required (in case when the reference counter becames zero).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_unrefhandle(), and gxHandle::IsValid().

Referenced by gxHandle::operator=().

bool GetInfo

(

const gxMODULEINFO **

moduleinfo

)

throw (gxError) [inline, inherited]

Gives information about an opened module.

Parameters:

moduleinfo

Pointer to an information structure pointer where the system returns the data of the specified module.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmoduleinfo().

bool Call	(	int	callcode,
		void *	params
	)			[inline, inherited]

Calls a process of the module with its parameters.

The functions and parameters usable inside the modules can be found in the documentation of the modules. The headers given with the modules contain inline functions, which make easier to access the functions of the module.

Parameters:

	callcode	Call code for the function (GX_CALL_xxx call codes).
	params	Parameters to give for the function (GX_PARM_xxx structures).

Returns:

Module defined, usually success is true.

References gx_call().

bool GetProperty	(	const wchar_t *	name,
		wchar_t *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::wstring GetProperty

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

bool GetProperty	(	const char *	name,
		char *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::string GetProperty

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutStr GetProperty

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutAStr GetProperty

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertya().

bool GetProperty	(	const wchar_t *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

bool GetProperty	(	const char *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

bool GetProperty	(	const wchar_t *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

bool GetProperty	(	const char *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

int GetPropertyInt

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyint().

int GetPropertyInt

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

int GetPropertyInt

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyinta().

int GetPropertyInt

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

double GetPropertyFloat

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloata().

double GetPropertyFloat

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

bool GetPropertyVersion	(	const wchar_t *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

bool GetPropertyVersion	(	const char *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

bool SetProperty	(	const wchar_t *	name,
		const wchar_t *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	const char *	name,
		const char *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	gxInStr	name,
		gxInStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	gxInAStr	name,
		gxInAStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	const wchar_t *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	const char *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	gxInStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	gxInAStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	const wchar_t *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	const char *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SetProperty	(	gxInStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	gxInAStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SaveProperties	(	const wchar_t *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	const char *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInStr	name,
		int	level
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

name

Place of property in the tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInAStr	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemodulepropertiesa().

bool MPStartTransaction

(

void

)

[inline, inherited]

It starts the property transaction.

The module accepts but doesn't update properties (setmoduleproperty). You must use 'gx_mpcommit' to update these properties.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpstarttransaction().

bool MPCommit

(

void

)

[inline, inherited]

It ends the property transaction and updates your changes to module.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpcommit().

int ref

(

void

)

const throw (gxError) [inline, inherited]

Returns the reference counter.

See also:

gxTRAFO gx_reftrafo() gx_unreftrafo()

Returns:

Reference counter of the gxTRAFO structure.

References gxTRAFO::ref.

const gxRCT& source_frame

(

void

)

const throw (gxError) [inline, inherited]

Returns the source frame.

Returns:

Source frame element of the gxTRAFO structure.

References gxTRAFO::source_frame.

int xsize

(

void

)

const throw (gxError) [inline, inherited]

Returns the horizontal size of the transformation area.

Returns:

Horizontal size of the transformation area.

References gxTRAFO::xsize.

int ysize

(

void

)

const throw (gxError) [inline, inherited]

Returns the vertical size of the transformation area.

Returns:

Vertical size of the transformation area.

References gxTRAFO::ysize.

const gxPNTF* base

(

void

)

const throw (gxError) [inline, inherited]

Returns the transformation points.

Returns:

Transformation points of the gxTRAFO structure.

References gxTRAFO::base.

const gxTRAFO* trafo

(

void

)

const throw (gxError) [inline, inherited]

Returns the transformation structure.

return Transformation structure.

operator gxTRAFO *

(

)

const [inline, inherited]

Returns a pointer to the transformation structure.

operator gxTRAFO &

(

)

const throw (gxError) [inline, inherited]

Returns the reference to the transformation structure.

---

Member Data Documentation

gxu32 handle [inherited]

Handle of the module.

If it is zero, it is invalid.

See also:

gx_isvalidhandle()

Referenced by gx_closehandle(), gx_direct(), gx_isvalidhandle(), gxHandle::gxHandle(), gxImageHandler::gxImageHandler(), gxTrafoHandler::gxTrafoHandler(), and gxHandle::operator=().