iObstacleSet::updatePathfindingPreprocessFor()

Description

Enables the application to force generation of any pathfinding preprocess associated with the obstacle set.

Syntax

void updatePathfindingPreprocessFor(const iShape* shape) const;

Parameters

Requirements

Pathfind preprocess must have been generated for the shape on the mesh for which this obstacle set was created.

Remarks

This method is currently only relevant for obstacle sets marked for full preprocess generation on creation. (See Obstacle Management.)
No pathfind preprocess is currently cached for other obstacle sets.

Obstacle sets marked for preprocess contain preprocess relating to the contained obstacles.
This preprocess is automatically updated when required by a pathfinding or collision query.
But there is a potentially very significant cost for generating this preprocess, so this call enables the client application to force the preprocess to be updated in advance of queries requiring the preprocess.

Because pathfinding preprocess is much more expensive to generate then collision preprocess, manual management of obstacle set preprocess updates is expected to be the most common case.

See Also