saveSnapshot

previous: iContentProcessing3D::loadSnapshot()

Contents, API Reference, Interfaces, iContentProcessing3D, saveSnapshot

iContentProcessing3D::saveSnapshot()

Description

Provided for generating snapshots of the 3D source data when reporting bugs in the 3D content processing functionality.

Syntax

void saveSnapshot(
            const iFaceVertexMesh *const * meshObjectPointers,
            tSigned32 numberOfMeshObjects,
            const iSolidObjects* solidObjects,
            tSigned32 extrudeHeight,
            tSigned32 maxStepHeight,
            tSigned32 maxSlope,
            const char *const* options,
            const char* format, iOutputStream* outputStream
            ) const;

Parameters

	meshObjectPointers		Points to an array of pointers to objects derived from iFaceVertexMesh and specifying mesh components of the 3D geometry to be processed. The objects pointed to will not be deleted by PathEngine and pointers to these objects are not held after this method completes.
	numberOfMeshObjects		The size of the array pointed to by geometryObjectPointers.
	solidObjects		Pointer to an object derived from the iSolidObjects interface class, to encapsulate a set of convex solid objects in the form of a series of 'point clouds'. The 3D content processing will generate a convex hull for each of these point clouds, and treat the contained volume as an obstructed solid. Refer to Input Representation for more information about this solid objects representation. A null pointer may be passed into this argument, in the case where there are no solid objects in the source data.
	extrudeHeight		See 3D Content Processing Parameters.
	maxStepHeight		See 3D Content Processing Parameters.
	maxSlope		See 3D Content Processing Parameters.
	options		A set of named attributes to control additional options for how the geometry is processed,
	format		May be either "xml" or "tok", for xml and tokenised xml output, respectively.
	os		An output stream to which the saved data will be sent.

Remarks

Most of parameters for this function correspond to parameters with the same names on iContentProcessing3D::buildAndSaveGround() or iContentProcessing3D::buildGround(), with a couple of additional parameters then controlling the actual generation of the resulting snapshot buffer.

In addition to serving as repeat cases for any issues with the 3D process, snapshots generated by this method can be imported into 3rd party content platforms for detailed visualisation, or loaded back in with iContentProcessing3D::loadSnapshot().

Refer to 3D Content Processing for a general explanation of the 3D content processing functionality.

next: Interface iAllocator