buildMeshFromContent

previous: iPathEngine::buildMeshFederation_TilingOnly()

next: iPathEngine::buildMeshFromGroundTiles()

Contents, API Reference, Interfaces, iPathEngine, buildMeshFromContent

iPathEngine::buildMeshFromContent()

Description

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

Syntax

iMesh* buildMeshFromContent(const iFaceVertexMesh* const* geometryObjectPointers, tSigned32 numberOfGeometryObjects, const char *const* options);

Parameters

geometryObjectPointers

An array of pointers to objects derived from iFaceVertexMesh and specifying the geometry to be processed. The objects pointed to will not be deleted by PathEngine and pointers to these objects are not held after this method completes.

numberOfGeometryObjects

The size of the array pointed to by geometryObjectPointers.

options

A set of named attributes to control how the geometry is processed.
Refer to Handling Attributes for information about passing sets of named attributes, and 2D Content Processing Options for information about the set of options that may be passed in to control geometry processing.

Note that some mesh loading options may also be passed into this method, to affect the final ground mesh construction phase.

Return Value

If the content processing completes without error then a newly created Interface iMesh object is returned.
In general PathEngine will attempt to recover from errors and return a valid mesh (e.g. by skipping failed portal connections, and so on) but in the case of some validation errors the process will fail and then a zero pointer will be returned.

Remarks

Refer to 2D Content Processing for information about the PathEngine 2D content processing functionality.

The created Interface iMesh can be explicitly deleted when no longer required, but will also be deleted if iPathEngine::deleteAllObjects() is called - in either case the pointer can no longer be used. Any meshes not deleted will be cleaned up automatically when PathEngine is shut down.