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

iCollisionContext::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 to be used for the query.

Requirements

Must not be called for non-moveable agents.

Requires that the collision context includes an obstacle set that is 'marked for preprocessing', or that connected region preprocess has been generated against the mesh for the query agent shape.

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 iCollisionContext::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: iCollisionContext::getNumberOfAgents()