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, or an explicitly invalid position (position with cell set to -1) in the case of a 2D obstacle.

Syntax

cPosition getBurntInObstacleRoot(int32_t 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.

C# Mapping

PathEngine.Position getBurntInObstacleRoot(int index);

Java Mapping

Position getBurntInObstacleRoot(int index);

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