PathEngine home previous: iObstacleSet::loadPathfindPreprocessFor()next: iObstacleSet::refAgent()
Contents, API Reference, Interfaces, iObstacleSet, pathfindPreprocessNeedsUpdate

iObstacleSet::pathfindPreprocessNeedsUpdate()

Description

Checks the validity of preprocess, on obstacle sets marked for preprocessing.

Syntax

bool pathfindPreprocessNeedsUpdate(const iShape* shape) const;

Parameters

shape Check preprocess for this agent shape.

Requirements

Unobstructed space 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 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::updatePathfindPreprocessFor().

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

C# Mapping

bool pathfindPreprocessNeedsUpdate(Shape shape);

Java Mapping

boolean pathfindPreprocessNeedsUpdate(Shape shape);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iObstacleSet::refAgent()