org.mini2Dx.core.engine.interpolator

Interface FloatInterpolator

All Known Implementing Classes:

DiscreteFloatInterpolator, LinearFloatInterpolator

public interface FloatInterpolator

The interpolator function for floats. By using primitive values directly, we avoid any unnecessary allocation of Floats during auto-boxing.

Method Summary

Modifier and Type	Method and Description
float	interpolate(float initialValue, float currentValue, float alpha) The interpolation algorithm.

Method Detail

interpolate

float interpolate(float initialValue,
                  float currentValue,
                  float alpha)

The interpolation algorithm. This takes the initial value, the current value, and the ratio of initial value to current value. The result is then returned for use.

Parameters:

initialValue - the initial value

currentValue - the current value

alpha - a value between 0.0f to 1.0f. When alpha is 0.0f, the value should always be the initial value. When alpha is at 1.0f, the value should always be the current value.