loadPath

previous: iMesh::loadCollisionPreprocessFor()

next: iMesh::loadPathfindPreprocessFor()

Contents, API Reference, Interfaces, iMesh, loadPath

iMesh::loadPath()

Description

Loads internal data relating to a path from persistent storage.

Syntax

iPath* loadPath(const char* dataBuffer, tUnsigned32 bufferSize) const;

Parameters

	dataBuffer		A byte buffer. This buffer is not retained after the call and can subsequently be safely deleted.
	bufferSize		The size of the buffer pointed to by dataBuffer, in bytes.

Requirements

The ground mesh and base circuits must be identical to the mesh on which the was originally generated.

Return Value

The loaded path.

Remarks

Use this method in conjunction with iMesh::savePath() to save and load paths to and from persistent storage.

The buffer passed in must contain data previously saved out by iMesh::savePath().

Note that an empty buffer can result from calling iMesh::savePath() with a null pointer.
loadPath() recognises this special case and returns a null pointer.

next: iMesh::loadPathfindPreprocessFor()