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

iObstacleSet::getNumberOfConnectedRegions()

Description

Returns the number of distinct regions in connected region preprocess for the specified shape.

Syntax

int32_t getNumberOfConnectedRegions(const iShape* shape) const;

Parameters

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

Requirements

Requires that this obstacle set has been marked for preprocessing.

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

Return Value

The number of connected regions.

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

C# Mapping

int getNumberOfConnectedRegions(Shape shape);

Java Mapping

int getNumberOfConnectedRegions(Shape shape);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iObstacleSet::hasRefs()