org.openimaj.content.animation.animator

Class ForwardBackwardLoopingValueAnimator<T>

java.lang.Object

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

Type Parameters:

T - Type produce by animator

All Implemented Interfaces:

ReversableValueAnimator<T>, ValueAnimator<T>

public class ForwardBackwardLoopingValueAnimator<T>
extends Object
implements ReversableValueAnimator<T>

A ReversableValueAnimator that can wrap another ReversableValueAnimator to produce back and forth looping behavior.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ForwardBackwardLoopingValueAnimator(ReversableValueAnimator<T> animator) Construct around the given ReversableValueAnimator to provide forward/backward looping behavior.

Method Summary

Modifier and Type	Method and Description
boolean	hasFinished() Has the animator finished animating the value.
static <T> ForwardBackwardLoopingValueAnimator<T>	loop(ReversableValueAnimator<T> animator) Construct a new ForwardBackwardLoopingValueAnimator from a ReversableValueAnimator.
T	nextValue() Get the next value.
void	reset() Reset the animator back to its initial condition.
ReversableValueAnimator<T>	reverseAnimator() Reverse the animator and return it, or make a new animator with the same state as this animator, but reversed direction.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardBackwardLoopingValueAnimator

public ForwardBackwardLoopingValueAnimator(ReversableValueAnimator<T> animator)

Construct around the given ReversableValueAnimator to provide forward/backward 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>

reverseAnimator

public ReversableValueAnimator<T> reverseAnimator()

Description copied from interface: ReversableValueAnimator

Reverse the animator and return it, or make a new animator with the same state as this animator, but reversed direction.

Specified by:

reverseAnimator in interface ReversableValueAnimator<T>

Returns:

reversed animator.

loop

public static <T> ForwardBackwardLoopingValueAnimator<T> loop(ReversableValueAnimator<T> animator)

Construct a new ForwardBackwardLoopingValueAnimator from a ReversableValueAnimator.

Type Parameters:

T - Type produce by animator

Parameters:

animator - animator to loop

Returns:

new ForwardBackwardLoopingValueAnimator