org.openimaj.content.animation.animator

Class AbstractValueAnimator<T>

java.lang.Object

org.openimaj.content.animation.animator.AbstractValueAnimator<T>

Type Parameters:

T - Type of value produced

All Implemented Interfaces:

ValueAnimator<T>

Direct Known Subclasses:

LinearByteValueAnimator, LinearDoubleValueAnimator, LinearFloatValueAnimator, LinearIntegerValueAnimator, LinearLongValueAnimator, LinearShortValueAnimator

public abstract class AbstractValueAnimator<T>
extends Object
implements ValueAnimator<T>

Base class 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)

Constructor Summary

Constructors

Constructor and Description
AbstractValueAnimator(T initial, int startWait, int stopWait) Construct with initial value

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractValueAnimator

public AbstractValueAnimator(T initial,
                     int startWait,
                     int stopWait)

Construct with initial value

Parameters:

initial - initial value

startWait - amount of time in ticks to wait before starting animation.

stopWait - amount of time in ticks to wait after finishing animation.

Method Detail

nextValue

public 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.

Specified by:

nextValue in interface ValueAnimator<T>

Returns:

the next value.

makeNextValue

protected abstract T makeNextValue()

resetToInitial

protected abstract void resetToInitial()

reset

public final void reset()

Description copied from interface: ValueAnimator

Reset the animator back to its initial condition.

Specified by:

reset in interface ValueAnimator<T>

complete

protected abstract boolean complete()

hasFinished

public final boolean hasFinished()

Description copied from interface: ValueAnimator

Has the animator finished animating the value.

Specified by:

hasFinished in interface ValueAnimator<T>

Returns:

true if the animator has finished; false otherwise