PathEngine home previous: iMesh::generateBackgroundConnectedRegionPreprocessFor()next: iMesh::generateBackgroundPathfindPreprocessFor()
Contents, API Reference, Interfaces, iMesh, generateBackgroundPathfindPreprocess6For

iMesh::generateBackgroundPathfindPreprocess6For()

Description

Background preprocess generation version of iMesh::generatePathfindPreprocess6For().

Syntax

void generateBackgroundPathfindPreprocess6For(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

Background 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).

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

C# Mapping

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

Documentation for PathEngine release 6.03 - Copyright © 2002-2021 PathEnginenext: iMesh::generateBackgroundPathfindPreprocessFor()