org.openimaj.content.animation.animator

Class LoopingValueAnimator<T>

java.lang.Object

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

Type Parameters:

T - Type produce by animator

All Implemented Interfaces:

ValueAnimator<T>

public class LoopingValueAnimator<T>
extends Object
implements ValueAnimator<T>

A ValueAnimator that can wrap another ValueAnimator to produce looping behavior by resetting when the animator has finished.

Author:

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

Constructor Summary

Constructors

Constructor and Description
LoopingValueAnimator(ValueAnimator<T> animator) Construct around the given ValueAnimator to provide looping behavior.

Method Summary

Modifier and Type	Method and Description
boolean	hasFinished() Has the animator finished animating the value.
static <T> LoopingValueAnimator<T>	loop(ValueAnimator<T> animator) Construct a new LoopingValueAnimator from a ValueAnimator.
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

Constructor Detail

LoopingValueAnimator

public LoopingValueAnimator(ValueAnimator<T> animator)

Construct around the given ValueAnimator to provide looping behavior.

Parameters:

animator - animator to loop

Method Detail

nextValue

public T nextValue()

Description copied from interface: ValueAnimator

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.

hasFinished

public 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

reset

public void reset()

Description copied from interface: ValueAnimator

Reset the animator back to its initial condition.

Specified by:

reset in interface ValueAnimator<T>

loop

public static <T> LoopingValueAnimator<T> loop(ValueAnimator<T> animator)

Construct a new LoopingValueAnimator from a ValueAnimator.

Type Parameters:

T - Type produce by animator

Parameters:

animator - animator to loop

Returns:

new LoopingValueAnimator