PathEngine home previous: iObstacleSet::empty()next: iObstacleSet::getConnectedRegionFor()
Contents, API Reference, Interfaces, iObstacleSet, getAgent

iObstacleSet::getAgent()

Description

Provided for iterating through the agents in the set.

Syntax

iAgent* getAgent(tSigned32 index) const;

Parameters

indexThis must be a positive integer less than the number of agents in the set.

Return Value

The agent at the specified index.

Remarks

The agent index here is only an iteration mechanism.
The order of these indices should not be assumed to coincide with the order in which agents were added, and may be different across different releases.
Also, indices should not be assumed to refer consistently to a single agent after changes to the set.

See Also

iObstacleSet::getNumberOfAgents()
Documentation for PathEngine release 5.29 - Copyright © 2002-2012 PathEnginenext: iObstacleSet::getConnectedRegionFor()