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

iMesh::saveGroundEx()

Description

Saves the underlying ground for this iMesh.

Syntax

void saveGroundEx(const char* format, bool includeMapping, bool includeTranslationTo2D, bool includePartitioning, 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 saved out 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.
includeTranslationTo2D Specifies whether data structures for translating between base ground triangles and the mapping to 2D should be saved out with the mesh.
When this parameter is set to true, the includeMapping parameter will also be set to true.
includePartitioning Specifies whether data structures for resolving arbitrary 3D positions should be saved out with the mesh.
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.

In many cases a mapping to 2D will be required by content features on a mesh, and the includeMapping parameter will then be forced to true, internally.

The includeTranslationTo2D and includePartitioning parameters enable mesh loading times to be traded off against larger save file sizes.
The two option can be turned on or off individually.
When either option is turned on the result mesh file will be larger but should then take less time to load back in.

See Also

Interface iOutputStream, iPathEngine::loadMeshFromBuffer(), iMesh::burnContextIntoMesh()

C# Mapping

void saveGroundEx(string format, bool includeMapping, bool includeTranslationTo2D, bool includePartitioning, OutputStream outputStream);

Java Mapping

void saveGroundEx(String format, boolean includeMapping, boolean includeTranslationTo2D, boolean includePartitioning, OutputStream outputStream);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iMesh::savePath()