PathEngine home previous: iPathEngine::loadContentChunk()next: iPathEngine::loadMeshFromBuffer()
Contents, API Reference, Interfaces, iPathEngine, loadFederation

iPathEngine::loadFederation()

Description

Constructs an iMeshFederation object from a data buffer previously saved out by iMeshFederation::save().

Syntax

iMeshFederation* loadFederation(const char* format, const char* dataBuffer, tUnsigned32 bufferSize);

Parameters

format A C string specifying the format of the data in the buffer. Currently this can be "xml" or "tok" (lower case).
The format string pointer is not retained after the call and can subsequently be safely deleted.
dataBufferA byte buffer. This buffer is not retained after the call and can subsequently be safely deleted.
bufferSizeThe size of the buffer pointed to by dataBuffer, in bytes.

Return Value

A newly created Interface iMeshFederation object, constructed from the persistent data passed in.

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.

See Also

iPathEngine::buildMeshFederation_FromWorldMesh()
Documentation for PathEngine release 5.17 - Copyright © 2002-2008 PathEnginenext: iPathEngine::loadMeshFromBuffer()