org.openimaj.content.animation.animator

Class LinearTimeBasedByteValueAnimator

java.lang.Object

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

org.openimaj.content.animation.animator.LinearTimeBasedByteValueAnimator

All Implemented Interfaces:

ValueAnimator<Byte>

public class LinearTimeBasedByteValueAnimator
extends TimeBasedValueAnimator<Byte>

A TimeBasedValueAnimator that linearly animates a byte value between two values over a given time.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk), David Dupplaw (dpd@ecs.soton.ac.uk)

Field Summary

Fields inherited from class org.openimaj.content.animation.animator.TimeBasedValueAnimator

endValue, startValue

Constructor Summary

Constructors

Constructor and Description
LinearTimeBasedByteValueAnimator(byte start, byte finish, long duration) Construct a LinearTimeBasedByteValueAnimator with the given start and finish values, and the given duration in millseconds.

Method Summary

Modifier and Type	Method and Description
Byte	calculateValue(double pc) Calculates the value of the byte based on the start, end and current percentage.

Methods inherited from class org.openimaj.content.animation.animator.TimeBasedValueAnimator

hasFinished, isComplete, nextValue, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

LinearTimeBasedByteValueAnimator

public LinearTimeBasedByteValueAnimator(byte start,
                                        byte finish,
                                        long duration)

Construct a LinearTimeBasedByteValueAnimator with the given start and finish values, and the given duration in millseconds. The animation starts on the first call to makeNextValue() and completes once duration ticks have been reached.

Parameters:

start - start value

finish - stop value

duration - in milliseconds

Method Detail

calculateValue

public Byte calculateValue(double pc)

Calculates the value of the byte based on the start, end and current percentage.

Specified by:

calculateValue in class TimeBasedValueAnimator<Byte>

Parameters:

pc - The percentage

Returns:

A byte that is pc along between start and finish