generateUnobstructedSpaceFor

previous: iMesh::generateUnobstructedSpaceFor()

Contents, API Reference, Interfaces, iMesh, generateUnobstructedSpaceFor_WithPreExpanded

iMesh::generateUnobstructedSpaceFor_WithPreExpanded()

Description

Generates a representation of (expanded) unobstructed space boundaries for the specified agent shape, on this mesh.

Syntax

void generateUnobstructedSpaceFor_WithPreExpanded(const iShape& shape, const char *const* options, const iExpanded2DObstacles* const * preExpanded_Buffer, uint32_t preExpanded_BufferEntries);

Parameters

shape

The shape for which unobstructed space should be generated.

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.

preExpanded_Buffer, preExpanded_BufferEntries

(See Passing Arrays.) Pointers to iExpanded2DObstacles objects for which boundaries should be included in the resulting unobstructed space.

Requirements

Unobstructed space must not already be present for the shape on this mesh.

Remarks

This method essentially does the same thing as iMesh::generateUnobstructedSpaceFor(), except that:

Pre-expanded (and potentially pre-optimised) boundaries can be included in the unobstructed space generation, with iExpanded2DObstacles instances.
Unlike iMesh::generateUnobstructedSpaceFor(), there's no combine parameter. When generating unobstructed space with pre-expanded boundaries included the combine parameter is essentially always forced to true. (So additional preprocess for connected regions or pathfinding can then also be generated.)
This is all currently very special cased and you can only use this (currently) with meshes that were generated with iMeshFederation::build2DTileMesh()!

The shape passed in for the generation of each iExpanded2DObstacles instance must correspond to the shape being passed in to this method.

C# Mapping

void generateUnobstructedSpaceFor_WithPreExpanded(Shape shape, string[] options, Expanded2DObstacles[] preExpanded);

next: iMesh::get3DFaceAtPosition()