PathEngine home previous: iObstacleSet::getConnectedRegionFor()next: iObstacleSet::getNumberOfAgents()
Contents, API Reference, Interfaces, iObstacleSet, getConnectedRegionForAgent

iObstacleSet::getConnectedRegionForAgent()

Description

Returns an index for the connected region for an agent's current position.

Syntax

tSigned32 getConnectedRegionForAgent(iAgent* agent) const;

Parameters

agent The agent to be used for the query.

Requirements

Requires that this obstacle set has been marked for preprocessing and that connected region queries have been enabled with the relevant preprocess generation attribute.

See Obstacle Management for details about setting up preprocessed obstacle sets.

Return Value

An index value for the connected region at the the agent's current position.

Remarks

This is equivalent to calling iObstacleSet::getConnectedRegionFor(), with the agent's current position and shape.


Documentation for PathEngine release 5.18 - Copyright © 2002-2008 PathEnginenext: iObstacleSet::getNumberOfAgents()