IGeoPathSampleTrait

Description

[StaticTemplate]
interface Tinman.Engine.Scenes.Data.IGeoPathSampleTrait → <T ^val>

Type trait for structures that represent a geo path sample.

[Pure]
public method Flag → (1)

index ⁱⁿ : int32: The geo path value index.
returns → GeoPathFlag: The value flag or GeoPathFlag.None if index ⁱⁿ is out of range.

Returns the numeric behaviour flag of the given geo path value.

[Pure]
public method Get → (2)

Returns a value of the given geo path sample.

[Pure]
public method Index → (1)

value ⁱⁿ : GeoPathValue: The well-known geo path value.
returns → int32: The value index or -1 if value ⁱⁿ does not exist in geo path samples of this type.

Returns the value index of the given well-known geo path value.

[Pure]
public method Read → (2)

values ⁱⁿ : float64 [ ] [ ]: The value arrays, indexed as follows:
values[index][n] := value
where index is the value index in the range [0..Count[ and value is the result of Get.
n ⁱⁿ : int32: Index of element in values ⁱⁿ to read.
returns → T: The geo path sample.

Reads geo path values from the given arrays, processes them and creates a geo path sample.

After reading geo path values from values ⁱⁿ, they must be processed with DataUtil.Process¹ before being put into a geo path sample.

[Pure]
public method Set → (3)

Sets a value in the given geo path sample.

public attribute Count → (get)

Returns the number of values in a geo path sample.

See also: GeoPathValue.Timestamp
GeoPathValue.Latitude
GeoPathValue.Longitude

public attribute Vertical → (get)

value : GeoPathValue: The vertical geo path value (see remarks) or GeoPathValue.Ellipsoid if undefined.

The vertical geo path value.

A geo path sample may contain exactly one of the GeoPathValue.Ellipsoid, GeoPathValue.Gravity and GeoPathValue.Height values, or none of them. If a geo path sample does not contain any vertical values, the vertical geo path value is undefined.