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

iCollisionContext::getConnectedRegionFor()

Description

Returns an index for the connected region at a given position. This can be used to quickly determine the reachability between positions.

Syntax

int32_t getConnectedRegionFor(const iShape* shape, const cPosition& p) const;

Parameters

shape The agent shape for which connected region preprocess should be queried.
p The position to test.

Requirements

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 given position.

Remarks

If there is a preprocessed obstacle set included in this context then this query will effectively forward the query on to a call to iObstacleSet::getNumberOfConnectedRegions() for that obstacle set.

Otherwise the query will be forwarded on to base mesh connected region preprocess iMesh::getNumberOfConnectedRegions().

See Also

iCollisionContext::getConnectedRegionForAgent()

C# Mapping

int getConnectedRegionFor(Shape shape, PathEngine.Position p);

Java Mapping

int getConnectedRegionFor(Shape shape, Position p);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iCollisionContext::getConnectedRegionForAgent()