org.openimaj.content.animation.animator

Interface ValueAnimator<T>

Type Parameters:

T - Type of value produced

All Known Subinterfaces:

ReversableValueAnimator<T>

All Known Implementing Classes:

AbstractValueAnimator, ByteArrayValueAnimator, ColourSpaceAnimator, DoubleArrayValueAnimator, FloatArrayValueAnimator, ForwardBackwardLoopingValueAnimator, IntegerArrayValueAnimator, LinearByteValueAnimator, LinearDoubleValueAnimator, LinearFloatValueAnimator, LinearIntegerValueAnimator, LinearLongValueAnimator, LinearShortValueAnimator, LinearTimeBasedByteValueAnimator, LinearTimeBasedDoubleValueAnimator, LinearTimeBasedFloatValueAnimator, LinearTimeBasedIntegerValueAnimator, LinearTimeBasedLongValueAnimator, LinearTimeBasedShortValueAnimator, LongArrayValueAnimator, LoopingValueAnimator, RandomLinearByteValueAnimator, RandomLinearDoubleValueAnimator, RandomLinearFloatValueAnimator, RandomLinearIntegerValueAnimator, RandomLinearLongValueAnimator, RandomLinearShortValueAnimator, ShortArrayValueAnimator, TimeBasedValueAnimator

public interface ValueAnimator<T>

Interface for objects capable of "animating" a value; that is providing a new value everytime nextValue() is called, subject to some constraints.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
boolean	hasFinished() Has the animator finished animating the value.
T	nextValue() Get the next value.
void	reset() Reset the animator back to its initial condition.

Method Detail

nextValue

T nextValue()

Get the next value. If the animator has finished, the continuation is checked to see if there are more animators to run. If not, then the last value is returned.

Returns:

the next value.

hasFinished

boolean hasFinished()

Has the animator finished animating the value.

Returns:

true if the animator has finished; false otherwise

reset

void reset()

Reset the animator back to its initial condition.