org.openimaj.content.animation.animator

Class ByteArrayValueAnimator

java.lang.Object

org.openimaj.content.animation.animator.ByteArrayValueAnimator

All Implemented Interfaces:

ValueAnimator<byte[]>

public class ByteArrayValueAnimator
extends Object
implements ValueAnimator<byte[]>

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

Author:

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

Constructor Summary

Constructors

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

ByteArrayValueAnimator

@SafeVarargs
public ByteArrayValueAnimator(ValueAnimator<Byte>... animators)

Construct from an array of ValueAnimators

Parameters:

animators - the animators

Method Detail

makeLinear

public static ByteArrayValueAnimator makeLinear(int duration,
                                                byte... maxs)

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

makeLinear

public static ByteArrayValueAnimator makeLinear(int duration,
                                                int count,
                                                byte start,
                                                byte finish)

Construct a new ByteArrayValueAnimator from count LinearByteValueAnimators 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 ByteArrayValueAnimator

makeRandomLinear

public static ByteArrayValueAnimator makeRandomLinear(int duration,
                                                      byte... maxs)

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

makeRandomLinear

public static ByteArrayValueAnimator makeRandomLinear(int duration,
                                                      int count,
                                                      byte start,
                                                      byte finish)

Construct a new ByteArrayValueAnimator from count RandomLinearByteValueAnimators 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 ByteArrayValueAnimator

nextValue

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

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

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