org.openimaj.content.animation.animator

Class LinearByteValueAnimator

java.lang.Object

org.openimaj.content.animation.animator.AbstractValueAnimator<Byte>

org.openimaj.content.animation.animator.LinearByteValueAnimator

All Implemented Interfaces:

ReversableValueAnimator<Byte>, ValueAnimator<Byte>

public class LinearByteValueAnimator
extends AbstractValueAnimator<Byte>
implements ReversableValueAnimator<Byte>

A ValueAnimator that linearly animates a Byte value between two values.

Author:

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

Constructor Summary

Constructors

Constructor and Description
LinearByteValueAnimator(byte start, byte finish, int duration) Construct a LinearByteValueAnimator with the given start and finish values, and the given duration in ticks (number of calls to AbstractValueAnimator.nextValue().
LinearByteValueAnimator(int startWait, int stopWait, byte start, byte finish, int duration) Construct a LinearByteValueAnimator with the given start and finish values, and the given duration in ticks (number of calls to AbstractValueAnimator.nextValue().

Method Summary

Modifier and Type	Method and Description
protected boolean	complete()
Byte	makeNextValue()
protected void	resetToInitial()
ReversableValueAnimator<Byte>	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 org.openimaj.content.animation.animator.AbstractValueAnimator

hasFinished, nextValue, reset

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openimaj.content.animation.animator.ValueAnimator

hasFinished, nextValue, reset

Constructor Detail

LinearByteValueAnimator

public LinearByteValueAnimator(byte start,
                               byte finish,
                               int duration)

Construct a LinearByteValueAnimator with the given start and finish values, and the given duration in ticks (number of calls to AbstractValueAnimator.nextValue(). The animation starts immediately and completes once duration ticks have been reached.

Parameters:

start - start value

finish - stop value

duration -

LinearByteValueAnimator

public LinearByteValueAnimator(int startWait,
                               int stopWait,
                               byte start,
                               byte finish,
                               int duration)

Construct a LinearByteValueAnimator with the given start and finish values, and the given duration in ticks (number of calls to AbstractValueAnimator.nextValue(). The animation 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.

start - start value

finish - stop value

duration -

Method Detail

makeNextValue

public Byte makeNextValue()

Specified by:

makeNextValue in class AbstractValueAnimator<Byte>

complete

protected boolean complete()

Specified by:

complete in class AbstractValueAnimator<Byte>

resetToInitial

protected void resetToInitial()

Specified by:

resetToInitial in class AbstractValueAnimator<Byte>

reverseAnimator

public ReversableValueAnimator<Byte> 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<Byte>

Returns:

reversed animator.