#include <Callbacks.h>

Inheritance diagram for prt::Callbacks:

Public Types
enum	Continuation { CONTINUE, CANCEL_AND_FINISH, CANCEL_ASAP }

enum	CoordSelector { PROJ_X, PROJ_Y, WGS84_LAT, WGS84_LON, WGS84_ALT_METER, LAYER_X, LAYER_Y, LAYER_Z }

enum	CoordSystemSelector { PROJ, WGS84, LAYER }

Public Member Functions
virtual Status	assetError (size_t isIndex, CGAErrorLevel level, const wchar_t key, const wchar_t uri, const wchar_t *message)=0

virtual Status	attrBool (size_t isIndex, int32_t shapeID, const wchar_t *key, bool value)=0

virtual Status	attrBoolArray (size_t isIndex, int32_t shapeID, const wchar_t key, const bool ptr, size_t size, size_t nRows)=0

virtual Status	attrFloat (size_t isIndex, int32_t shapeID, const wchar_t *key, double value)=0

virtual Status	attrFloatArray (size_t isIndex, int32_t shapeID, const wchar_t key, const double ptr, size_t size, size_t nRows)=0

virtual Status	attrString (size_t isIndex, int32_t shapeID, const wchar_t key, const wchar_t value)=0

virtual Status	attrStringArray (size_t isIndex, int32_t shapeID, const wchar_t key, const wchar_t const *ptr, size_t size, size_t nRows)=0

virtual Status	cgaError (size_t isIndex, int32_t shapeID, CGAErrorLevel level, int32_t methodId, int32_t pc, const wchar_t *message)=0

virtual double	cgaGetCoord (size_t isIndex, CoordSelector sel, double x, double y, double z, Status *stat=0)

virtual Status	cgaGetCoords (size_t isIndex, CoordSystemSelector sel, double *coords, size_t vertexCount)

virtual Status	cgaPrint (size_t isIndex, int32_t shapeID, const wchar_t *txt)=0

virtual Status	cgaReportBool (size_t isIndex, int32_t shapeID, const wchar_t *key, bool value)=0

virtual Status	cgaReportFloat (size_t isIndex, int32_t shapeID, const wchar_t *key, double value)=0

virtual Status	cgaReportString (size_t isIndex, int32_t shapeID, const wchar_t key, const wchar_t value)=0

virtual Status	generateError (size_t isIndex, Status status, const wchar_t *message)=0

virtual Continuation	progress (float percentageCompleted)

Detailed Description

Callbacks are used to return data such as errors or reports during generation, to lookup coordinates dependent on the client's coordinate system and to report progress and query for cancelation.

A client must either use one of the provided implementations (FileOutputHandler, MemoryOutputHandler) or implement this interface in order to use the generate() functions.

An instance of a Callbacks subclass is instantiated & destroyed by the client. It usually lives for a number of sequential generate() calls. All member functions must be thread-safe (can be called simultaneously by a number of internal threads). One instance of a Callbacks must not be used by more than one concurrent generate() calls.

Member Enumeration Documentation

◆ Continuation

enum prt::Callbacks::Continuation

Continuation possibilities.

Enumerator
CONTINUE	Go on.
CANCEL_AND_FINISH	Cancel generation but finish encoding the already generated models.
CANCEL_ASAP	Cancel generation and return as soon as possible, do not finalize encoding.

◆ CoordSelector

enum prt::Callbacks::CoordSelector

Geographical coordinates which might be looked up by cga.

Enumerator
PROJ_X	The x coordinate of the projected coordinate system (i.e. along cga's x axis). The unit is defined by the client's projected coordinate system.
PROJ_Y	The y coordinate of the projected coordinate system (i.e. along cga's negative z axis). The unit is defined by the client's projected coordinate system.
WGS84_LAT	The WGS84 latitude coordinates in degrees.
WGS84_LON	The WGS84 longitude coordinates in degrees.
WGS84_ALT_METER	The WGS84 altitude in meters.
LAYER_X	The layer x coordinate. Layer coordinates are not used internally by cga but some encoders might rely on this.
LAYER_Y	The layer y coordinate.
LAYER_Z	The layer z coordinate.

◆ CoordSystemSelector

enum prt::Callbacks::CoordSystemSelector

Geographical coordinate triples which might be looked up by cga or encoders.

Enumerator
PROJ	The coordinates of the projected coordinate system (i.e. along cga's x/-z/y axes).
WGS84	The WGS84 (longitude / latitude / altitude in meters) coordinates.
LAYER	The layer coordinates. Layer coordinates are not used internally by cga but some encoders might rely on this.

Member Function Documentation

◆ assetError()

virtual Status prt::Callbacks::assetError	(	size_t	isIndex,
		CGAErrorLevel	level,
		const wchar_t *	key,
		const wchar_t *	uri,
		const wchar_t *	message
	)

pure virtual

Reports to the client that one of the assets used by the rule was erroneous. Called by com.esri.prt.core.CGAErrorEncoder (potentially by any encoder).

See also: generate(), InitialShape, ResolveMap

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
level	Error/warning/info.
key	The asset's key (symbolic name) into the initial shape's ResolveMap.
uri	The asset's URI from the initial shape's ResolveMap.
message	An error message.

Returns: status.

◆ attrBool()

virtual Status prt::Callbacks::attrBool	(	size_t	isIndex,
		int32_t	shapeID,
		const wchar_t *	key,
		bool	value
	)

pure virtual

Reports the value of an evaluated attribute to the client. Called by com.esri.prt.core.AttributeEvalEncoder (potentially by any encoder).

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
shapeID	Unique shape id to identify the shape in the shape tree. See prtx::Shape.
key	The key of the attribute.
value	The evaluated value.

Returns: status.

◆ attrBoolArray()

virtual Status prt::Callbacks::attrBoolArray	(	size_t	isIndex,
		int32_t	shapeID,
		const wchar_t *	key,
		const bool *	ptr,
		size_t	size,
		size_t	nRows
	)

pure virtual

Reports the value of an evaluated attribute to the client. Called by com.esri.prt.core.AttributeEvalEncoder (potentially by any encoder).

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
shapeID	Unique shape id to identify the shape in the shape tree. See prtx::Shape.
key	The key of the attribute.
ptr	Pointer to the array.
size	Size of the array.
nRows	Number of rows in the array. This is 1 for 1d arrays. CGA arrays can actually be 2d!

Returns: status.

◆ attrFloat()

virtual Status prt::Callbacks::attrFloat	(	size_t	isIndex,
		int32_t	shapeID,
		const wchar_t *	key,
		double	value
	)

pure virtual

Reports the value of an evaluated attribute to the client. Called by com.esri.prt.core.AttributeEvalEncoder (potentially by any encoder).

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
shapeID	Unique shape id to identify the shape in the shape tree. See prtx::Shape.
key	The key of the attribute.
value	The evaluated value.

Returns: status.

◆ attrFloatArray()

virtual Status prt::Callbacks::attrFloatArray	(	size_t	isIndex,
		int32_t	shapeID,
		const wchar_t *	key,
		const double *	ptr,
		size_t	size,
		size_t	nRows
	)

pure virtual

Reports the value of an evaluated attribute to the client. Called by com.esri.prt.core.AttributeEvalEncoder (potentially by any encoder).

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
shapeID	Unique shape id to identify the shape in the shape tree. See prtx::Shape.
key	The key of the attribute.
ptr	Pointer to the array.
size	Size of the array.
nRows	Number of rows in the array. This is 1 for 1d arrays. CGA arrays can actually be 2d!

Returns: status.

◆ attrString()

virtual Status prt::Callbacks::attrString	(	size_t	isIndex,
		int32_t	shapeID,
		const wchar_t *	key,
		const wchar_t *	value
	)

pure virtual

Reports the value of an evaluated attribute to the client. Called by com.esri.prt.core.AttributeEvalEncoder (potentially by any encoder).

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
shapeID	Unique shape id to identify the shape in the shape tree. See prtx::Shape.
key	The key of the attribute.
value	The evaluated value.

Returns: status.

◆ attrStringArray()

virtual Status prt::Callbacks::attrStringArray	(	size_t	isIndex,
		int32_t	shapeID,
		const wchar_t *	key,
		const wchar_t const	ptr,
		size_t	size,
		size_t	nRows
	)

pure virtual

Reports the value of an evaluated attribute to the client. Called by com.esri.prt.core.AttributeEvalEncoder (potentially by any encoder).

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
shapeID	Unique shape id to identify the shape in the shape tree. See prtx::Shape.
key	The key of the attribute.
ptr	Pointer to the array.
size	Size of the array.
nRows	Number of rows in the array. This is 1 for 1d arrays. CGA arrays can actually be 2d!

Returns: status.

◆ cgaError()

virtual Status prt::Callbacks::cgaError	(	size_t	isIndex,
		int32_t	shapeID,
		CGAErrorLevel	level,
		int32_t	methodId,
		int32_t	pc,
		const wchar_t *	message
	)

pure virtual

Reports to the client that a runtime cga error occuried during generation of a model. Called by com.esri.prt.core.CGAErrorEncoder (potentially by any encoder).

See also: generate()

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
shapeID	Unique shape id to identify the shape in the shape tree. See prtx::Shape.
level	Error/warning/info.
methodId	CGB-internal method id in which the error occurred.
pc	SPU-internal program counter at which the error occured.
message	An error message.

Returns: status.

◆ cgaGetCoord()

virtual double prt::Callbacks::cgaGetCoord	(	size_t	isIndex,
		CoordSelector	sel,
		double	x,
		double	y,
		double	z,
		Status *	stat = `0`
	)

virtual

Function to convert world coordinates from the cga coordinate system (right handed y-up, meters) to a Cartesian scene coordinate system, geographical WGS84 coordinates or client-dependent layer coordinates.

For convenience there is a default implementation which performs a conversion from Web Mercator.

Some cga functions (getGeoCord()) rely on this. Additionally, some encoders use this functionality as well.

Parameters

	isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
	sel	Selector for the desired coordinate.
	x	X world coordinate in cga system.
	y	Y world coordinate in cga system.
	z	Z world coordinate in cga system.
[out]	stat	Optional pointer to return the status.

Returns: The desired coordinate.

◆ cgaGetCoords()

virtual Status prt::Callbacks::cgaGetCoords	(	size_t	isIndex,
		CoordSystemSelector	sel,
		double *	coords,
		size_t	vertexCount
	)

virtual

Function to convert world coordinates from the cga coordinate system (right handed y-up, meters) to a Cartesian scene coordinate system, geographical WGS84 coordinates or client-dependent layer coordinates.

This function provides an efficient interface to cgaGetCoord() for bulk conversions. Encoders might use it for batch-converting arrays of vertex coordinates.

For convenience there is a default implementation which just calls the cgaGetCoord() function in a loop.

Parameters

	isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
	sel	Selector for the desired coordinate system.
[in,out]	coords	Array of coordinates to convert. The array must contain 3*vertexCount doubles. Each triple will be converted and overwritten in-place.
	vertexCount	Number of vertices (triples) in the coords array.

Returns: status.

◆ cgaPrint()

virtual Status prt::Callbacks::cgaPrint	(	size_t	isIndex,
		int32_t	shapeID,
		const wchar_t *	txt
	)

pure virtual

Reports to the client that a cga print operation/function was called during generation of a model. Called by com.esri.prt.core.CGAPrintEncoder (potentially by any encoder).

See also: generate()

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
shapeID	Unique shape id to identify the shape in the shape tree. See prtx::Shape.
txt	The printed text.

Returns: status.

◆ cgaReportBool()

virtual Status prt::Callbacks::cgaReportBool	(	size_t	isIndex,
		int32_t	shapeID,
		const wchar_t *	key,
		bool	value
	)

pure virtual

Reports to the client that a cga report operation was called during generation of a model. Called by com.esri.prt.core.CGAReportEncoder (potentially by any encoder).

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
shapeID	Unique shape id to identify the shape in the shape tree. See prtx::Shape.
key	The key in the report operation.
value	The value in the report operation.

Returns: status.

◆ cgaReportFloat()

virtual Status prt::Callbacks::cgaReportFloat	(	size_t	isIndex,
		int32_t	shapeID,
		const wchar_t *	key,
		double	value
	)

pure virtual

Reports to the client that a cga report operation was called during generation of a model. Called by com.esri.prt.core.CGAReportEncoder (potentially by any encoder).

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
shapeID	Unique shape id to identify the shape in the shape tree. See prtx::Shape.
key	The key in the report operation.
value	The value in the report operation.

Returns: status.

◆ cgaReportString()

virtual Status prt::Callbacks::cgaReportString	(	size_t	isIndex,
		int32_t	shapeID,
		const wchar_t *	key,
		const wchar_t *	value
	)

pure virtual

Reports to the client that a cga report operation was called during generation of a model. Called by com.esri.prt.core.CGAReportEncoder (potentially by any encoder).

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
shapeID	Unique shape id to identify the shape in the shape tree. See prtx::Shape.
key	The key in the report operation.
value	The value in the report operation.

Returns: status.

◆ generateError()

virtual Status prt::Callbacks::generateError	(	size_t	isIndex,
		Status	status,
		const wchar_t *	message
	)

pure virtual

Reports to the client that an application error occurred during generation of one of the initial shapes.

Parameters

isIndex	Initial shape index (relative to the initialShapes array in the generate() call)
status	The erroneous status encountered during generation / encoding of the initial shape.
message	An error message.

Returns: client status (this value is currently ignored by PRT).

◆ progress()

virtual Continuation prt::Callbacks::progress ( float percentageCompleted )

virtual

Called during the generation() call. Called at least once for every initial shape in the generate() call. Allows the client to abort the generate process.

Parameters

percentageCompleted A value in [0, 100]

Returns: The desired way to continue.

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

Callbacks.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Continuation

◆ CoordSelector

◆ CoordSystemSelector

Member Function Documentation

◆ assetError()

◆ attrBool()

◆ attrBoolArray()

◆ attrFloat()

◆ attrFloatArray()

◆ attrString()

◆ attrStringArray()

◆ cgaError()

◆ cgaGetCoord()

◆ cgaGetCoords()

◆ cgaPrint()

◆ cgaReportBool()

◆ cgaReportFloat()

◆ cgaReportString()

◆ generateError()

◆ progress()