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

iMesh::generateBackgroundConnectedRegionPreprocessFor()

Description

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

Syntax

void generateBackgroundConnectedRegionPreprocessFor(const iShape& shape, const char *const* options);

Parameters

shape The shape for which connected region 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.

(There are currently no attributes for connected regions preprocess, this argument is included for future compatibility reasons.)

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 connected region preprocess must not already be present for the shape on this mesh.

C# Mapping

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

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