PathEngine home previous: iObstacleSet::updateConnectedRegionPreprocessFor()next: Interface iPath
Contents, API Reference, Interfaces, iObstacleSet, updatePathfindPreprocessFor



Enables the application to force generation of pathfind preprocess associated with the obstacle set, for preprocessed obstacle sets.


void updatePathfindPreprocessFor(const iShape* shape) const;


shapeThe shape for which pathfind preprocess should be generated.


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


This method is currently only relevant for obstacle sets marked for 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.

C# Mapping

void updatePathfindPreprocessFor(Shape shape);

Java Mapping

void updatePathfindPreprocessFor(Shape shape);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: Interface iPath