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(const iShape* shape) const;

Parameters

shape The collision shape to use for this query.

Requirements

Requires that collision or pathfinding preprocess has been generated on this mesh for the collision shape specified, with connected region queries enabled with the relevant collision preprocess or pathfind 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.29 - Copyright © 2002-2012 PathEnginenext: iMesh::getNumberOfEndPoints()