LatLonHeight

Description

struct Tinman.Terrain.Georef.LatLonHeight

Derived from

IEquatable<LatLonHeight>

Geographic coordinates with a height value.

See also

LatLon
VerticalType
Geocentric

Public / Constants

Undefined

public static readonly attribute Undefined → (LatLonHeight)

Undefined location.

See also

LatLonHeight.IsUndefined

Public / Constructors

From

public static method From → (1)

geographic in : Vec3D

The geographic coordinates:
Vec3D.X: longitude, in radians
Vec3D.Y: latitude, in radians
Vec3D.Z: ellipsoid height, in cartesian units.

returns → LatLonHeight

The LatLonHeight value.

Creates a new instance of LatLonHeight from the given geographic 3D coordinates.

See also

Geocentric.ToGeographic3D1

Lat­Lon­Height

public constructor LatLonHeight → (3)

coords in : LatLon

The geographic coordinates.

height opt : float64 = 0

The height value.

vertical opt : VerticalType = VerticalType.HeightMesh

The vertical coordinate type.

Creates a new instance of LatLonHeight.

With the default value for vertical opt, the LatLonHeight value will be relative to the triangle mesh of the terrain in its current state of tessellation, so computation results may vary. For invariant results, please use VerticalType.Height.

Public / Methods

Add

2 overloads

[Pure]
public method Add1 → (1)

value in : LatLon

The value to add.

returns → LatLonHeight

The resulting LatLonHeight value.

Adds the given value to Coords.

[Pure]
public method Add2 → (1)

value in : float64

The value to add.

returns → LatLonHeight

The resulting LatLonHeight value.

Adds the given value to Height.

Set

3 overloads

[Pure]
public method Set1 → (1)

coords in : LatLon

The value to set.

returns → LatLonHeight

The resulting LatLonHeight value.

Sets the value of Coords.

[Pure]
public method Set2 → (1)

height in : float64

The value to set.

returns → LatLonHeight

The resulting LatLonHeight value.

Sets the value of Height.

[Pure]
public method Set3 → (1)

vertical in : VerticalType

The value to set.

returns → LatLonHeight

The resulting LatLonHeight value.

Sets the value of Vertical.

To­String

2 overloads

[Pure]
public method ToString2 → (1)

format in : LatLonFormat

The format to use.

returns → string

The string representation.

Returns the string representation of this value.

To­Variance

public method ToVariance → (1)

variance in : bool

true to replace VerticalType.Height with VerticalType.HeightMesh
false to replace VerticalType.HeightMesh with VerticalType.Height

returns → LatLonHeight

The resulting LatLonHeight value.

Swaps VerticalType.Height and VerticalType.HeightMesh, according to the given variance in setting.

If Vertical is neither VerticalType.Height nor VerticalType.HeightMesh, this method returns this LatLonHeight value.

To­Vertical

public method ToVertical → (2)

geocentric in : Geocentric

[not-null]
The geocentric object to use.

vertical in : VerticalType

The output vertical coordinate type.

returns → LatLonHeight

The resulting value.

Transforms the vertical coordinate to the given type.

Public / Attributes

Coords

public readonly attribute Coords → (LatLon)

The geographic coordinates.

Height

public readonly attribute Height → (float64)

The height value, given in the length unit of geocentric coordinates (see Geocentric.Unit).

See also

LatLonHeight.Vertical

Is­Ground

public attribute IsGround → (get)

value : bool

true if the location is stuck on the terrain surface, false if not.

Does this LatLonHeight represent a location on the terrain surface?

Is­Undefined

public attribute IsUndefined → (get)

value : bool

true if the coordinates are undefined, false if not.

Is this coordinate set undefined?

See also

LatLonHeight.Undefined
LatLon.IsUndefinedCoordinate

Vertical

public readonly attribute Vertical → (VerticalType)

The vertical coordinate type.

See also

LatLonHeight.Height

Serialization

Serializer

public static readonly attribute Serializer → (ITypeSerializer<LatLonHeight>)

The serialization helper object for values of LatLonHeight.