org.mini2Dx.core.engine.interpolator.value

Class InterpolatedFloatValue

java.lang.Object

org.mini2Dx.core.engine.interpolator.value.InterpolatedFloatValue

public final class InterpolatedFloatValue
extends java.lang.Object

An interpolated value stores the initial value as well as the current value of a variable. The interpolated value may be used during rendering.

   // Example: Updating health stored as a float
   FloatInterpolatedValue health = new FloatInterpolatedValue(Interpolators.linearFloat());
   health.setInitialValue(10f);
   health.setCurrentValue(10f);

   // Set initial value prior to any changes
   float currentHealth = health.getCurrentValue();
   health.setInitialValue(currentHealth);

   // Update current value as you normally would
   currentHealth -= 5f;
   health.setCurrentValue(currentHealth);

   // Get the interpolated value
   float interpolatedHp = health.getInterpolatedValue(0.5f);
   Assert.assertEquals(interpolatedHp, 7.5f);
 

Constructor Summary

Constructors

Constructor and Description
InterpolatedFloatValue(FloatInterpolator interpolator) Constructs the InterpolatedFloatValue

Method Summary

Modifier and Type	Method and Description
float	getCurrentValue() Gets the current value
float	getInitialValue() The initial value
float	getInterpolatedValue(float alpha) Gets the interpolated value at the specified alpha
void	setCurrentValue(float currentValue) Sets the current value
void	setInitialValue(float initialValue) Sets the initial value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InterpolatedFloatValue

public InterpolatedFloatValue(FloatInterpolator interpolator)

Constructs the InterpolatedFloatValue

Parameters:

interpolator - the interpolator function

Method Detail

getInitialValue

public float getInitialValue()

The initial value

Returns:

the initial value

setInitialValue

public void setInitialValue(float initialValue)

Sets the initial value

Parameters:

initialValue - the new initial value

getCurrentValue

public float getCurrentValue()

Gets the current value

Returns:

the current value

setCurrentValue

public void setCurrentValue(float currentValue)

Sets the current value

Parameters:

currentValue - the new current value

getInterpolatedValue

public float getInterpolatedValue(float alpha)

Gets the interpolated value at the specified alpha

Parameters:

alpha - the alpha is a value between 0.0f and 1.0f

Returns:

the interpolated value