PathEngine home previous: Interfacesnext: iPathEngine::buildExpanded2DObstaclesContainerMesh()
Contents, API Reference, Interfaces, iPathEngine

Interface iPathEngine

Description

The root interface to PathEngine. All functionality (apart from testbed functionality) is obtained through this interface, or through objects obtained from this interface.

Defined in SDKRoot/code/externalAPI/i_pathengine.h.

Construction and Deletion

A pointer to the iPathEngine interface is obtained by calling the entrypoint to the PathEngine dll, DLLExport_GetIPathEngine, in the case of dll linkage, or PathEngine_InitialiseAndObtainRootInterface, in the case of static or Linux shared object linkage, or is passed into a test application, in the case of an application running under the testbed.
Refer to Linking with the SDK for more details.
There is only one instance of the object that provides this interface. This object cannot be deleted so operator delete for iPathEngine has been made private.

Methods:

buildExpanded2DObstaclesContainerMesh

Helper method for building an iMesh instance that can be used for the purposes of visualising the boundaries of iExpanded2DObstacles instances.

buildMeshAroundObstructionBoundaries

A helper method for building ground mesh around a set of 2D obstruction boundaries.

buildMeshAroundTiledObstructions

A helper method for building ground mesh around a set of tiled obstructions.

buildMeshByCopyingConnectedGround

A helper method for stripping out unconnected ground mesh pieces, based on a supplied set of 'root positions'.

buildMeshFederation_FromWorldMesh

Returns a newly created Interface iMeshFederation object, and generates the corresponding set of federated iMeshes, from a single large 'world mesh'. with range determined by the range of worldMesh, and with the specified tile size, and overlap.

Federation tiles will be generated during this process and passed in to tileGeneratedCallBack.
These are numbered according to a 'tile index' within the federation, (which is passed into the callback). Note, however, that it is possible for there to be tiles within a federation with no ground geometry, and meshes will not be generated for any such tiles.

buildMeshFederation_TilingOnly

Returns a newly created Interface iMeshFederation object, to encapsulate a mesh federation tiling, but without actually generating any federated iMesh instances.

buildMeshFromContent

Constructs an iMesh object by processesing geometry specified in 'face/vertex' form.

buildMeshFromGroundTiles

Constructs a single iMesh object by connecting multiple tiled ground pieces together at tile borders.

buildRegularSourceTiling

Returns a newly created Interface iSourceTiling object that can be used to perform 'tile-by-tile' content processing.

buildRegularSourceTiling_RoundUpForVoxels

Returns a newly created Interface iSourceTiling object that can be used to perform 'tile-by-tile' content processing.

tileSize will be rounded up to a multiple of the specified voxel size, and then the world range increased as necessary to ensure that the last tile in each direction is also a multiple of this voxel size.

buildUnobstructedSpaceGround

A helper method for generating a ground mesh representation of agent unobstructed space.

connectedRegionPreprocessVersionIsCompatible

Used to check if persistent data saved out for connected region preprocess from an older version of the library can be loaded into this version.

getInterfaceMajorVersion

Returns the major version number for the code supporting this interface.

getInterfaceMinorVersion

Returns the minor version number for the code supporting this interface.

getReleaseNumbers

Returns release numbers for the code supporting this interface.

getVersionAttributes

Obtains a set of attributes for the object that provides this interface.

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.

largeStatic2DObstacleShapeIsValid

Checks whether coordinates are valid for iMesh::placeLargeStatic2DObstacle().

largeStaticObstacleShapeIsValid

Checks whether coordinates are valid for iMesh::placeLargeStaticObstacle().

loadContentChunk

Constructs an iContentChunk object from a data buffer previously saved out by iContentChunk::save().

loadExpanded2DObstacles

Constructs an iExpanded2DObstacles object from a data buffer previously saved out by iExpanded2DObstacles::save().

loadFederation

Constructs an iMeshFederation object from a data buffer previously saved out by iMeshFederation::save().

loadMeshFromBuffer

Constructs an iMesh object from a data buffer containing a 3d ground mesh.

loadSourceTiling

Constructs an iSourceTiling object from a data buffer previously saved out by iSourceTiling::save().

newContentChunk

Constructs a content chunk object which can then be saved out and later loaded for instantiation in a separate content tool.

newShape

Creates a new iShape object.

newShape_FromExpanded2DObstacles

Helper method for setting up an iShape with expansion coordinates from and expanded 2D obstacles instance.

pathfindPreprocessVersionIsCompatible

Used to check if persistent data saved out for pathfind preprocess from an older version of the library can be loaded into this version.

preExpandObstacles

Pre-expands and combines a set of convex 2D obstacles, with optional boundary optimisation.

save2DContentSnapshot

Provided for generating snapshots of the source content when reporting bugs in the content processing functionality.

saveContentData

(Depreciated)
Provided for generating snapshots of the source content when reporting bugs in the content processing functionality.

setPathPoolParameters

Controls PathEngine's path caching mechanism.

setRandomSeed

Seeds PathEngine's internal pseudo-random sequence.

shapeIsValid

Checks whether coordinates are valid for newShape().

unobstructedSpaceVersionIsCompatible

Used to check if persistent data saved out for unobstructed space from an older version of the library can be loaded into this version.


Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iPathEngine::buildExpanded2DObstaclesContainerMesh()