buildMeshFederation

previous: iPathEngine::buildMeshFederation_FromWorldMesh()

next: iPathEngine::buildMeshFromContent()

Contents, API Reference, Interfaces, iPathEngine, buildMeshFederation_TilingOnly

iPathEngine::buildMeshFederation_TilingOnly()

Description

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

Syntax

iMeshFederation* buildMeshFederation_TilingOnly(const cHorizontalRange& worldRange, tSigned32 tileSize, tSigned32 overlap);

Parameters

	worldRange		The minimum and maximum X and Y coordinates for world geometry covered by the federation.
	tileSize		The size of the base tiling for the 'handled regions' of tiles in the federation. A smaller value will result in more tiles being generated. Must be greater than zero.
	overlap		The overlap between the 'representation regions' of the tiles in the federation. This won't affect the number of tiles generated, but determines a 'maximum guaranteed query distance' constraint on pathfinding across the federation. Larger values for this overlap parameter enable queries to be supported across greater distances but at the cost of larger meshes for each tile. Must be greater than zero.

Return Value

A newly created Interface iMeshFederation object, to encapsulate the tiling specified.

Remarks

The created Interface iMeshFederation should be explicitly deleted when no longer required, and will also be deleted if iPathEngine::deleteAllObjects() is called - in either case the pointer can no longer be used.

After creating an 'empty' mesh federation object with this method, the actual iMesh instances for the federation can be generated with iMeshFederation::buildTileMeshFromContent().

Mesh federation and tile mesh objects will usually be constructed during content generation time, and the resulting objects then saved out and reloaded at run-time.

next: iPathEngine::buildMeshFromContent()