<PathPosition> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyType » PathPosition

Function Members

Function members are as follows:

Return Type Function Name Documentation
int32AtEndTests if the <PathPosition> object is at the ending point of the Path.
int32AtStartTests if the <PathPosition> object is at the starting point of the Path.
<Vec>GetDerivativeReturns a pointer to a <Vec> object the derivative ( or orientation ) of the path segment at the current worldspace coordinate of the <PathPosition> object.
<Vec>GetPositionReturns a pointer to a <Vec> object containing the worldspace coordinates of the current <PathPosition>.
int32GetSegmentIndexReturns the index of the segment located at the current position of the <PathPosition> object.
int32ResetResets the position of the <PathPosition> object to the start of the Path.

Object Members

Object members are as follows:

Type Name Accessor Name Documentation
int32EvaluateDerivativeGets or sets a flag indicating if the <PathPosition> object should calculate the derivative of the path each time the position is updated. Derivative calculation is off by default.
int32LoopGets or sets a flag indicating if the <PathPosition> object should restart at the beginning of the path once it has reached the end.