PathEngine home previous: iPath::size()next: iExpanded2DObstacles::addExternalRef()
Contents, API Reference, Interfaces, iExpanded2DObstacles

Interface iExpanded2DObstacles

Description

A chunk of combined and preexpanded 2D obstacles that can later be included in mesh unobstructed space in certain, fairly specific, content flows.

This interface is defined in SDKRoot/code/externalAPI/i_pathengine.h.

This class can be used, together, with iMesh::generateUnobstructedSpaceFor_WithPreExpanded(), to support situations where there are very large numbers of obstacles, and it is desirable to cache combined and expanded chunks of obstacles, notably with the possibility to perform edge optimisations on the combined boundaries before the obstacles are added to mesh unosbtructed space.

Methods:

addExternalRef

Increments the internal reference count for this API object.

getExpandShapeCoords

Returns coordinates for the expand shape that was used to generate this object.

hasRefs

Enables you to check whether there are any outstanding references on this object, other than the interface reference through which you are calling, and therefore whether this object will actually be deleted if you call it's release method.

release

Releases the API object pointer.

render

A helper method for drawing the expanded and combined boundaries.

save

Saves the expanded obstacles to persistent storage.


Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iExpanded2DObstacles::addExternalRef()