extractGroundFootprint

previous: iPathEngine::extractConvexPolyFootprint()

next: iPathEngine::getInterfaceMajorVersion()

Contents, API Reference, Interfaces, iPathEngine, extractGroundFootprint

iPathEngine::extractGroundFootprint()

Description

Extracts a ground mesh corresponding to the horizontal shape of arbitrary 3D mesh data.

Syntax

std::unique_ptr<const iGround> extractGroundFootprint(const iFaceVertexMesh& mesh, int32_t optimisationHorizontalRange, const char *const* options)

Parameters

mesh

The face/vertex mesh data for which the ground footprint is desired.

optimisationHorizontalRange

Maximum horizontal range to be applied during boundary optimisation. Must be greater than or equal to zero. Passing zero turns off boundary optimisation.

options

A set of named attributes to control how the iMesh object is constructed.

Refer to Handling Attributes for information about passing sets of named attributes.

Note that not all content processing options are relevant to this specific mesh construction method.

Return Value

A newly created Interface iGround object that approximates the external boundary of the face/vertex mesh data.

Remarks

As the first step of the process, the mesh data is projected into 2D (by ignoring Z coordinates), and the external boundary of the resulting 2D area is determined.

Note that any 'holes' in the 2D area covered by the mesh data (e.g. an enclosed courtyard entirely surrounded by the rest of a building mesh) will therefore be filled in.

An (optional) optimisation pass is then made on this boundary.

The boundary is then triangulated, to create a ground mesh.

C# Mapping

Ground extractGroundFootprint(FaceVertexMesh mesh, int optimisationHorizontalRange, string[] options);

Java Mapping

Ground extractGroundFootprint(FaceVertexMesh mesh, int optimisationHorizontalRange, String[] options);

next: iPathEngine::getInterfaceMajorVersion()