PathEngine home previous: iCollisionContext::getNumberOfObstacleSets()next: iCollisionContext::getOverlayConnectionPenalty()
Contents, API Reference, Interfaces, iCollisionContext, getObstacleSet

iCollisionContext::getObstacleSet()

Description

Helper method for iterating through obstacle sets in a context.

Syntax

std::unique_ptr<iObstacleSet> getObstacleSet(int32_t index) const

Parameters

indexThis must be a positive integer less than the number of obstacle sets added to this context.

Return Value

The obstacle set at the specified index.

Remarks

The index is only an iteration mechanism.
The order of these indices should not be assumed to coincide with the order in which obstruction sets were added, and may be different across different releases.
Also, indices should not be assumed to refer consistently to a single obstruction set after changes to the context.

See Also

iCollisionContext::getNumberOfObstacleSets()

C# Mapping

ObstacleSet getObstacleSet(int index);

Java Mapping

ObstacleSet getObstacleSet(int index);

Documentation for PathEngine release 6.04 - Copyright © 2002-2024 PathEnginenext: iCollisionContext::getOverlayConnectionPenalty()