PathEngine home previous: Interface iPathnext: iPath::advanceAlongWithCollisionInfo()
Contents, API Reference, Interfaces, iPath, advanceAlong

iPath::advanceAlong()

Description

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

Syntax

bool 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

Returns true if there was a collision, otherwise false.

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.

C# Mapping

bool advanceAlong(Shape shape, float distance, CollisionContext context, out float precisionX, out float precisionY);

Java Mapping

boolean advanceAlong(Shape shape, float distance, CollisionContext context, float_OutArgument precisionX, float_OutArgument precisionY);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iPath::advanceAlongWithCollisionInfo()