findPathAway_WithQueryCallBack

Contents, API Reference, Interfaces, iAgent, findPathAway_WithQueryCallBack

iAgent::findPathAway_WithQueryCallBack()

Description

Finds the shortest path of escape from a specified region for the agent.
(This version supports passing in a callback object to enable the query to be aborted early.)

Syntax

iPath* findPathAway_WithQueryCallBack(const iCollisionContext* context, const cPosition& awayFrom, tSigned32 distanceAway, iQueryCallBack* queryCallBack) const;

Parameters

	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. Note that the agent is not considered to obstruct itself even if included in this context.
	awayFrom		A position defining the centre of a region to escape from. This position must be a valid position on this mesh.
	distanceAway		Controls the size of the region to escape from, see below.
	queryCallBack		A pointer to a valid implementation of the iQueryCallBack interface, or else null.

Requirements

Requires that the agent is moveable and that pathfinding preprocess has been generated on the agent's mesh for the agent's collision shape.

The agent must be currently placed at a position that is unobstructed according to the specified context.

Return Value

If pathfinding succeeds than a newly created Interface iPath object is returned.
If pathfinding fails then a null pointer is be returned.

Remarks

Calling this method is functionally equivalent to calling iAgent::findPathAway_WithQueryCallBack(), with null for the callback parameter.

next: iAgent::findShortestPathTo()