connectedRegionPreprocessNeedsUpdate

Contents, API Reference, Interfaces, iObstacleSet, connectedRegionPreprocessNeedsUpdate

iObstacleSet::connectedRegionPreprocessNeedsUpdate()

Description

Checks the state of connected regions preprocess, on obstacle sets marked for connected regions preprocessing.

Syntax

bool connectedRegionPreprocessNeedsUpdate(const iShape* shape) const;

Parameters

shape

Check preprocess for this agent shape.

Requirements

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

Return Value

True if this obstacle set has been marked for connected regions preprocessing, and preprocess has not yet been generated, or is out of date following changes to the set of contained obstacles, otherwise false.

Remarks

A preprocess update can be forced by calling iObstacleSet::updateConnectedRegionPreprocessFor().

See Obstacle Management for some additional explanation about preprocessed obstacle sets.

next: iObstacleSet::empty()