PathEngine home previous: iPath::getPositionArray()next: iPath::renderOnGround()
Contents, API Reference, Interfaces, iPath, position

iPath::position()

Description

Returns a position in the path at a specified index.

Syntax

cPosition position(tSigned32 pointIndex) const;

Parameters

pointIndex The index for the position to retrieve. This must be positive and less than the number of positions in the path.

Return Value

A cPosition for specified index.

Remarks

If more than a few points in the path are required, and speed is important, use iPath::getPositionArray().

Documentation for PathEngine release 5.16 - Copyright © 2002-2008 PathEnginenext: iPath::renderOnGround()