PathEngine home previous: iMesh::getConnectedRegionFor()next: iMesh::getEndPoint()
Contents, API Reference, Interfaces, iMesh, getConnectedRegionForAgent

iMesh::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 collision or pathfinding preprocess has been generated on the agent's mesh for the agent's collision shape, with connected region queries enabled with the relevant collision preprocess or pathfind preprocess generation attribute.

Return Value

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

Remarks

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


Documentation for PathEngine release 5.29 - Copyright © 2002-2012 PathEnginenext: iMesh::getEndPoint()