constructPath_Reversed

next: iMesh::findClosestUnobstructedPosition()

Contents, API Reference, Interfaces, iMesh, constructPath_Reversed

iMesh::constructPath_Reversed()

Description

Provided to enable Interface iPath objects to be constructed directly from a sequence of positions.

Syntax

iPath* constructPath_Reversed(const cPosition* positionsBuffer, const tSigned32* connectionIndicesBuffer, tSigned32 pathLength) const;

Parameters

	positionsBuffer		A pointer to a sequence of (pathLength) positions to be used to construct the path.
	connectionIndicesBuffer		A pointer to a sequence of (pathLength - 1) connection indices, or a null pointer (indicating that the path contains no off-mesh connections).
	pathLength		The number of points in the path. Must be greater than zero.

Return Value

A newly created Interface iPath, with positions in the opposite order to the positions passed in.

Remarks

The created Interface iPath can be explicitly deleted when no longer required, but will also be deleted when this mesh is destroyed. In either case the pointer can no longer be used.