net.lenni0451.commons.animation

Class DynamicAnimation

java.lang.Object

net.lenni0451.commons.animation.DynamicAnimation

public class DynamicAnimation
extends java.lang.Object

A dynamic animation with dynamically changing target values.
The animation will automatically handle the easing and duration of the animation.

Constructor Summary

Constructors

Constructor and Description
DynamicAnimation(EasingFunction easingFunction, EasingMode easingMode, long duration, float target)
DynamicAnimation(EasingFunction easingFunction, EasingMode easingMode, long durationPerUnit, float durationUnit, float target)

Method Summary

Modifier and Type	Method and Description
DynamicAnimation	finish() Immediately stop the animation and jump to the target value.
float	getStart()
float	getTarget()
float	getValue() Get the current value of the animation.
boolean	isRunning()
DynamicAnimation	setTarget(float target) Set the target value of the animation.
DynamicAnimation	stop() Stop the animation and keep the current value.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicAnimation

public DynamicAnimation(EasingFunction easingFunction,
                        EasingMode easingMode,
                        long duration,
                        float target)

DynamicAnimation

public DynamicAnimation(EasingFunction easingFunction,
                        EasingMode easingMode,
                        long durationPerUnit,
                        float durationUnit,
                        float target)

Method Detail

getStart

public float getStart()

Returns:

The start value of the animation

getTarget

public float getTarget()

Returns:

The target value of the animation

isRunning

public boolean isRunning()

Returns:

If the animation is currently running

stop

public DynamicAnimation stop()

Stop the animation and keep the current value.
It can be resumed by calling setTarget(float).

Returns:

The current instance

finish

public DynamicAnimation finish()

Immediately stop the animation and jump to the target value.
It can be resumed by calling setTarget(float).

Returns:

The current instance

setTarget

public DynamicAnimation setTarget(float target)

Set the target value of the animation.
If the target value is the same as the current target value, nothing will happen.

Parameters:

target - The new target value

Returns:

The current instance

getValue

public float getValue()

Get the current value of the animation.

Returns:

The current value