org.openimaj.content.animation.animator

Class TimeBasedValueAnimator<T>

java.lang.Object

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

Type Parameters:

T - The type of value produced

All Implemented Interfaces:

ValueAnimator<T>

Direct Known Subclasses:

LinearTimeBasedByteValueAnimator, LinearTimeBasedDoubleValueAnimator, LinearTimeBasedFloatValueAnimator, LinearTimeBasedIntegerValueAnimator, LinearTimeBasedLongValueAnimator, LinearTimeBasedShortValueAnimator

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

An animator that will animate a value over a given time period. The animator is constructed using a specific time period and on the first call of the makeNextValue() will start a timer.

Subclasses must implement a method that can return a value based on an absolute percentage value. This class will convert the time each nextValue() is called into a percentage value between the start and end times and use that to calculate the absolute value of the animator.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected T	endValue The end/target value of the animation
protected T	startValue The start value of the animation

Constructor Summary

Constructors

Constructor and Description
TimeBasedValueAnimator(T initial, T end, long millis)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract T	calculateValue(double pc) Given a percentage value (0 < pc <=1), the method should return a value for the animation.
boolean	hasFinished() A implementation sugar for isComplete() Has the animator finished animating the value.
boolean	isComplete() Returns whether the animator has completed
T	nextValue() Get the next value.
void	reset() Reset the animator back to its initial condition.

Methods inherited from class java.lang.Object

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

Field Detail

startValue

protected T startValue

The start value of the animation

endValue

protected T endValue

The end/target value of the animation

Constructor Detail

TimeBasedValueAnimator

public TimeBasedValueAnimator(T initial,
                      T end,
                      long millis)

Parameters:

initial - The start value for the animator

end - The end value for the animator

millis - The length of time the animation should run

Method Detail

calculateValue

protected abstract T calculateValue(double pc)

Given a percentage value (0 < pc <=1), the method should return a value for the animation.

Parameters:

pc - the percentage value

Returns:

The animator value

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.

See Also:

ValueAnimator.nextValue()

reset

public void reset()

Reset the animator back to its initial condition.

Specified by:

reset in interface ValueAnimator<T>

See Also:

ValueAnimator.reset()

isComplete

public boolean isComplete()

Returns whether the animator has completed

Returns:

TRUE if the animator has completed.

hasFinished

public boolean hasFinished()

A implementation sugar for isComplete() Has the animator finished animating the value.

Specified by:

hasFinished in interface ValueAnimator<T>

Returns:

true if the animator has finished; false otherwise

See Also:

ValueAnimator.hasFinished()