org.openimaj.content.animation.animator

Class RandomLinearByteValueAnimator

java.lang.Object

org.openimaj.content.animation.animator.RandomLinearByteValueAnimator

All Implemented Interfaces:

ValueAnimator<Byte>

public class RandomLinearByteValueAnimator
extends Object
implements ValueAnimator<Byte>

A ValueAnimator that continuously animates between randomly selected values in a range. Once the stop value has been reached, the animator chooses a new random target value. Each animation between values is linear and has a fixed duration.

Author:

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

Constructor Summary

Constructors

Constructor and Description
RandomLinearByteValueAnimator(byte min, byte max, int duration) Construct a RandomLinearByteValueAnimator with the given range and duration for each sub-animation.
RandomLinearByteValueAnimator(byte min, byte max, int duration, byte initial) Construct a RandomLinearByteValueAnimator with the given range, duration for each sub-animation and fixed initial value.
RandomLinearByteValueAnimator(int startWait, int stopWait, byte min, byte max, int duration) Construct a RandomLinearByteValueAnimator with the given range and duration for each sub-animation.
RandomLinearByteValueAnimator(int startWait, int stopWait, byte min, byte max, int duration, byte initial) Construct a RandomLinearByteValueAnimator with the given range, duration for each sub-animation and fixed initial value.

Method Summary

Modifier and Type	Method and Description
boolean	hasFinished() Has the animator finished animating the value.
Byte	nextValue() Get the next value.
void	reset() Reset the animator back to its initial condition.
protected void	setNextAnimator(byte v1)

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomLinearByteValueAnimator

public RandomLinearByteValueAnimator(byte min,
                                     byte max,
                                     int duration)

Construct a RandomLinearByteValueAnimator with the given range and duration for each sub-animation.

Parameters:

min - minimum allowed value

max - maximum allowed value

duration - duration between values

RandomLinearByteValueAnimator

public RandomLinearByteValueAnimator(byte min,
                                     byte max,
                                     int duration,
                                     byte initial)

Construct a RandomLinearByteValueAnimator with the given range, duration for each sub-animation and fixed initial value.

Parameters:

min - minimum allowed value

max - maximum allowed value

duration - duration between values

initial - initial starting value

RandomLinearByteValueAnimator

public RandomLinearByteValueAnimator(int startWait,
                                     int stopWait,
                                     byte min,
                                     byte max,
                                     int duration)

Construct a RandomLinearByteValueAnimator with the given range and duration for each sub-animation. The sub-animations will start after startWait ticks, and finish stopWait ticks after startWait+duration.

Parameters:

startWait - amount of time in ticks to wait before starting animation.

stopWait - amount of time in ticks to wait after finishing animation.

min - minimum allowed value

max - maximum allowed value

duration - duration between values

RandomLinearByteValueAnimator

public RandomLinearByteValueAnimator(int startWait,
                                     int stopWait,
                                     byte min,
                                     byte max,
                                     int duration,
                                     byte initial)

Construct a RandomLinearByteValueAnimator with the given range, duration for each sub-animation and fixed initial value. The sub-animations will start after startWait ticks, and finish stopWait ticks after startWait+duration.

Parameters:

startWait - amount of time in ticks to wait before starting animation.

stopWait - amount of time in ticks to wait after finishing animation.

min - minimum allowed value

max - maximum allowed value

duration - duration between values

initial - initial starting value

Method Detail

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>

setNextAnimator

protected void setNextAnimator(byte v1)