PathEngine home previous: iObstacleSet::getNumberOfAgents()next: iObstacleSet::includes()
Contents, API Reference, Interfaces, iObstacleSet, getNumberOfConnectedRegions

iObstacleSet::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 this obstacle set has been marked for preprocessing and that connected region queries have been enabled with the relevant preprocess generation attribute.

See Obstacle Management for details about setting up preprocessed obstacle sets.

Return Value

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

Remarks

This method enables you to query against the set of 'semi-dynamic' obstacles in a 'preprocessed obstacle set', in addition to static geometry.
For queries against just the static geometry on this mesh (i.e. external edges and burnt in obstacles), use iMesh::getNumberOfConnectedRegions().


Documentation for PathEngine release 5.18 - Copyright © 2002-2008 PathEnginenext: iObstacleSet::includes()