PathEngine home previous: iMesh::generateBackgroundPathfindPreprocessFor()next: iMesh::generateBackgroundUnobstructedSpaceFor_WithPreExpanded()
Contents, API Reference, Interfaces, iMesh, generateBackgroundUnobstructedSpaceFor

iMesh::generateBackgroundUnobstructedSpaceFor()

Description

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

Syntax

void generateBackgroundUnobstructedSpaceFor(const iShape& shape, bool combine, const char *const* options);

Parameters

shape The shape for which unobstructed space should be generated.
combine Controls whether unobstructed space boundary elements are combined into a single boundary representation.
This must be set if generating additional preprocess for pathfinding or connected region queries.
options

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

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

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

C# Mapping

void generateBackgroundUnobstructedSpaceFor(Shape shape, bool combine, string[] options);

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