generateConnectedRegionPreprocessFor

previous: iMesh::generateBackgroundUnobstructedSpaceFor_WithPreExpanded()

Contents, API Reference, Interfaces, iMesh, generateConnectedRegionPreprocessFor

iMesh::generateConnectedRegionPreprocessFor()

Description

Generates preprocess data relating to connectivity between unobstructed space boundaries, to support connected region queries.

Syntax

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

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

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

Remarks

You can avoid the overhead of generating preprocess at runtime by using iMesh::saveConnectedRegionPreprocessFor() and iMesh::loadConnectedRegionPreprocessFor() to save and load the data to and from a persistent store.

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

C# Mapping

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

next: iMesh::generateCurvedPath()