save

Contents, API Reference, Interfaces, iGround, save

iGround::save()

Description

Saves part or all of the information in a ground object to persistence.

Syntax

void save(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 ground. Storing this mapping with the mesh ensures that cPositions stored for this ground will remain valid if the way 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 ground. 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 ground.
	outputStream		The ground will be saved to this output stream.

Remarks

The includeTranslationTo2D and includePartitioning parameters enable mesh loading times to be traded off against larger save file sizes.
The two options 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.

C# Mapping

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

Java Mapping

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

next: Interface iMesh