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

iMesh::retrieveNamedObstacle()

Description

Construct an agent from obstacle information stored with the mesh.

Syntax

iAgent* retrieveNamedObstacle(const char* id) const;

Parameters

id Content ID for the fixed obstacle to retrieve.
This pointer is not retained after the method exits and may subsequently be safely deleted.

Return Value

A newly constructed agent encapsulating the fixed obstacle.

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()

C# Mapping

Agent retrieveNamedObstacle(string id);

Java Mapping

Agent retrieveNamedObstacle(String id);

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