iObstacleSet::updateConnectedRegionPreprocessFor()

Description

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

Syntax

void updateConnectedRegionPreprocessFor(const 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

This method is currently only relevant for obstacle sets marked for connected regions or pathfind preprocess generation on creation. (See Obstacle Management.)
Connected regions specific preprocess is not currently cached for other obstacle sets.

The preprocess updated by this query is normally updated automatically, if required, when the relevant query is dispatched. But there can be a 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, if this is desired.

Note that, if the obstacle set is marked for full (pathfind) preprocessing, then this method will actually currently trigger a full pathfind preprocess update.
(The method is really intended for updating preprocess when the 'markForPreprocessing_ConnectedRegionsOnly' creation attribute is supplied.)

See Also