Class WaveTransformationBase<T>

Base implementation for wave render pass data transformations within SciChart.

Note: This base class and inheritors are used for animations purposes. You can use it to just transform render pass data, it's not recommended though.

See Also: WaveHlTransformation, WaveOhlcTransformation, WaveXyyTransformation, WaveXyTransformation
Inheritance
java.lang.Object
RenderPassDataTransformationBase<TRenderPassData>
BaseRenderPassDataTransformation
WaveTransformationBase<T>
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class WaveTransformationBase<T> extends BaseRenderPassDataTransformation<T>
Type Parameters
Name Description
T

Constructors

WaveTransformationBase(Class<T> rpdType, double zeroLine, float durationOfStepData)

Create new instance of WaveTransformationBase class.

Declaration
protected WaveTransformationBase(Class<T> rpdType, double zeroLine, float durationOfStepData)
Parameters
Type Name Description
Class<T> rpdType

Type of associated render pass data.
double zeroLine

Data value which determines the zero line in Y direction, from which scaling will be performed.
float durationOfStepData

Wave duration before next point is started to animate. Default is 0.5.

Methods

applyTransformation()

Applies this transformation to associated series.

Note: This is used for animations purposes, so you need to take into account BaseRenderPassDataTransformation#getCurrentTransformationValue() as well as BaseRenderPassDataTransformation#getCurrentDelta() during implementing this.

Declaration
protected final void applyTransformation()
Overrides

applyTransformationInternal(float currentDelta)

Applies transformation using ScaleTransformationBase#transformValues(float, FloatValues, FloatValues) method. FloatValues to be supplied from inheritors. First arg is values to transform. Second is to get original coordinates from.

Declaration
protected abstract void applyTransformationInternal(float currentDelta)
Parameters
Type Name Description
float currentDelta

The current delta value, due to which values will be transformed.

applyTransformationOnRenderPassDataChanged(FloatValues valuesToTransform)

Transforms valuesToTransform based on updated render pass data, according to current state of transformation.

Declaration
protected void applyTransformationOnRenderPassDataChanged(FloatValues valuesToTransform)
Parameters
Type Name Description
FloatValues valuesToTransform

Values to transform.

getZeroLineCoordinate()

Gets the value which determines the zero line in Y direction, from which wave will be performed.

Declaration
public final float getZeroLineCoordinate()
Returns
Type Description
float

The zero line coordinate value.

onAnimationStartInternal()

Called on start of animation associated with current transformation

Declaration
protected void onAnimationStartInternal()
Overrides

prepareDataToTransformation()

Prepares associated render pass data to transformation.

Declaration
protected abstract void prepareDataToTransformation()

saveOriginalData()

Saves original data from render pass data, which supposed to be changed during #applyTransformation() call.

Declaration
protected void saveOriginalData()
Overrides

transformValues(float currentDelta, FloatValues valuesToTransform, FloatValues originalCoordinates)

Transforms valuesToTransform based on original coordinates and currentDelta, to achieve scale transform.

Declaration
protected void transformValues(float currentDelta, FloatValues valuesToTransform, FloatValues originalCoordinates)
Parameters
Type Name Description
float currentDelta

The current delta value, due to which values will be transformed.
FloatValues valuesToTransform

Values to transform.
FloatValues originalCoordinates

Original coordinates, which stored on last change of render pass data.