PathEngine home previous: iMesh::loadPathfindPreprocessFor()next: iMesh::newContext()
Contents, API Reference, Interfaces, iMesh, loadUnobstructedSpaceFor

iMesh::loadUnobstructedSpaceFor()

Description

Loads unobstructed space from persistent storage.

Syntax

void loadUnobstructedSpaceFor(const iShape* shape, char const * data_Buffer, uint32_t data_BufferEntries);

Parameters

shape The shape for which preprocess should be loaded.
data_Buffer, data_BufferEntries (See Passing Arrays.) The data buffer to load from.

Requirements

Unobstructed space must not already be present for this shape on this mesh.

The ground mesh and base circuits must be identical to the mesh for which the preprocess was originally saved.
The shape must be identical to the shape for which the preprocess was originally saved.

Remarks

The buffer passed in must contain data previously saved out by iMesh::saveUnobstructedSpaceFor().

This method can be called where you would previously have called iMesh::generateUnobstructedSpaceFor(), to save time generating preprocess.

The structure of PathEngine's unobstructed space preproces may be changed between releases.
iPathEngine::unobstructedSpaceVersionIsCompatible() can be used to check whether preprocess saved out of an older release can be loaded into the current release.

C# Mapping

void loadUnobstructedSpaceFor(Shape shape, byte[] data);

Java Mapping

void loadUnobstructedSpaceFor(Shape shape, byte[] data);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iMesh::newContext()