PathEngine home previous: iMesh::retrieveNamedObstacle()next: iMesh::reversePath()
Contents, API Reference, Interfaces, iMesh, retrieveNamedObstacleByIndex

iMesh::retrieveNamedObstacleByIndex()

Description

Used for iterating through fixed obstacles.

Syntax

void retrieveNamedObstacleByIndex(int32_t index, iAgent*& agent, const char*& id) const;

Parameters

index Enumerating index.
agent This returns a pointer to a newly constructed agent encapsulating the fixed obstacle.
id This will be set to a pointer to a C string containing the obstacle's content ID.
The string pointed to may be invalidated if changes are subsequently made to the set of fixed obstacles stored.

Remarks

Retrieving a fixed obstacle does not remove the fixed obstacle from the set of fixed obstacles stored with a mesh.

See Also

iMesh::storeNamedObstacle(), iMesh::getNumberOfNamedObstacles()

C# Mapping

void retrieveNamedObstacleByIndex(int index, out Agent agent, out string id);

Java Mapping

void retrieveNamedObstacleByIndex(int index, Object_OutArgument agent, Object_OutArgument id);

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