org.openimaj.content.animation.animator

Class ShortArrayValueAnimator

java.lang.Object

org.openimaj.content.animation.animator.ShortArrayValueAnimator

All Implemented Interfaces:

ValueAnimator<short[]>

public class ShortArrayValueAnimator
extends Object
implements ValueAnimator<short[]>

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

Author:

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

Constructor Summary

Constructors

Constructor and Description
ShortArrayValueAnimator(ValueAnimator<Short>... 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 ShortArrayValueAnimator	makeLinear(int duration, int count, short start, short finish) Construct a new ShortArrayValueAnimator from count LinearShortValueAnimators with the given start and finish values, and the given duration.
static ShortArrayValueAnimator	makeLinear(int duration, short... maxs) Construct a new ShortArrayValueAnimator from an array of values using LinearShortValueAnimators with the range -max to +max and the given duration.
static ShortArrayValueAnimator	makeRandomLinear(int duration, int count, short start, short finish) Construct a new ShortArrayValueAnimator from count RandomLinearShortValueAnimators with the given start and finish values, and the given duration.
static ShortArrayValueAnimator	makeRandomLinear(int duration, short... maxs) Construct a new ShortArrayValueAnimator from an array of values using RandomLinearShortValueAnimators with the range -max to +max and the given duration.
short[]	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

ShortArrayValueAnimator

@SafeVarargs
public ShortArrayValueAnimator(ValueAnimator<Short>... animators)

Construct from an array of ValueAnimators

Parameters:

animators - the animators

Method Detail

makeLinear

public static ShortArrayValueAnimator makeLinear(int duration,
                                                 short... maxs)

Construct a new ShortArrayValueAnimator from an array of values using LinearShortValueAnimators 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 ShortArrayValueAnimator

makeLinear

public static ShortArrayValueAnimator makeLinear(int duration,
                                                 int count,
                                                 short start,
                                                 short finish)

Construct a new ShortArrayValueAnimator from count LinearShortValueAnimators 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 ShortArrayValueAnimator

makeRandomLinear

public static ShortArrayValueAnimator makeRandomLinear(int duration,
                                                       short... maxs)

Construct a new ShortArrayValueAnimator from an array of values using RandomLinearShortValueAnimators 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 ShortArrayValueAnimator

makeRandomLinear

public static ShortArrayValueAnimator makeRandomLinear(int duration,
                                                       int count,
                                                       short start,
                                                       short finish)

Construct a new ShortArrayValueAnimator from count RandomLinearShortValueAnimators 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 ShortArrayValueAnimator

nextValue

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

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

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