PathEngine home previous: iObstacleSet::getAgent()next: iObstacleSet::getConnectedRegionForAgent()
Contents, API Reference, Interfaces, iObstacleSet, getConnectedRegionFor

iObstacleSet::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

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

Parameters

shape The agent shape for which connected region preprocess should be queried.
p The position to test.

Requirements

Requires that this obstacle set has been marked for preprocessing, with connected region queries support.

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

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

See Also

iObstacleSet::getConnectedRegionForAgent()

C# Mapping

int getConnectedRegionFor(Shape shape, PathEngine.Position p);

Java Mapping

int getConnectedRegionFor(Shape shape, Position p);

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