org.openimaj.content.animation.animator

Class FloatArrayValueAnimator

java.lang.Object

org.openimaj.content.animation.animator.FloatArrayValueAnimator

All Implemented Interfaces:

ValueAnimator<float[]>

public class FloatArrayValueAnimator
extends Object
implements ValueAnimator<float[]>

A ValueAnimator capable of producing float arrays from a set of potentially independent underlying ValueAnimators.

Author:

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

Constructor Summary

Constructors

Constructor and Description
FloatArrayValueAnimator(ValueAnimator<Float>... animators) Construct from an array of ValueAnimators

Method Summary

Modifier and Type	Method and Description
boolean	hasFinished() Has the animator finished animating the value.
static FloatArrayValueAnimator	makeLinear(int duration, float... maxs) Construct a new FloatArrayValueAnimator from an array of values using LinearFloatValueAnimators with the range -max to +max and the given duration.
static FloatArrayValueAnimator	makeLinear(int duration, int count, float start, float finish) Construct a new FloatArrayValueAnimator from count LinearFloatValueAnimators with the given start and finish values, and the given duration.
static FloatArrayValueAnimator	makeRandomLinear(int duration, float... maxs) Construct a new FloatArrayValueAnimator from an array of values using RandomLinearFloatValueAnimators with the range -max to +max and the given duration.
static FloatArrayValueAnimator	makeRandomLinear(int duration, int count, float start, float finish) Construct a new FloatArrayValueAnimator from count RandomLinearFloatValueAnimators with the given start and finish values, and the given duration.
float[]	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

FloatArrayValueAnimator

@SafeVarargs
public FloatArrayValueAnimator(ValueAnimator<Float>... animators)

Construct from an array of ValueAnimators

Parameters:

animators - the animators

Method Detail

makeLinear

public static FloatArrayValueAnimator makeLinear(int duration,
                                                 float... maxs)

Construct a new FloatArrayValueAnimator from an array of values using LinearFloatValueAnimators with the range -max to +max and the given duration.

Parameters:

duration - the duration of the underlying animators

maxs - max distance from 0 (+/-)

Returns:

new FloatArrayValueAnimator

makeLinear

public static FloatArrayValueAnimator makeLinear(int duration,
                                                 int count,
                                                 float start,
                                                 float finish)

Construct a new FloatArrayValueAnimator from count LinearFloatValueAnimators with the given start and finish values, and the given duration.

Parameters:

duration - the duration

count - the number of animators

start - the starting value

finish - the finishing value

Returns:

new FloatArrayValueAnimator

makeRandomLinear

public static FloatArrayValueAnimator makeRandomLinear(int duration,
                                                       float... maxs)

Construct a new FloatArrayValueAnimator from an array of values using RandomLinearFloatValueAnimators with the range -max to +max and the given duration.

Parameters:

duration - the duration of the underlying animators

maxs - max distance from 0 (+/-)

Returns:

new FloatArrayValueAnimator

makeRandomLinear

public static FloatArrayValueAnimator makeRandomLinear(int duration,
                                                       int count,
                                                       float start,
                                                       float finish)

Construct a new FloatArrayValueAnimator from count RandomLinearFloatValueAnimators with the given start and finish values, and the given duration.

Parameters:

duration - the duration

count - the number of animators

start - the starting value

finish - the finishing value

Returns:

new FloatArrayValueAnimator

nextValue

public float[] 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<float[]>

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<float[]>

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<float[]>