PathEngine home previous: iMesh::storeAnchor()next: iMesh::testLineCollision()
Contents, API Reference, Interfaces, iMesh, storeNamedObstacle

iMesh::storeNamedObstacle()

Description

Intended for use when building content. Places an obstacle that can later be retrieved as an agent.

Syntax

void storeNamedObstacle(const char* id, iAgent* agent);

Parameters

id A unique ID for the obstacle.
This pointer is not retained after the method exits and may subsequently be safely deleted.
agent An agent encapsulating the obstacle to be stored.

Remarks

The relevant information is extracted from the agent, so the agent can subsequently be deleted with no problem.
This also means that subsequent changes to the agent do not affect the stored information.

Note that this method is provided simply as a way of attaching information about content placement to a ground mesh.
Fixed obstacles that are attached to a mesh do not have any effect on collision or pathfinding queries unless those obstacles are manually retrieved and added to a collision context.

See Also

iMesh::retrieveNamedObstacle(), iMesh::getNumberOfNamedObstacles(), iMesh::retrieveNamedObstacleByIndex(), iMesh::clearAllNamedObstacles()

C# Mapping

void storeNamedObstacle(string id, Agent agent);

Java Mapping

void storeNamedObstacle(String id, Agent agent);

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