getConnectedRegionFor

next: iMesh::getConnectedRegionForAgent()

Contents, API Reference, Interfaces, iMesh, getConnectedRegionFor

iMesh::getConnectedRegionFor()

Description

Returns an index for the connected region at a given position. This can be used to quickly determine the reachability between positions.

Syntax

tSigned32 getConnectedRegionFor(const iShape* shape, const cPosition& p) const;

Parameters

	shape		The collision shape to use for this query.
	p		The position to test.

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

An index value for the connected region at the given position.

Remarks

A position is reachable from another position if both positions are unobstructed and this query returns the same connected region indices for both positions.

If called with an obstructed position, this method will return -1.

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