LevelCorrection

Description

sealed class Tinman.Engine.Scenes.Entities.LevelCorrection

Derived from

SceneEntityBase abstract

A scene entity that corrects the terrain in the given region by levelling it to a uniform elevation value.

The levelled terrain is not necessarily planar: depending on the IGeometry of the terrain, it may also represent the curved surface of an ellipsoid.

Public / Constructors

Level​Correction

public constructor LevelCorrection → ()

Creates a new instance of LevelCorrection.

Public / Attributes

Elevation

public attribute Elevation → (get)

value : float64

The average elevation, using VerticalType.Ellipsoid.

Returns the average elevation value that has been computed from the shape vertices.

See also

LevelCorrection.Shape
LevelCorrection.Offset

Falloff

public attribute Falloff → (get,set)

value : float64

[>=0]
The falloff region, specified as a distance in horizontal units of the shape coordinate system, see CoordinateSystem.HorizontalUnit.

Defines the falloff region between the original terrain and the levelled terrain.

Defaults to 0.

Offset

public attribute Offset → (get,set)

value : Vec2D

The offset values (see remarks).

Specifies an offset to apply to the average elevation that is computed from the shape vertices.

The uniform elevation value U is computed from the average elevation value A as follows:

U = A * Offset.X + Offset.Y

Defaults to (1,0), which results in U = A.

See also

LevelCorrection.Elevation

Shape

public attribute Shape → (get,set)

value : IShape

The vector shape.

The geo-referenced shapes that depicts the region that shall be levelled.

The shape vertices are used to compute the average elevation, to which the elevation offset (see Offset) is applied in order to obtain the uniform elevation value to use for levelling the terrain.

Defaults to null.

Logging

Logger

public static readonly attribute Logger → (ILogger)

The logger object of this class.