PathEngine home previous: iMesh::getAllAgentsOverlapped()next: iMesh::getBurntInObstacleVertex()
Contents, API Reference, Interfaces, iMesh, getBurntInObstacleRoot

iMesh::getBurntInObstacleRoot()

Description

Returns the root position for the specified burnt in obstacle.

Syntax

cPosition getBurntInObstacleRoot(tSigned32 index) const;

Parameters

index This must be a positive integer less than the value returned by iMesh::getNumberOfBurntInObstacles().

Return Value

A cPosition inside the base obstacle shape, and rooting the obstacle to local ground mesh.

Remarks

The obstacle index supplied here is only an iteration mechanism - no persistent mapping between indices and obstacles should be assumed.

Documentation for PathEngine release 5.18 - Copyright © 2002-2008 PathEnginenext: iMesh::getBurntInObstacleVertex()