org.openimaj.content.animation.animator

Class LinearTimeBasedFloatValueAnimator

java.lang.Object

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

org.openimaj.content.animation.animator.LinearTimeBasedFloatValueAnimator

All Implemented Interfaces:

ValueAnimator<Float>

public class LinearTimeBasedFloatValueAnimator
extends TimeBasedValueAnimator<Float>

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

Method Summary

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

LinearTimeBasedFloatValueAnimator

public LinearTimeBasedFloatValueAnimator(float start,
                                         float finish,
                                         long duration)

Construct a LinearTimeBasedFloatValueAnimator 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 Float calculateValue(double pc)

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

Specified by:

calculateValue in class TimeBasedValueAnimator<Float>

Parameters:

pc - The percentage

Returns:

A float that is pc along between start and finish