PathEngine home previous: iContentProcessing3D::loadSnapshot()next: Interface iAllocator
Contents, API Reference, Interfaces, iContentProcessing3D, saveSnapshot

iContentProcessing3D::saveSnapshot()

Description

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

Syntax

void saveSnapshot(const iFaceVertexMesh* const * meshes_Buffer, uint32_t meshes_BufferEntries, const iSolidObjects* solidObjects, int32_t extrudeHeight, int32_t maxStepHeight, int32_t maxSlope, const char *const* options, const char* format, iOutputStream& outputStream) const;

Parameters

meshes_Buffer, meshes_BufferEntries (As for iContentProcessing3D::buildAndSaveGround() or iContentProcessing3D::buildGround().)
solidObjects (As for iContentProcessing3D::buildAndSaveGround() or iContentProcessing3D::buildGround().)
extrudeHeight (As for iContentProcessing3D::buildAndSaveGround() or iContentProcessing3D::buildGround().)
maxStepHeight (As for iContentProcessing3D::buildAndSaveGround() or iContentProcessing3D::buildGround().)
maxSlope (As for iContentProcessing3D::buildAndSaveGround() or iContentProcessing3D::buildGround().)
options (As for iContentProcessing3D::buildAndSaveGround() or iContentProcessing3D::buildGround().)
format May be either "xml" or "tok", for xml and tokenised xml output, respectively.
outputStream An output stream to which the snapshot data will be sent.

Remarks

Most of parameters for this function correspond to parameters with the same names on iContentProcessing3D::buildAndSaveGround() or iContentProcessing3D::buildGround(), with a couple of additional parameters then controlling the actual generation of the resulting snapshot buffer.

In addition to serving as repeat cases for any issues with the 3D process, snapshots generated by this method can be imported into 3rd party content platforms for detailed visualisation, or loaded back in with iContentProcessing3D::loadSnapshot().

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

C# Mapping

void saveSnapshot(FaceVertexMesh[] meshes, SolidObjects solidObjects, int extrudeHeight, int maxStepHeight, int maxSlope, string[] options, string format, OutputStream outputStream);

Java Mapping

void saveSnapshot(FaceVertexMesh[] meshes, SolidObjects solidObjects, int extrudeHeight, int maxStepHeight, int maxSlope, String[] options, String format, OutputStream outputStream);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: Interface iAllocator