PathEngine home previous: iMesh::saveCollisionPreprocessFor()next: iMesh::savePath()
Contents, API Reference, Interfaces, iMesh, saveGround

iMesh::saveGround()

Description

Saves the underlying ground for this iMesh.

Syntax

void saveGround(const char* format, bool includeMapping, iOutputStream* outputStream) const;

Parameters

format A C string specifying the format in which data should be output. Currently this can be "xml" or "tok" (lower case).
This format string is not retained after the call and can subsequently be safely deleted.
includeMapping Specifies whether the mapping to 2d should be recorded with the mesh.
Storing this mapping with the mesh ensures that cPositions stored for this mesh will remain valid if the PathEngine generates this mapping changes with a new release.
outputStream The mesh will be saved to this output stream.

Remarks

This method can be used to convert a mesh between formats, to add a mapping to 2d to a mesh, or to add 'base circuits' or content features such as anchors or named obstacles.
(See Representing Positions on the Ground.)

This method may not be called after iMesh::preprocessGenerationCompleted() has been called for this mesh.

See Also

Interface iOutputStream, iPathEngine::loadMeshFromBuffer(), iMesh::burnContextIntoMesh()
Documentation for PathEngine release 5.16 - Copyright © 2002-2008 PathEnginenext: iMesh::savePath()