PathEngine home previous: iCollisionContext::updateCollisionPreprocessFor()next: Interface iObstacleSet
Contents, API Reference, Interfaces, iCollisionContext, updatePathfindingPreprocessFor

iCollisionContext::updatePathfindingPreprocessFor()

Description

Enables the application to force generation of pathfinding preprocess associated with the collision context.

Syntax

void updatePathfindingPreprocessFor(const iShape* shape) const;

Parameters

shapeThe shape for which pathfinding preprocess should be generated.

Requirements

Pathfinding preprocess must have been generated for the shape on the mesh for which this collision context was created.

Remarks

A collision context contains preprocess relating to the set of obstacles in the context.
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 the queries if desired.

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

C# Mapping

void updatePathfindingPreprocessFor(Shape shape);

Java Mapping

void updatePathfindingPreprocessFor(Shape shape);

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