iObstacleSet::updateCollisionPreprocessFor()

Description

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

Syntax

void updateCollisionPreprocessFor(iShape* shape) const;

Parameters

Requirements

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

Remarks

An obstacle set contains preprocess relating to the contained obstacles.
This preprocess is automatically updated when required by a pathfinding or collision query.
There is some 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 if desired.

Note that this preprocess is partially invalidated when the set of agents changes or when agents in the set are moved.
It is inefficient to update this preprocess if it will subsequently be invalidated before being used in any queries.

See Also