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

iMesh::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 connected region preprocess has been generated on this mesh for the collision shape specified.

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() or iCollisionContext::getNumberOfConnectedRegions() to perform the same query for static geometry together with a set of 'semi-dynamic' obstacles in a 'preprocessed obstacle set'.

C# Mapping

int getNumberOfConnectedRegions(Shape shape);

Java Mapping

int getNumberOfConnectedRegions(Shape shape);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iMesh::getNumberOfEndPoints()