iMeshFederation

previous: iContentChunkInstance::release()

next: iMeshFederation::addConstExternalRef()

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/code/externalAPI/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 released explicitly by calling delete on the pointer or by calling the object's release() function. A pointer to an iMeshFederation object must not be used after the object has been deleted.

Methods:

addConstExternalRef		Increments the internal reference count for this API object.
addExternalRef		Increments the internal reference count for this API object.
build2DTileMesh		Generates an iMesh object with simple 2D square bounds for the specified tile in this federation.
build2DTileMeshWithGround		Generates an iMesh object with simple 2D square bounds for the specified tile in this federation (instanced ground version).
build2DTiledGround		Generates an iMesh object with simple 2D square bounds for the specified tile in this federation.
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.
buildTileMeshFromLocalGroundTiles_IGround		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.
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().
getRepresentedRegionOverlappedRange		Queries the set of tile represented regions overlapped by the specific horizontal region.
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.
getSourceTileForPosition		Looks up the source tile index for a position in a mesh federation.
getTileCentre		Queries the tile centre, or origin, for a specified tile in this federation.
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 its release method.
release		Releases the API object pointer.
save		Saves the mesh federation object to persistent storage.
size		Returns the number of meshes in this federation.
tileForQueryCentre		Looks up the tile in this federation to use for a given query, based on horizontal coordinates for the centre of the query range.
tileForQueryRange		Looks up the tile in this federation to use for a given query, based on specified horizontal query range.
tilesInX		Returns the number of tiles across the federation, in the x direction.
tilesInY		Returns the number of tiles in the federation, in the y direction.
translatePosition		Translates positions between the overlapping sections of adjacent meshes in this federation.
translatePositionFromSourceTile		Translates a position from the source tiling used to construct the federation to a federation tile mesh.
translatePositionToSourceTile		Translates a position in a federation tile mesh back to the source tiling used to construct the federation.

next: iMeshFederation::addConstExternalRef()