PathEngine home previous: iContentChunkInstance::numberOfConnectingEdges()next: iMeshFederation::buildTileMeshFromContent()
Contents, API Reference, Interfaces, iMeshFederation

Interface iMeshFederation

Description

Encapsulates the tiling for a 'federation' of overlapping tiled iMesh instances, and manages transitions between meshes for agents moving across the federation.
(Enables pathfinding to be applied, seamlessly, over very large worlds.)

Refer to Mesh Federations for an overview of PathEngine's support for distributing pathfinding across a 'mesh federation'.

This interface is defined in SDKRoot/include/i_pathengine.h.

Construction and Deletion

iMeshFederation objects can be constructed with iPathEngine::buildMeshFederation_FromWorldMesh(), iPathEngine::buildMeshFederation_TilingOnly() or iPathEngine::loadFederation().
iMeshFederation objects can be deleted explicitly by calling delete on the pointer or by calling the object's destroy() function. All iMeshFederation objects are deleted by a call to iPathEngine::deleteAllObjects().
A pointer to an iMeshFederation object must not be used after the object has been deleted.

Any iMeshFederation objects not deleted get cleaned up automatically when PathEngine is shut down.

Methods:

buildTileMeshFromContent

Generates an iMesh object for the specified tile in this federation, from local 2D content processing source data.

buildTileMeshFromLocalGroundTiles

Generates an iMesh object for the specified tile in this federation, from local ground mesh tiles.

coordinatesAreInsideRange

Checks whether a given point is inside the range of this federation.

getGroundTilesOverlapped

Returns the set of ground tiles overlapped by the represented region for a given federation tile.

getHandledRegion_Local

Queries the 'handled region' for a specified tile in this federation.

getHandledRegion_World

Queries the 'handled region' for a specified tile in this federation.

getNumberOfGroundTilesOverlapped

Returns the number of ground tiles overlapped by the represented region for a given federation tile.

getNumberOfRepresentedRegionsOverlapped

Can be used to obtain the size requirement for the output data of iMeshFederation::getRepresentedRegionsOverlapped().

getRepresentedRegion_Local

Queries the 'represented region' for a specified tile in this federation.

getRepresentedRegion_World

Queries the 'represented region' for a specified tile in this federation.

getRepresentedRegionsOverlapped

Queries the set of tile represented regions overlapped by the specific horizontal region.

getTileCentre

Queries the tile centre, or origin, for a specified tile in this federation.

save

Saves the mesh federation object to persistent storage.

size

Returns the number of meshes in this federation.

tileForQuery

Looks up the tile in this federation to use for a given query, based on horizontal coordinates for the query 'start point'.

translatePosition

Translates positions between the overlapping sections of adjacent meshes in this federation.


Documentation for PathEngine release 5.34 - Copyright © 2002-2014 PathEnginenext: iMeshFederation::buildTileMeshFromContent()