IGeoPathBase

Description

interface Tinman.Engine.Scenes.Data.IGeoPathBase

Derived from: ITimestampRangeProvider
Extended by: IGeoPath

Base interface for geo paths, without a generic type parameter for the geo path sample type.

The timestamp range of a geo path without any samples defaults to RangeD.Zero. Otherwise, the timestamp range tightly wraps the timestamp values of the geo path samples.

See also: IGeoPath

Public / Methods

AdjustToGround

[Pure]
public method AdjustToGround → (6)

geocentric ⁱⁿ : Geocentric: [not-null]
The geocentric transformation to use.
height ⁱⁿ : RangeD: The height above ground coefficients, in geocentric units:
RangeD.Start defines the minimum height above ground of the resulting geo path.
RangeD.End defines the height above ground at which to start blending from the original path sample to the ground sample.
Set to RangeD.Pos to put all geo path samples to RangeD.Start.
keep ⁱⁿ : RangeD: Geo path samples with a timestamp (see GeoPathSample.Timestamp) in this range are not processed: the original sample is simply copied to the resulting path.
velocity ⁱⁿ : float64: Geo path samples with a velocity greater than or equal to this value (in geocentric units per second) are not processed: the original sample is simply copied to the resulting path.
groundStart ^opt : bool = true: Is the geo path supposed to be on the ground at the start?
groundEnd ^opt : bool = true: Is the geo path supposed to be on the ground at the end?
returns → IGeoPathBase: The resulting geo path, which can safely be cast to IGeoPath, iff implemented by this geo path.

Adjusts this IGeoPathBase so that its non-airborne parts align with the terrain surface.

First, the samples of this geo path are converted to ground samples:

GeoPathSample.Height is set to the ground height.
GeoPathSample.Pitch is set to zero.
GeoPathSample.Roll is set to zero.

Then, a blend factor is computed for each geo path sample: 0 means that the ground sample will be used in the resulting path, 1 means that the original sample will be used. The blend factor is computed as follows:

ground.Height = surface + height.Start
ground.Pitch  = 0
ground.Roll   = 0
factor        = clamp((original.Height - ground.Height) / height.Length, 0, 1)

where ground is the ground sample, initialized with the values of the original sample, surface is the ellipsoid height of the terrain surface, original is the original sample.
Finally, the original sample and ground samples are blend using the computed factor, and the resulting sample is written to the output geo path.

See also: Geocentric.Unit

GeoPathSampleAt

[Pure]
public method GeoPathSampleAt → (3)

index ⁱⁿ : int32: [0..IGeoPathBase.Count-1]
The path sample index.
geocentric ^opt : Geocentric = null: The geocentric frame to use. If null, Vertical must be GeoPathValue.Ellipsoid, otherwise GeoPathSample.Height will always be zero. If not null, GeoPathSample.Height will be computed automatically, if necessary.
invariant ^opt : bool = true: true to use VerticalType.Height,
false to use VerticalType.HeightMesh.
returns → GeoPathSample: The path sample.

Returns the path sample at the given index.

If Vertical is not GeoPathValue.Ellipsoid, then GeoPathSample.Height will always be zero. There is no automatic conversion, IGeoPathConverter must be used for that.

See also: IGeoPathBase.GeoPathSampleOn

GeoPathSampleOn

[Pure]
public method GeoPathSampleOn → (3)

timestamp ⁱⁿ : float64: The timestamp value (see GeoPathSample.Timestamp).
geocentric ^opt : Geocentric = null: The geocentric frame to use. If null, Vertical must be GeoPathValue.Ellipsoid, otherwise GeoPathSample.Height will always be zero. If not null, GeoPathSample.Height will be computed automatically, if necessary.
invariant ^opt : bool = true: true to use VerticalType.Height,
false to use VerticalType.HeightMesh.
returns → GeoPathSample: The interpolated path sample.

Returns an interpolated path sample at the given timestamp value.

If Vertical is not GeoPathValue.Ellipsoid, then GeoPathSample.Height will always be zero. There is no automatic conversion, IGeoPathConverter must be used for that.

See also: IGeoPathBase.GeoPathSampleAt

GroundPathSampleAt

[Pure]
public method GroundPathSampleAt → (3)

index ⁱⁿ : int32: [0..IGeoPathBase.Count-1]
The path sample index.
geocentric ^opt : Geocentric = null: The geocentric frame to use. If null, Vertical must be GeoPathValue.Height, otherwise GeoPathSample.Height will always be zero. If not null, GroundPathSample.Height will be computed automatically, if necessary.
invariant ^opt : bool = true: true to use VerticalType.Height,
false to use VerticalType.HeightMesh.
returns → GroundPathSample: The path sample.

Returns the path sample at the given index.

If Vertical is not GeoPathValue.Height, then GroundPathSample.Height will always be zero. There is no automatic conversion, IGeoPathConverter must be used for that.

See also: IGeoPathBase.GroundPathSampleOn

GroundPathSampleOn

[Pure]
public method GroundPathSampleOn → (3)

timestamp ⁱⁿ : float64: The timestamp value (see GeoPathSample.Timestamp).
geocentric ^opt : Geocentric = null: The geocentric frame to use. If null, Vertical must be GeoPathValue.Height, otherwise GeoPathSample.Height will always be zero. If not null, GroundPathSample.Height will be computed automatically, if necessary.
invariant ^opt : bool = true: true to use VerticalType.Height,
false to use VerticalType.HeightMesh.
returns → GroundPathSample: The interpolated path sample.

Returns an interpolated path sample at the given timestamp value.

If Vertical is not GeoPathValue.Height, then GroundPathSample.Height will always be zero. There is no automatic conversion, IGeoPathConverter must be used for that.

See also: IGeoPathBase.GroundPathSampleAt

IndexOf

[Pure]
public method IndexOf → (1)

timestamp ⁱⁿ : float64: The timestamp value (see GeoPathSample.Timestamp).
returns → int32: The time value index. Will be -1 if timestamp ⁱⁿ is less than the timestamp of the path sample at index zero.

Computes the index of the path sample that has the greatest timestamp which is less than or equal to the given timestamp ⁱⁿ.

See also: IGeoPathBase.TimestampAt

LatLonAt

[Pure]
public method LatLonAt → (1)

index ⁱⁿ : int32: [0..IGeoPathBase.Count-1]
The path sample index.
returns → LatLon: The path sample.

Returns the path sample at the given index.

See also: IGeoPathBase.LatLonOn

LatLonHeightAt

[Pure]
public method LatLonHeightAt → (2)

index ⁱⁿ : int32: [0..IGeoPathBase.Count-1]
The path sample index.
invariant ^opt : bool = true: true to return VerticalType.Height for GeoPathValue.Height,
false to return VerticalType.HeightMesh for GeoPathValue.Height.
returns → LatLonHeight: The path sample.

Returns the path sample at the given index.

See also: IGeoPathBase.LatLonHeightOn

LatLonHeightOn

[Pure]
public method LatLonHeightOn → (2)

timestamp ⁱⁿ : float64: The timestamp value (see GeoPathSample.Timestamp).
invariant ^opt : bool = true: true to return VerticalType.Height for GeoPathValue.Height,
false to return VerticalType.HeightMesh for GeoPathValue.Height.
returns → LatLonHeight: The interpolated path sample.

Returns an interpolated path sample at the given timestamp value.

See also: IGeoPathBase.LatLonHeightAt

LatLonOn

[Pure]
public method LatLonOn → (1)

timestamp ⁱⁿ : float64: The timestamp value (see GeoPathSample.Timestamp).
returns → LatLon: The interpolated path sample.

Returns an interpolated path sample at the given timestamp value.

See also: IGeoPathBase.LatLonAt

PositionAt

[Pure]
public method PositionAt → (2)

geocentric ⁱⁿ : Geocentric: [not-null]
The geocentric transformation.
index ⁱⁿ : int32: [0..IGeoPathBase.Count-1]
The path sample index.
returns → Vec3D: The geocentric position.

Computes the geocentric position of the geo path at the given index.

See also: IGeoPathBase.PositionOn

PositionOn

[Pure]
public method PositionOn → (2)

geocentric ⁱⁿ : Geocentric: [not-null]
The geocentric transformation.
timestamp ⁱⁿ : float64: The timestamp value (see GeoPathSample.Timestamp).
returns → Vec3D: The geocentric position.

Computes the geocentric position of the geo path at the given timestamp.

See also: IGeoPathBase.PositionAt

TimestampAt

[Pure]
public method TimestampAt → (1)

index ⁱⁿ : int32: [0..IGeoPathBase.Count-1]
The path sample index.
returns → float64: The timestamp (see GeoPathSample.Timestamp).

Returns the timestamp of the path sample at the given index.

See also: IGeoPathBase.IndexOf

ValueAt

[Pure]
public method ValueAt → (2)

index ⁱⁿ : int32: [0..IGeoPathBase.Count-1]
The path sample index.
value ⁱⁿ : int32: [0..IGeoPathBase.Values-1]
The path value index.
returns → float64: The path sample.

Returns a path sample value at the given index.

See also: IGeoPathBase.ValueOn

ValueIndex

[Pure]
public method ValueIndex → (1)

value ⁱⁿ : GeoPathValue: The GeoPathValue.
returns → int32: The value index, see Values.

Returns the value index of the given GeoPathValue.

ValueOn

[Pure]
public method ValueOn → (2)

timestamp ⁱⁿ : float64: The timestamp value (see GeoPathSample.Timestamp).
value ⁱⁿ : int32: [0..IGeoPathBase.Values-1]
The path value index.
returns → float64: The interpolated path sample.

Returns an interpolated path sample value at the given timestamp value.

See also: IGeoPathBase.ValueAt

YawPitchRollAt

[Pure]
public method YawPitchRollAt → (1)

index ⁱⁿ : int32: [0..IGeoPathBase.Count-1]
The path sample index.
returns → Vec3D: The path sample:
Vec3D.X: GeoPathValue.Yaw
Vec3D.Y: GeoPathValue.Pitch
Vec3D.Z: GeoPathValue.Roll

Returns the path sample at the given index.

See also: IGeoPathBase.YawPitchRollOn
YawPitchRollTransform

YawPitchRollOn

[Pure]
public method YawPitchRollOn → (1)

timestamp ⁱⁿ : float64: The timestamp value (see GeoPathSample.Timestamp).
returns → Vec3D: The interpolated path sample: Vec3D.X: GeoPathValue.Yaw
Vec3D.Y: GeoPathValue.Pitch
Vec3D.Z: GeoPathValue.Roll

Returns an interpolated path sample at the given timestamp value.

See also: IGeoPathBase.GeoPathSampleAt
YawPitchRollTransform

Public / Attributes

Count

public attribute Count → (get)

value : int32: [>=0]
The number of path samples.

The number of samples that have been added to this path.

See also: IGeoPathBase.Stable

Datum

public attribute Datum → (get)

value : GeodeticDatum: [not-null]
The datum of this geo path.

The datum to use for interpreting GeoPathValue.Latitude and GeoPathValue.Latitude.

Stable

public attribute Stable → (get)

value : int32: [0..IGeoPathBase.Count]
The number of stable samples.

The number of stable samples in the geo path.

A geo path sample is stable if the interpolated sample at its timestamp (see TimestampAt) does not change when new samples are added to the geo path.

See also: IGeoPathBase.TimestampRangeStable

TimestampRangeStable

public attribute TimestampRangeStable → (get)

value : RangeD: The timestamp range. Will be RangeD.Zero if Stable returns 0.

The timestamp range of the stable geo path samples.

See also: IGeoPathBase.Stable

Values

public attribute Values → (get)

value : int32: [>0]
The number of raw geo path values.

The number of raw geo path values.

See also: IGeoPathSampleTrait.Count

Vertical

public attribute Vertical → (get)

value : GeoPathValue: The vertical geo path value.

The vertical geo path value.

See also: IGeoPathSampleTrait.Vertical

Extensions

HeightAboveGroundOn

[Pure]
public static method HeightAboveGroundOn → (3)

geocentric ⁱⁿ : Geocentric: [not-null]
The geocentric transformation.
timestamp ⁱⁿ : float64: The timestamp value (see GeoPathSample.Timestamp).
invariant ⁱⁿ : bool: true to compute the invariant height (see VerticalType.Height); this might involve I/O operations and blocking,
false to compute the terrain mesh-dependent height (see VerticalType.HeightMesh), which does not block.
returns → float64: The height above ground.

Computes the height above ground of the geo path at the given timestamp.

ToGeocentric

public static method ToGeocentric → (1)

geocentric ^opt : Geocentric = null: The Geocentric helper object to return or null to create a new one with Geocentric.For¹, passing IGeoPathBase.Datum.
returns → Geocentric: The Geocentric helper object.

Returns a Geocentric helper object for this geo path.

ToGeometry

public static method ToGeometry → (2)

curtain ^opt : float64 = Maths.MaxDouble: The bottom-most ellipsoid height of the geo path curtain (i.e. vertical planes). If Maths.MaxDouble, no curtain geometry will be created.
geocentric ^opt : Geocentric = null: The Geocentric helper object to use. If null, a new one will be created with Geocentric.For¹, passing IGeoPathBase.Datum.
returns → IModelGeometrySimple: The created model geometry of null iff this geo path is empty.

Creates 3D model geometry for this geo path.

ToShape

public static method ToShape → (2)

coordinateSystem ^opt : CoordinateSystem = null: The coordinate system of the shape (see IShapeInfo.Georef). If null, IGeoPathBase.Datum will be used to obtain a CoordinateSystem ( CoordinateSystem.WGS84 will be used for GeodeticDatum.WGS84).
timestamps ^opt : IVector<float64> = null: Optional sequence of geo path sample timestamps to use for creating the shape vertices. If null, a shape vertex will be created for each geo path sample (see IGeoPathBase.Count).
returns → IShape: The created shape or null iff this geo path is empty or coordinateSystem ^opt is invalid.

Creates a 2D shape for this geo path.

VelocityAt

[Pure]
public static method VelocityAt → (2)

geocentric ⁱⁿ : Geocentric: [not-null]
The geocentric transformation.
index ⁱⁿ : int32: [0..geoPath.Count-1]
The path sample index.
returns → float64: The geocentric velocity.

Computes the geocentric velocity of the geo path at the given index.

VelocityOn

[Pure]
public static method VelocityOn → (2)

geocentric ⁱⁿ : Geocentric: [not-null]
The geocentric transformation.
timestamp ⁱⁿ : float64: The timestamp value (see GeoPathSample.Timestamp).
returns → float64: The geocentric velocity.

Computes the geocentric velocity of the geo path at the given timestamp.

VelocityVectorAt

[Pure]
public static method VelocityVectorAt → (2)

geocentric ⁱⁿ : Geocentric: [not-null]
The geocentric transformation.
index ⁱⁿ : int32: [0..geoPath.Count-1]
The path sample index.
returns → Vec3D: The geocentric velocity.

Computes the geocentric velocity vector of the geo path at the given index.

VelocityVectorOn

[Pure]
public static method VelocityVectorOn → (2)

geocentric ⁱⁿ : Geocentric: [not-null]
The geocentric transformation.
timestamp ⁱⁿ : float64: The timestamp value (see GeoPathSample.Timestamp).
returns → Vec3D: The geocentric velocity.

Computes the geocentric velocity vector of the geo path at the given timestamp.

IGeoPathBase

Description

Public / Methods

Adjust​To​Ground

Geo​Path​Sample​At

Geo​Path​Sample​On

Ground​Path​Sample​At

Ground​Path​Sample​On

Index​Of

Lat​Lon​At

Lat​Lon​Height​At

Lat​Lon​Height​On

Lat​Lon​On

Position​At

Position​On

Timestamp​At

Value​At

Value​Index

Value​On

Yaw​Pitch​Roll​At

Yaw​Pitch​Roll​On

Public / Attributes

Count

Datum

Stable

Timestamp​Range​Stable

Values

Vertical

Extensions

Height​Above​Ground​On

To​Geocentric

To​Geometry

To​Shape

Velocity​At

Velocity​On

Velocity​Vector​At

Velocity​Vector​On

AdjustToGround

GeoPathSampleAt

GeoPathSampleOn

GroundPathSampleAt

GroundPathSampleOn

IndexOf

LatLonAt

LatLonHeightAt

LatLonHeightOn

LatLonOn

PositionAt

PositionOn

TimestampAt

ValueAt

ValueIndex

ValueOn

YawPitchRollAt

YawPitchRollOn

TimestampRangeStable

HeightAboveGroundOn

ToGeocentric

ToGeometry

ToShape

VelocityAt

VelocityOn

VelocityVectorAt

VelocityVectorOn