IGeoPathFilter

Description

interface Tinman.Engine.Scenes.Data.IGeoPathFilter

Derived from

IBeginEnd

Extended by

GeoPathFilter abstract

Base interface for classes that perform filtering on geo path sample values.

The sequence of calls during a filter cycle looks like this:

  1. IBeginEnd.Begin is called.

  2. Raw is called, passing the raw value arrays.

  3. Value is called, passing the index of the geo path value that is going to be filtered.

  4. Filter is called once for each geo path sample value to filter.

  5. Go to 3. if there is another geo path value to filter.

  6. IBeginEnd.End is called.

Public / Methods

Filter

[Pure]
public method Filter → (3)

index in : int32

The value index, see IGeoPathValues.Count.

timestamp in : float64

The timestamp of the value to filter.

value in : float64

The value to filter.

returns → float64

The filtered value or Maths.NanD to discard it.

Filters the given geo path sample value.

Raw

public method Raw → (1)

raw in : IVectorConst<float64> [ ]

[not-null]
The raw value containers (see IGeoPathValues.ValueData) for each geo path value (see IGeoPathValues.Values).

Provides the raw geo path value arrays for use with subsequent filtering.

Value

public method Value → (2)

index in : int32

The raw value container index (see IGeoPathValues.Values).

component in : GeoPathComponentId

The geo path value identifier, see IGeoPathValues.ValueId.

Provides the raw geo path value arrays for use with subsequent filtering.