Transformations handling

---

Detailed Description

Functions for transformations handling.

Functions
int	gx_inittrafo (gxHANDLE handle, gxTRAFO *ptrafo)
	Initializes a transformation structure.
int	gx_alloctrafo (gxHANDLE handle, gxTRAFO **ptrafo)
	Allocates a transformation structure.
int	gx_alloctrafo_dbg (gxHANDLE handle, gxTRAFO **ptrafo, const char *file, int line)
	Allocates a transformation structure (Debug version).
int	gx_freetrafo (gxHANDLE handle, gxTRAFO *ptrafo)
	Frees the specified transformation structure.
int	gx_createtrafo (gxHANDLE handle, gxTRAFO *ptrafo, const gxPG2 *pairs, int npair, const gxRCT &frame, int resolution)
	Creates a transformation structure based on the specified parameters.
int	gx_loadtrafo (gxHANDLE handle, gxTRAFO *ptrafo, const wchar_t *filename)
	Loads data from the specified transformation file to an initialized structure (Unicode version).
int	gx_loadtrafoa (gxHANDLE handle, gxTRAFO *ptrafo, const char *filename)
	Loads data from the specified transformation file to an initialized structure (ASCII version).
int	gx_loadtrafo (gxHANDLE handle, gxTRAFO *ptrafo, const char *filename)
	Loads data from the specified transformation file to an initialized structure (ASCII version).
int	gx_savetrafo (gxHANDLE handle, gxTRAFO *ptrafo, const wchar_t *filename)
	Saves the specified transformation structure to a file (Unicode version).
int	gx_savetrafoa (gxHANDLE handle, gxTRAFO *ptrafo, const char *filename)
	Saves the specified transformation structure to a file (ASCII version).
int	gx_savetrafo (gxHANDLE handle, gxTRAFO *ptrafo, const char *filename)
	Saves the specified transformation structure to a file (ASCII version).
int	gx_copytrafo (gxHANDLE handle, gxTRAFO *ptrafo, const gxTRAFO *ptrafo_source)
	Copies one transformation structure to another.
int	gx_trafo (gxHANDLE handle, gxTRAFO *ptrafo, const gxPNT *source, gxPNT *target, int npoints)
	Transforms points from the source sequence with the help of the specified structure then writes the result to the destination sequence list.
int	gx_trafo_pnt (gxHANDLE handle, gxTRAFO *ptrafo, const gxPNT *source, gxPNT *target)
	Transforms one point from the source with the help of the specified structure then writes the result to the destination point.
int	gx_itrafo (gxHANDLE handle, gxTRAFO *ptrafo, const gxPNT *source, gxPNT *target, int npoints)
	Inverse transformation.
int	gx_itrafo_pnt (gxHANDLE handle, gxTRAFO *ptrafo, const gxPNT *source, gxPNT *target)
	Inverse transformation.
int	gx_isvalidtrafo (gxHANDLE handle, const gxTRAFO *ptrafo)
	Checks the specified transformation structure.
int	gx_trafotovariant (gxHANDLE handle, gxTRAFO *source, int varid, gxVARIANT *target)
	Embedds a transformation structure into a variant.
int	gx_trafofromvariant (gxHANDLE handle, gxTRAFO **target, gxVARIANT source)
	Loads an embedded transformation structure from a variant.
int	gx_inittrafo (gxTRAFO *ptrafo)
	Initializes a transformation structure.
int	gx_alloctrafo (gxTRAFO **ptrafo)
	Allocates a transformation structure.
int	gx_alloctrafo_dbg (gxTRAFO **ptrafo, const char *file, int line)
	Allocates a transformation structure (Debug version).
int	gx_freetrafo (gxTRAFO *ptrafo)
	Frees the specified transformation structure.
int	gx_createtrafo (gxTRAFO *ptrafo, const gxPG2 *pairs, int npair, const gxRCT &frame, int resolution)
	Creates a transformation structure based on the specified parameters.
int	gx_loadtrafo (gxTRAFO *ptrafo, const wchar_t *filename)
	Loads data from the specified transformation file to an initialized structure (Unicode version).
int	gx_loadtrafo (gxTRAFO *ptrafo, const char *filename)
	Loads data from the specified transformation file to an initialized structure (ASCII version).
int	gx_savetrafo (gxTRAFO *ptrafo, const wchar_t *filename)
	Saves the specified transformation structure to a file (Unicode version).
int	gx_savetrafo (gxTRAFO *ptrafo, const char *filename)
	Saves the specified transformation structure to a file (ASCII version).
int	gx_copytrafo (gxTRAFO *ptrafo, const gxTRAFO *ptrafo_source)
	Copies one transformation structure to another.
int	gx_trafo (gxTRAFO *ptrafo, const gxPNT *source, gxPNT *target, int npoints)
	Transforms points from the source sequence with the help of the specified structure then writes the result to the destination sequence list.
int	gx_trafo_pnt (gxTRAFO *ptrafo, const gxPNT *source, gxPNT *target)
	Transforms one point from the source with the help of the specified structure then writes the result to the destination point.
int	gx_itrafo (gxTRAFO *ptrafo, const gxPNT *source, gxPNT *target, int npoints)
	Inverse transformation.
int	gx_itrafo_pnt (gxTRAFO *ptrafo, const gxPNT *source, gxPNT *target)
	Inverse transformation.
int	gx_isvalidtrafo (const gxTRAFO *ptrafo)
	Checks the specified transformation structure.
int	gx_trafotovariant (gxTRAFO *source, int varid, gxVARIANT *target)
	Embedds a transformation structure into a variant.
int	gx_trafofromvariant (gxTRAFO **target, gxVARIANT source)
	Loads an embedded transformation structure from a variant.

---

Function Documentation

int gx_inittrafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo
	)			[inline]

Initializes a transformation structure.

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an uninitialized transformation structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_inittrafo().

int gx_alloctrafo	(	gxHANDLE	handle,
		gxTRAFO **	ptrafo
	)			[inline]

Allocates a transformation structure.

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to a transformation structure pointer, where the function copies the recently allocated structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gxTrafo::Detach(), gx_alloctrafo(), and gxTrafo::gxTrafo().

int gx_alloctrafo_dbg	(	gxHANDLE	handle,
		gxTRAFO **	ptrafo,
		const char *	file,
		int	line
	)			[inline]

Allocates a transformation structure (Debug version).

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to a transformation structure pointer, where the function copies the recently allocated structure.
	file	File name.
	line	Line number.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_alloctrafo_dbg().

int gx_freetrafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo
	)			[inline]

Frees the specified transformation structure.

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_freetrafo().

int gx_createtrafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const gxPG2 *	pairs,
		int	npair,
		const gxRCT &	frame,
		int	resolution
	)			[inline]

Creates a transformation structure based on the specified parameters.

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized structure.
	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:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gxTrafo::Create(), and gx_createtrafo().

int gx_loadtrafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const wchar_t *	filename
	)			[inline]

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

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized structure.
	filename	Name of the file containing the data.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_loadtrafo(), and gxTrafo::Load().

int gx_loadtrafoa	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const char *	filename
	)			[inline]

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

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized structure.
	filename	Name of the file containing the data.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_loadtrafo(), and gxTrafo::Load().

int gx_loadtrafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const char *	filename
	)			[inline]

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

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized structure.
	filename	Name of the file containing the data.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_loadtrafoa().

int gx_savetrafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const wchar_t *	filename
	)			[inline]

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

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized structure.
	filename	Name of the file.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_savetrafo(), and gxTrafo::Save().

int gx_savetrafoa	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const char *	filename
	)			[inline]

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

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized structure.
	filename	Name of the file.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_savetrafo(), and gxTrafo::Save().

int gx_savetrafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const char *	filename
	)			[inline]

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

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized structure.
	filename	Name of the file.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_savetrafoa().

int gx_copytrafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const gxTRAFO *	ptrafo_source
	)			[inline]

Copies one transformation structure to another.

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

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized destination structure.
	ptrafo_source	Pointer to the source.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gxTrafo::Copy(), and gx_copytrafo().

int gx_trafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const gxPNT *	source,
		gxPNT *	target,
		int	npoints
	)			[inline]

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

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized transformation structure.
	source	List of source points.
	target	Place of transformed points.
	npoints	Number of points in the list.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_trafo(), and gxTrafo::Trafo().

int gx_trafo_pnt	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const gxPNT *	source,
		gxPNT *	target
	)			[inline]

Transforms one point from the source with the help of the specified structure then writes the result to the destination point.

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized transformation structure.
	source	Pointer to the source point.
	target	Place of transformed point.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_trafo_pnt().

int gx_itrafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const gxPNT *	source,
		gxPNT *	target,
		int	npoints
	)			[inline]

Inverse transformation.

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized transformation structure.
	source	List of source points.
	target	Place of transformed points.
	npoints	Number of points in the list.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_itrafo(), and gxTrafo::ITrafo().

int gx_itrafo_pnt	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo,
		const gxPNT *	source,
		gxPNT *	target
	)			[inline]

Inverse transformation.

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized transformation structure.
	source	Pointer to the source point.
	target	Place of transformed point.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_itrafo_pnt().

int gx_isvalidtrafo	(	gxHANDLE	handle,
		const gxTRAFO *	ptrafo
	)			[inline]

Checks the specified transformation structure.

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized transformation structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_isvalidtrafo(), and gxTrafo::IsValid().

int gx_trafotovariant	(	gxHANDLE	handle,
		gxTRAFO *	source,
		int	varid,
		gxVARIANT *	target
	)			[inline]

Embedds a transformation structure into a variant.

Parameters:

	handle	Handle of the module.
	source	Pointer to the source transformation structure.
	varid	The id for the created variant.
	target	Pointer to the initialized destination variant.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_trafotovariant(), and gxTrafo::ToVariant().

int gx_trafofromvariant	(	gxHANDLE	handle,
		gxTRAFO **	target,
		gxVARIANT	source
	)			[inline]

Loads an embedded transformation structure from a variant.

Parameters:

	handle	Handle of the module.
	target	Pointer to the destination transformation structure.
	source	Variant with an embedded transformation structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gxTrafo::FromVariant(), and gx_trafofromvariant().

int gx_inittrafo

(

gxTRAFO *

ptrafo

)

[inline]

Initializes a transformation structure.

Parameters:

ptrafo

Pointer to a non initialized transformation structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_inittrafo().

int gx_alloctrafo

(

gxTRAFO **

ptrafo

)

[inline]

Allocates a transformation structure.

Parameters:

ptrafo

Pointer to a transformation structure pointer, to where the function copies the recently allocated structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_alloctrafo(), and gx_direct().

int gx_alloctrafo_dbg	(	gxTRAFO **	ptrafo,
		const char *	file,
		int	line
	)			[inline]

Allocates a transformation structure (Debug version).

Parameters:

	ptrafo	Pointer to a transformation structure pointer, where the function copies the recently allocated structure.
	file	File name.
	line	Line number.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_alloctrafo_dbg(), and gx_direct().

int gx_freetrafo

(

gxTRAFO *

ptrafo

)

[inline]

Frees the specified transformation structure.

Parameters:

ptrafo

Pointer to an initialized structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_freetrafo().

int gx_createtrafo	(	gxTRAFO *	ptrafo,
		const gxPG2 *	pairs,
		int	npair,
		const gxRCT &	frame,
		int	resolution
	)			[inline]

Creates a transformation structure based on the specified parameters.

Parameters:

	ptrafo	Pointer to an initialized structure.
	pairs	Pointer to the list of point pairs.
	npair	Number of point 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:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_createtrafo(), and gx_direct().

int gx_loadtrafo	(	gxTRAFO *	ptrafo,
		const wchar_t *	filename
	)			[inline]

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

Parameters:

	ptrafo	Pointer to an initialized structure.
	filename	Name of the file containing the data.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_loadtrafo().

int gx_loadtrafo	(	gxTRAFO *	ptrafo,
		const char *	filename
	)			[inline]

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

Parameters:

	ptrafo	Pointer to an initialized structure.
	filename	Name of the file containing the data.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_loadtrafo().

int gx_savetrafo	(	gxTRAFO *	ptrafo,
		const wchar_t *	filename
	)			[inline]

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

Parameters:

	ptrafo	Pointer to an initialized structure.
	filename	Name of the file.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_savetrafo().

int gx_savetrafo	(	gxTRAFO *	ptrafo,
		const char *	filename
	)			[inline]

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

Parameters:

	ptrafo	Pointer to an initialized structure.
	filename	Name of the file.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_savetrafo().

int gx_copytrafo	(	gxTRAFO *	ptrafo,
		const gxTRAFO *	ptrafo_source
	)			[inline]

Copies one transformation structure to another.

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

Parameters:

	ptrafo	Pointer to an initialized destination structure.
	ptrafo_source	Pointer to the source.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_copytrafo(), and gx_direct().

int gx_trafo	(	gxTRAFO *	ptrafo,
		const gxPNT *	source,
		gxPNT *	target,
		int	npoints
	)			[inline]

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

Parameters:

	ptrafo	Pointer to an initialized transformation structure.
	source	List of source points.
	target	Place of transformed points.
	npoints	Number of points in the list.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_trafo().

int gx_trafo_pnt	(	gxTRAFO *	ptrafo,
		const gxPNT *	source,
		gxPNT *	target
	)			[inline]

Transforms one point from the source with the help of the specified structure then writes the result to the destination point.

Parameters:

	ptrafo	Pointer to an initialized transformation structure.
	source	Pointer to the source point.
	target	Place of transformed point.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_trafo_pnt().

int gx_itrafo	(	gxTRAFO *	ptrafo,
		const gxPNT *	source,
		gxPNT *	target,
		int	npoints
	)			[inline]

Inverse transformation.

Parameters:

	ptrafo	Pointer to an initialized transformation structure.
	source	List of source points.
	target	Place of transformed points.
	npoints	Number of points in the list.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_itrafo().

int gx_itrafo_pnt	(	gxTRAFO *	ptrafo,
		const gxPNT *	source,
		gxPNT *	target
	)			[inline]

Inverse transformation.

Parameters:

	ptrafo	Pointer to an initialized transformation structure.
	source	Pointer to the source point.
	target	Place of transformed point.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_itrafo_pnt().

int gx_isvalidtrafo

(

const gxTRAFO *

ptrafo

)

[inline]

Checks the specified transformation structure.

Parameters:

ptrafo

Pointer to an initialized transformation structure.

Returns:

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

References gx_direct(), and gx_isvalidtrafo().

int gx_trafotovariant	(	gxTRAFO *	source,
		int	varid,
		gxVARIANT *	target
	)			[inline]

Embedds a transformation structure into a variant.

Parameters:

	source	Pointer to the source transformation structure.
	varid	The id for the created variant.
	target	Pointer to the initialized destination variant.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_trafotovariant().

int gx_trafofromvariant	(	gxTRAFO **	target,
		gxVARIANT	source
	)			[inline]

Loads an embedded transformation structure from a variant.

Parameters:

	target	Pointer to the destination transformation structure.
	source	Variant with an embedded transformation structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_trafofromvariant().