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

int32_t getConnectedRegionForAgent(iAgent* agent) const;

Parameters

agent The agent shape for which connected region preprocess should be queried.

Requirements

Must not be called for non-moveable agents.

Requires that this obstacle set has been marked for preprocessing, with connected region queries support.

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.

C# Mapping

int getConnectedRegionForAgent(Agent agent);

Java Mapping

int getConnectedRegionForAgent(Agent agent);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iObstacleSet::getNumberOfAgents()