PathEngine home previous: iMesh::getNumberOfBurntInObstacles()next: iMesh::getNumberOfEndPoints()
Contents, API Reference, Interfaces, iMesh, getNumberOfConnectedRegions

iMesh::getNumberOfConnectedRegions()

Description

Returns the number of distinct connected regions in the unobstructed space for a given shape.

Syntax

tSigned32 getNumberOfConnectedRegions(iShape* shape) const;

Parameters

shape The collision shape to use for this query.

Requirements

Requires that pathfinding preprocess has been generated on this mesh for the collision shape specified, and that connected region queries have been enabled with the relevant preprocess generation attribute.

Return Value

The number of connected regions, in unobstructed space for the given agent shape, on this mesh.

Remarks

This method queries against the static geometry on this mesh (i.e. external edges and burnt in obstacles).
Use iObstacleSet::getNumberOfConnectedRegions() to perform the same query for static geometry together with a set of 'semi-dynamic' obstacles in a 'preprocessed obstacle set'.


Documentation for PathEngine release 5.17 - Copyright © 2002-2008 PathEnginenext: iMesh::getNumberOfEndPoints()