HeightAboveGround

Description

sealed class Tinman.Terrain.Meshing.HeightAboveGround

Derived from

MeshBoundBase
IMeshFilters

The HeightAboveGround class traverses the filtered mesh (see IMeshFilters.FilterIn) and computes the height of a given point above the terrain surface, along to the up-vector of the terrain geometry (see IGeometry.ComputeUp).

The term above in this context is dependent on the used IGeometry object: points that have a higher elevations value are considered to be above those points with lower elevation values.

The following vertex data semantics are used by this class:

Public / Constructors

Height​Above​Ground

public constructor HeightAboveGround → ()

Creates a new instance of HeightAboveGround.

Public / Methods

Compute

4 overloads

[Pure]
public method Compute1 → (1)

point in : Vec3D

Coordinates of the point in terrain-space.

returns → float64

The height above ground, in terrain-space. If the given point is not located above the terrain, a negative value is returned. If the point is not above or below the terrain, NaN is returned.

Computes the height above ground from the given point.

[Pure]
public method Compute2 → (2)

point in : Vec3D

Coordinates of the point in terrain-space.

up out : Vec3D

Output for up-vector.

returns → float64

The height above ground, in terrain-space. If the given point is not located above the terrain, a negative value is returned. If the point is not above or below the terrain, NaN is returned.

Computes the height above ground from the given point.

[Pure]
public method Compute3 → (3)

pointX in : float64

X-coordinate of the point in terrain-space.

pointY in : float64

Y-coordinate of the point in terrain-space.

pointZ in : float64

Z-coordinate of the point in terrain-space.

returns → float64

The height above ground, in terrain-space. If the given point is not located above the terrain, a negative value is returned. If the point is not above or below the terrain, NaN is returned.

Computes the height above ground from the given point in terrain-space.

[Pure]
public method Compute4 → (4)

pointX in : float64

X-coordinate of the point in terrain-space.

pointY in : float64

Y-coordinate of the point in terrain-space.

pointZ in : float64

Z-coordinate of the point in terrain-space.

up out : Vec3D

Output for up-vector.

returns → float64

The height above ground, in terrain-space. If the given point is not located above the terrain, a negative value is returned. If the point is not above or below the terrain, NaN is returned.

Computes the height above ground from the given point in terrain-space.