net.lenni0451.commons.animation

Class Animation

java.lang.Object

net.lenni0451.commons.animation.Animation

public class Animation
extends java.lang.Object

This class is used to create animations with multiple frames and easing functions.

Constructor Summary

Constructors

Constructor and Description
Animation()
Animation(AnimationMode mode)

Method Summary

Modifier and Type	Method and Description
Animation	finish() Finish the animation immediately. This will stop the animation if it is running.
Animation	finish(AnimationDirection direction) Finish the animation immediately in the given direction. This will stop the animation if it is running.
Animation	frame(java.util.function.Consumer<AnimationFrameBuilder> frameBuilder) Add a new frame to the animation. Fields that are not set will be copied from the previous frame. The start value will be copied from the end value of the previous frame. Copying values from the previous frame only works if a previous frame exists.
Animation	frame(EasingFunction easingFunction, EasingMode easingMode, float[] startValue, float[] endValue, java.lang.Integer duration, EasingBehavior easingBehavior) Add a new frame to the animation. Fields that are set to null will be copied from the previous frame.
Animation	frame(EasingFunction easingFunction, EasingMode easingMode, float startValue, float endValue, java.lang.Integer duration, EasingBehavior easingBehavior) Add a new frame to the animation. Fields that are set to null will be copied from the previous frame.
int	getCurrentFrame()
AnimationDirection	getDirection()
float[]	getEnd(int frame) Get the end value of the given frame.
int	getFrameCount()
float[]	getStart(int frame) Get the start value of the given frame.
float	getValue()
float	getValue(int index) Get the current value of the animation at the given index.
float[]	getValues()
boolean	isFinished()
boolean	isRunning()
Animation	reset() Reset the animation to the start. This will stop the animation if it is running.
Animation	reverse() Reverse the current animation direction.
Animation	runInDirection(AnimationDirection direction) Run the animation in the given direction. If the current direction is the same as the given direction, this method will do nothing. If the animation is not running, this method will start the animation into the given direction. If already running, the direction will be reversed.
Animation	setDirection(AnimationDirection direction) Set the direction of the animation.
Animation	setFrameByFrame(boolean frameByFrame) Set if the animation should be played frame by frame or not. If true, manually calling the start() method is required to continue the animation.
Animation	setMode(AnimationMode mode) Set the mode of the animation. This will reset the animation.
Animation	start() Start the animation. If the animation is already running, this method will do nothing.
Animation	start(AnimationDirection direction) Start the animation in the given direction. If the given direction is already set, this method will do nothing.
Animation	stop() Stop the animation. If the animation is already stopped, this method will do nothing. After stopping the animation, the current value will be saved and returned by getValues().

Methods inherited from class java.lang.Object

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

Constructor Detail

Animation

public Animation()

Animation

public Animation(AnimationMode mode)

Method Detail

frame

public Animation frame(java.util.function.Consumer<AnimationFrameBuilder> frameBuilder)

Add a new frame to the animation.
Fields that are not set will be copied from the previous frame.
The start value will be copied from the end value of the previous frame.

Copying values from the previous frame only works if a previous frame exists. It is recommended to use frame(EasingFunction, EasingMode, float, float, Integer, EasingBehavior) or frame(EasingFunction, EasingMode, float[], float[], Integer, EasingBehavior) to add the first frame and ensure all values are set.

Parameters:

frameBuilder - The builder for the frame

Returns:

The current animation instance

frame

public Animation frame(@Nullable
                       EasingFunction easingFunction,
                       @Nullable
                       EasingMode easingMode,
                       float startValue,
                       float endValue,
                       @Nullable
                       java.lang.Integer duration,
                       @Nullable
                       EasingBehavior easingBehavior)

Add a new frame to the animation.
Fields that are set to null will be copied from the previous frame.

Parameters:

easingFunction - The easing function for the frame

easingMode - The easing mode for the frame

startValue - The start value for the frame

endValue - The end value for the frame

duration - The duration for the frame

easingBehavior - The reverse behavior for the frame

Returns:

The current animation instance

frame

public Animation frame(@Nullable
                       EasingFunction easingFunction,
                       @Nullable
                       EasingMode easingMode,
                       @Nullable
                       float[] startValue,
                       @Nullable
                       float[] endValue,
                       @Nullable
                       java.lang.Integer duration,
                       @Nullable
                       EasingBehavior easingBehavior)

Add a new frame to the animation.
Fields that are set to null will be copied from the previous frame.

Parameters:

easingFunction - The easing function for the frame

easingMode - The easing mode for the frame

startValue - The start value for the frame

endValue - The end value for the frame

duration - The duration for the frame

easingBehavior - The reverse behavior for the frame

Returns:

The current animation instance

setMode

public Animation setMode(AnimationMode mode)

Set the mode of the animation.
This will reset the animation.

Parameters:

mode - The mode of the animation

Returns:

The current animation instance

setFrameByFrame

public Animation setFrameByFrame(boolean frameByFrame)

Set if the animation should be played frame by frame or not.
If true, manually calling the start() method is required to continue the animation.

Parameters:

frameByFrame - If the animation should be played frame by frame

Returns:

The current animation instance

isRunning

public boolean isRunning()

Returns:

If the animation is running

isFinished

public boolean isFinished()

Returns:

If the animation is finished

getDirection

public AnimationDirection getDirection()

Returns:

The direction of the animation

setDirection

public Animation setDirection(AnimationDirection direction)

Set the direction of the animation.

Parameters:

direction - The direction of the animation

Returns:

The current animation instance

getCurrentFrame

public int getCurrentFrame()

Returns:

The current frame of the animation

getFrameCount

public int getFrameCount()

Returns:

The number of frames in the animation

getStart

public float[] getStart(int frame)

Get the start value of the given frame.

Parameters:

frame - The frame to get the start value from

Returns:

The start value of the frame

getEnd

public float[] getEnd(int frame)

Get the end value of the given frame.

Parameters:

frame - The frame to get the end value from

Returns:

The end value of the frame

reverse

public Animation reverse()

Reverse the current animation direction.

Returns:

The current animation instance

runInDirection

public Animation runInDirection(AnimationDirection direction)

Run the animation in the given direction.
If the current direction is the same as the given direction, this method will do nothing.
If the animation is not running, this method will start the animation into the given direction.
If already running, the direction will be reversed.

Parameters:

direction - The direction to run the animation in

Returns:

The current animation instance

start

public Animation start(AnimationDirection direction)

Start the animation in the given direction.
If the given direction is already set, this method will do nothing.

Parameters:

direction - The direction to start the animation in

Returns:

The current animation instance

start

public Animation start()

Start the animation.
If the animation is already running, this method will do nothing.

Returns:

The current animation instance

stop

public Animation stop()

Stop the animation.
If the animation is already stopped, this method will do nothing.
After stopping the animation, the current value will be saved and returned by getValues().

Returns:

The current animation instance

reset

public Animation reset()

Reset the animation to the start.
This will stop the animation if it is running.

Returns:

The current animation instance

finish

public Animation finish()

Finish the animation immediately.
This will stop the animation if it is running.

Returns:

The current animation instance

finish

public Animation finish(AnimationDirection direction)

Finish the animation immediately in the given direction.
This will stop the animation if it is running.

Parameters:

direction - The direction to finish the animation in

Returns:

The current animation instance

getValue

public float getValue()

Returns:

The current value of the animation

See Also:

getValue(int), getValues()

getValue

public float getValue(int index)

Get the current value of the animation at the given index.

Parameters:

index - The index of the value to get

Returns:

The value at the given index

See Also:

getValues()

getValues

public float[] getValues()

Returns:

The current values of the animation