IGeoPathValues

Description

interface Tinman.Engine.Scenes.Data.IGeoPathValues

Derived from

ITimestampRangeProvider
IGeoPathTimestampsProvider

Extended by

GeoPathComponent sealed
IGeoPathBase

Base interface classes that contain timestamps with associated sample values.

Geo path values may have special numeric behaviour, for example clamping or wrapping (see GeoPathFlag). Before numeric processing is performed on geo path values, they are prepared with DataUtil.AngleUnwrap, which yields raw values. After numeric processing, the resulting raw value is processed with DataUtil.Process1, which yields the final geo path value. The details of the above process are usually not visible to client code. However, when performing custom processing of geo path values, it may be necessary to use the raw values. To do so, the following methods may be used:

Public / Methods

Index​Of

[Pure]
public method IndexOf → (1)

timestamp in : float64

The timestamp value (see GeoPathSample.Timestamp).

returns → int32

The time value index. Will be -1 if timestamp in is less than the timestamp of the geo path sample at index zero.

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

See also

IGeoPathValues.TimestampAt

Timestamp​At

[Pure]
public method TimestampAt → (1)

index in : int32

[0..IGeoPathValues.Count-1]
The geo path sample index.

returns → float64

The timestamp (see GeoPathSample.Timestamp).

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

See also

IGeoPathValues.IndexOf

Value​At

[Pure]
public method ValueAt → (3)

index in : int32

[0..IGeoPathValues.Count-1]
The geo path sample index.

value opt : int32 = 0

[0..IGeoPathValues.Values-1]
The geo path value index.

raw opt : bool = false

Return the raw value?

returns → float64

The geo path value.

Returns a geo path sample value at the given index.

See also

IGeoPathValues.ValueOn

Value​Data

[Pure]
public method ValueData → (1)

value opt : int32 = 0

[0..IGeoPathValues.Values-1]
The geo path value index.

returns → IVectorConst<float64>

The list of raw values. Subsequent modifications of this container will not be visible in the returned collection.

Returns the raw geo path sample values.

Value​Id

[Constant] [Pure]
public method ValueId → (1)

value opt : int32 = 0

[0..IGeoPathValues.Values-1]
The geo path value index.

returns → GeoPathComponentId

The geo path component identifier.

Returns the GeoPathComponentId for the geo path value at the given index.

Value​Index

[Pure]
public method ValueIndex → (1)

value in : GeoPathValue

The GeoPathValue.

returns → int32

The value index or -1, see Values.

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

See also

IGeoPathSampleTrait.Index

Value​On

[Pure]
public method ValueOn → (3)

timestamp in : float64

The timestamp value (see GeoPathSample.Timestamp).

value opt : int32 = 0

[0..IGeoPathValues.Values-1]
The path value index.

raw opt : bool = false

Return the raw value?

returns → float64

The interpolated geo path value.

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

See also

IGeoPathValues.ValueAt

Public / Attributes

Count

public attribute Count → (get)

value : int32

[>=0]
The number of geo path samples.

The number of geo path samples.

Count​Stable

public attribute CountStable → (get)

value : int32

[0..IGeoPathValues.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

IGeoPathValues.Count

Timestamp​Range​Stable

public attribute TimestampRangeStable → (get)

value : RangeD

The timestamp range. Will be RangeD.Zero if CountStable returns 0.

The timestamp range of the stable geo path samples.

See also

ITimestampRangeProperty.TimestampRange

Values

[Constant]
public attribute Values → (get)

value : int32

[>0]
The number of geo path sample components.

The number of geo path sample components.

A IGeoPath is associated with a IGeoPathSampleTrait. In that case, there will be a sample component for each geo path value, see IGeoPathSampleTrait.Count.

Extensions

To​Component

public static method ToComponent → (2)

value opt : int32 = 0

The geo path value index, see IGeoPathValues.Values.

output opt : GeoPathComponent = null

Optional output to use. If null, a new GeoPathComponent object will be created.

returns → GeoPathComponent

The container for the geo path value.

Returns a separate container for the given get path value.

To​Components

public static method ToComponents → (1)

output opt : GeoPathComponents = null

Optional output to use or null to create a new GeoPathComponents object.

returns → GeoPathComponents

The map that holds the container for each component, mapped by the geo path value index (see IGeoPathValues.Values).

Returns separate containers for the get path values.

See also

IGeoPathBase.AddAll