PathEngine home previous: iMesh::generateCurvedPath_WithEndVector()next: iMesh::generatePathfindPreprocessFor()
Contents, API Reference, Interfaces, iMesh, generatePathfindPreprocess6For

iMesh::generatePathfindPreprocess6For()

Description

Generates (release 6 type) preprocess data for pathfinding around agent unobstructed space.

Syntax

void generatePathfindPreprocess6For(const iShape* shape, const char *const* options);

Parameters

shape The shape for which pathfind preprocess should be generated.
options

This parameter enables optional attributes to be passed in to control aspects of the preprocess generation, if special behaviour is desired.

If special bevaviour is desired, then see Handling Attributes for general information about passing attributes, and Pathfind Preprocess Generation Attributes for a list of the attributes that can be passed in specifically to this method.

See Handling Attributes for general information about passing attributes.

If no special behaviour is desired then you can just pass zero in for this parameter, to indicate no attributes.

Requirements

Unobstructed space must be present for the shape on this mesh, and must be 'combined' (i.e. the 'combine' argument should have been set to true when generating unobstructed space).

Pathfind preprocess must not already be present for the shape on this mesh.

Remarks

Release 6 type process currently has a number of limitations. Currently you can only use one type of pathfinding call with this preprocess, iMesh::findShortestPath6(), dynamic obstacles cannot be included in the pathfinding preprocess, and save and load are not supported.

Multithreading details: Base mesh preprocess generation operations are non-blocking between shapes, so preprocess can be generated for multiple shapes simultaneously.
(See Using PathEngine with Multithreaded Applications.)

See Also

iMesh::generateUnobstructedSpaceFor(), iMesh::releasePathfindPreprocessFor(), iMesh::shapeHasPathfind6Preprocess()

C# Mapping

void generatePathfindPreprocess6For(Shape shape, string[] options);

Java Mapping

void generatePathfindPreprocess6For(Shape shape, String[] options);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iMesh::generatePathfindPreprocessFor()