save2DContentSnapshot

Contents, API Reference, Interfaces, iPathEngine, save2DContentSnapshot

iPathEngine::save2DContentSnapshot()

Description

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

Syntax

void save2DContentSnapshot(const iFaceVertexMesh* const * meshes_Buffer, uint32_t meshes_BufferEntries, const char *const* options, const char* format, iOutputStream& os);

Parameters

	meshes_Buffer, meshes_BufferEntries		(See Passing Arrays.) 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.
	options		The same set of options as passed into iPathEngine::buildMeshFromContent(). (These will then be saved out as part of the snapshot, and ensure that any issues with the content process can be repeated exactly.)
	format		A C string specifying the format in which data should be output. Currently this can be "xml" or "tok" (lower case). This format string is not retained after the call and can subsequently be safely deleted.
	os		The content snapshot will be saved to this output stream.

Remarks

In the case of crash bugs a call to this method should be inserted directly before the call to iPathEngine::buildMeshFromContent().

To avoid issues with truncated snapshots it's important to make sure any buffers for the output stream are flushed to disk directly after the call (and before any crash), e.g. by putting a scope block around any stream objects and the call to this method, as follows:

{
        cFileOutputStream fos("contentSnapshot.tok");
        pathEngine->saveContentData(&groundParts.front(), groundParts.size(), "tok", &fos);
    }
    iMesh* mesh = pathEngine->buildMeshFromContent(&groundParts.front(), groundParts.size(), 0);

C# Mapping

void save2DContentSnapshot(FaceVertexMesh[] meshes, string[] options, string format, OutputStream os);

Java Mapping

void save2DContentSnapshot(FaceVertexMesh[] meshes, String[] options, String format, OutputStream os);

next: iPathEngine::saveContentData()