advanceAlong

Contents, API Reference, Interfaces, iPath, advanceAlong

iPath::advanceAlong()

Description

Provides the same functionality as iAgent::advanceAlongPathWithPrecision(), but without requiring creation of an iAgent.

Syntax

iCollisionInfo* advanceAlong(const iShape* shape, float distance, const iCollisionContext* context, float& precisionX, float& precisionY);

Parameters

	shape		The shape to use for checking collision. This should normally be the same shape that was used to create this path.
	distance		The distance to advance along the path.
	context		The state of dynamic collision that will apply for this query. An empty context can be specified by passing a value of zero for this argument.
	precisionX		Extra precision for the x component of the path start is returned in this parameter.
	precisionY		Extra precision for the y component of the path start is returned in this parameter.

Return Value

If the shape is successfully advanced along the path then zero is returned.
Otherwise a newly created Interface iCollisionInfo object is returned with information about the collision preventing the movement.

Remarks

Unless you have a specific reason for using this version of the advance along path functionality, the versions provided by the Interface iAgent interface should be preferred.

Refer to Advancing Along Paths for general information about PathEngine's built-in advance along path functionality.

next: iPath::connectionIndex()