org.openimaj.content.animation.animator

Class LinearTimeBasedShortValueAnimator

java.lang.Object

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

org.openimaj.content.animation.animator.LinearTimeBasedShortValueAnimator

All Implemented Interfaces:

ValueAnimator<Short>

public class LinearTimeBasedShortValueAnimator
extends TimeBasedValueAnimator<Short>

A TimeBasedValueAnimator that linearly animates a short 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
LinearTimeBasedShortValueAnimator(short start, short finish, long duration) Construct a LinearTimeBasedShortValueAnimator with the given start and finish values, and the given duration in millseconds.

Method Summary

Modifier and Type	Method and Description
Short	calculateValue(double pc) Calculates the value of the short 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

LinearTimeBasedShortValueAnimator

public LinearTimeBasedShortValueAnimator(short start,
                                         short finish,
                                         long duration)

Construct a LinearTimeBasedShortValueAnimator 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 Short calculateValue(double pc)

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

Specified by:

calculateValue in class TimeBasedValueAnimator<Short>

Parameters:

pc - The percentage

Returns:

A short that is pc along between start and finish