PathEngine home previous: iCollisionContext::getNumberOfAgents()next: iCollisionContext::getNumberOfObstacleSets()
Contents, API Reference, Interfaces, iCollisionContext, getNumberOfConnectedRegions

iCollisionContext::getNumberOfConnectedRegions()

Description

Returns the number of connected regions in connected region preprocess associated with this object.

Syntax

int32_t getNumberOfConnectedRegions(const iShape* shape) const;

Parameters

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

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

The number of connected regions.

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().

C# Mapping

int getNumberOfConnectedRegions(Shape shape);

Java Mapping

int getNumberOfConnectedRegions(Shape shape);

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