PathEngine home previous: PathEngine_ShutDownnext: Interfaces
Contents, API Reference, Functions, Save3DContentSnapshot

Save3DContentSnapshot

Description

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

The 3D content processing is not included in the run-time PathEngine dll.
In order to call this method it is necessary to link directly against the Content_Processing_3D static library (as well as other dependant static libraries).

The function definition can be found in 'SDKRoot/code/libs/Content_Processing_3D/interface/Save3DContentSnapshot.h'.

Syntax

void
Save3DContentSnapshot(
        const iFaceVertexMesh *const * meshObjectPointers,
        tSigned32 numberOfMeshObjects,
        const iSolidObjects* solidObjects,
        tSigned32 extrudeHeight,
        tSigned32 maxStepHeight,
        tSigned32 maxSlope,
        const char *const* options,
        const char* format,
        iOutputStream* os
        );

Parameters

meshObjectPointers Points to an array of pointers to objects derived from iFaceVertexMesh and specifying mesh components of the 3D 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.
numberOfMeshObjects The size of the array pointed to by geometryObjectPointers.
solidObjects Pointer to an object derived from the iSolidObjects interface class, to encapsulate a set of convex solid objects in the form of a series of 'point clouds'.
The 3D content processing will generate a convex hull for each of these point clouds, and treat the contained volume as an obstructed solid.
Refer to Input Representation for more information about this solid objects representation.
A null pointer may be passed into this argument, in the case where there are no solid objects in the source data.
extrudeHeight Set to the maximum height of the agents for which pathfinding ground mesh is to be generated.
maxStepHeight Specifies the maximum height for which the 3D content processing should connect across vertical discontinuities in the resulting ground.
maxSlope The maximum slope for walkable ground, represented as a slope percentage.
Ground rising more than maxSlope units for every 100 units travelled horizontally will be stripped out of the resulting ground.
options A set of named attributes to control additional options for how the geometry is processed,
format May be either "xml" or "tok", for xml and tokenised xml output, respectively.
os An output stream to which the saved data will be sent.

Remarks

Refer to 3D Content Processing for a general explanation of the 3D content processing functionality.


Documentation for PathEngine release 5.16 - Copyright © 2002-2008 PathEnginenext: Interfaces