org.openimaj.content.animation.animator

Class LinearTimeBasedDoubleValueAnimator

java.lang.Object

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

org.openimaj.content.animation.animator.LinearTimeBasedDoubleValueAnimator

All Implemented Interfaces:

ValueAnimator<Double>

public class LinearTimeBasedDoubleValueAnimator
extends TimeBasedValueAnimator<Double>

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

Method Summary

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

LinearTimeBasedDoubleValueAnimator

public LinearTimeBasedDoubleValueAnimator(double start,
                                          double finish,
                                          long duration)

Construct a LinearTimeBasedDoubleValueAnimator 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 Double calculateValue(double pc)

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

Specified by:

calculateValue in class TimeBasedValueAnimator<Double>

Parameters:

pc - The percentage

Returns:

A double that is pc along between start and finish