An Animation stores a list of objects representing an animated sequence, e.g. for running or jumping. Each object in the Animation is called a key frame, and multiple key frames make up the animation.

The animation's type is the class representing a frame of animation. For example, a typical 2D animation could be made up of TextureRegions and would be specified as:

Animation<TextureRegion> myAnimation = new Animation<TextureRegion>(...);

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	Animation.PlayMode Defines possible playback modes for an `Animation`.

Modifier and Type	Field and Description
private float	animationDuration
private float	frameDuration
pack-priv T[]	keyFrames Length must not be modified without updating `animationDuration`.
private int	lastFrameNumber
private float	lastStateTime
private Animation.PlayMode	playMode

Constructor Summary

Access	Constructor and Description
public	Animation(float the time between frames in seconds. frameDuration, Array<? extends T> the objects representing the frames. If this Array is type-aware, `getKeyFrames()` can return the correct type of array. Otherwise, it returns an Object[]. keyFrames) Constructor, storing the frame duration and key frames.
public	Animation(float the time between frames in seconds. frameDuration, Array<? extends T> the objects representing the frames. If this Array is type-aware, `getKeyFrames()` can return the correct type of array. Otherwise, it returns an Object[]. keyFrames, Animation.PlayMode playMode) Constructor, storing the frame duration and key frames.
public	Animation(float the time between frames in seconds. frameDuration, T... the objects representing the frames. keyFrames) Constructor, storing the frame duration and key frames.

Method Summary

Modifier and Type	Method and Description
public float	getAnimationDuration() Returns: the duration of the entire animation, number of frames times frame duration, in seconds
public float	getFrameDuration() Returns: the duration of a frame in seconds
public T	Returns: the frame of animation for the given state time. getKeyFrame(float the time spent in the state represented by this animation. stateTime, boolean whether the animation is looping or not. looping) Returns a frame based on the so called state time.
public T	Returns: the frame of animation for the given state time. getKeyFrame(float stateTime) Returns a frame based on the so called state time.
public int	Returns: current frame number getKeyFrameIndex(float stateTime) Returns the current frame number.
public T[]	Returns: The keyframes[] field. This array is an Object[] if the animation was instantiated with an Array that was not type-aware. getKeyFrames() Returns the keyframes[] array where all the frames of the animation are stored.
public Animation.PlayMode	getPlayMode() Returns the animation play mode.
public boolean	Returns: whether the animation is finished. isAnimationFinished(float stateTime) Whether the animation would be finished if played without looping (PlayMode#NORMAL), given the state time.
public void	setFrameDuration(float in seconds frameDuration) Sets duration a frame will be displayed.
protected void	setKeyFrames(T... keyFrames)
public void	setPlayMode(Animation.PlayMode The animation `PlayMode` to use. playMode) Sets the animation play mode.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

animationDuration	back to summary
private float animationDuration

frameDuration	back to summary
private float frameDuration

keyFrames	back to summary
pack-priv T[] keyFrames Length must not be modified without updating `animationDuration`. See `setKeyFrames(T[])`.

lastFrameNumber	back to summary
private int lastFrameNumber

lastStateTime	back to summary
private float lastStateTime

playMode	back to summary
private Animation.PlayMode playMode

Constructor Detail

Animation back to summary

Animation	back to summary
public Animation(float frameDuration, Array<? extends T> keyFrames) Constructor, storing the frame duration and key frames. Parameters frameDuration:float the time between frames in seconds. keyFrames:Array<? extends T> the objects representing the frames. If this Array is type-aware, `getKeyFrames()` can return the correct type of array. Otherwise, it returns an Object[].

public Animation(float frameDuration, Array<? extends T> keyFrames)

Constructor, storing the frame duration and key frames.

Parameters

frameDuration:float: the time between frames in seconds.
keyFrames:Array<? extends T>: the objects representing the frames. If this Array is type-aware, getKeyFrames() can return the correct type of array. Otherwise, it returns an Object[].

Animation back to summary

Animation	back to summary
public Animation(float frameDuration, Array<? extends T> keyFrames, Animation.PlayMode playMode) Constructor, storing the frame duration and key frames. Parameters frameDuration:float the time between frames in seconds. keyFrames:Array<? extends T> the objects representing the frames. If this Array is type-aware, `getKeyFrames()` can return the correct type of array. Otherwise, it returns an Object[].

public Animation(float frameDuration, Array<? extends T> keyFrames, Animation.PlayMode playMode)

Constructor, storing the frame duration and key frames.

Parameters

frameDuration:float: the time between frames in seconds.
keyFrames:Array<? extends T>: the objects representing the frames. If this Array is type-aware, getKeyFrames() can return the correct type of array. Otherwise, it returns an Object[].

Animation	back to summary
public Animation(float frameDuration, T... keyFrames) Constructor, storing the frame duration and key frames. Parameters frameDuration:float the time between frames in seconds. keyFrames:T[] the objects representing the frames.

Animation

back to summary

public Animation(float frameDuration, T... keyFrames)

Constructor, storing the frame duration and key frames.

Parameters

frameDuration:float: the time between frames in seconds.
keyFrames:T[]: the objects representing the frames.

Method Detail

getAnimationDuration	back to summary
public float getAnimationDuration() Returns:float the duration of the entire animation, number of frames times frame duration, in seconds

getFrameDuration	back to summary
public float getFrameDuration() Returns:float the duration of a frame in seconds

getKeyFrame	back to summary
public T getKeyFrame(float stateTime, boolean looping) Returns a frame based on the so called state time. This is the amount of seconds an object has spent in the state this Animation instance represents, e.g. running, jumping and so on. The mode specifies whether the animation is looping or not. Parameters stateTime:float the time spent in the state represented by this animation. looping:boolean whether the animation is looping or not. Returns:T the frame of animation for the given state time.

getKeyFrame

back to summary

public T getKeyFrame(float stateTime, boolean looping)

Returns a frame based on the so called state time. This is the amount of seconds an object has spent in the state this Animation instance represents, e.g. running, jumping and so on. The mode specifies whether the animation is looping or not.

Parameters

stateTime:float: the time spent in the state represented by this animation.
looping:boolean: whether the animation is looping or not.

Returns:T

the frame of animation for the given state time.

getKeyFrame back to summary

getKeyFrame	back to summary
public T getKeyFrame(float stateTime) Returns a frame based on the so called state time. This is the amount of seconds an object has spent in the state this Animation instance represents, e.g. running, jumping and so on using the mode specified by `setPlayMode(PlayMode)` method. Returns:T the frame of animation for the given state time.

public T getKeyFrame(float stateTime)

Returns a frame based on the so called state time. This is the amount of seconds an object has spent in the state this Animation instance represents, e.g. running, jumping and so on using the mode specified by setPlayMode(PlayMode) method.

Returns:T: the frame of animation for the given state time.

getKeyFrameIndex	back to summary
public int getKeyFrameIndex(float stateTime) Returns the current frame number. Returns:int current frame number

getKeyFrameIndex

back to summary

public int getKeyFrameIndex(float stateTime)

Returns the current frame number.

Returns:int: current frame number

getKeyFrames	back to summary
public T[] getKeyFrames() Returns the keyframes[] array where all the frames of the animation are stored. Returns:T[] The keyframes[] field. This array is an Object[] if the animation was instantiated with an Array that was not type-aware.

getKeyFrames

back to summary

public T[] getKeyFrames()

Returns the keyframes[] array where all the frames of the animation are stored.

Returns:T[]: The keyframes[] field. This array is an Object[] if the animation was instantiated with an Array that was not type-aware.

getPlayMode	back to summary
public Animation.PlayMode getPlayMode() Returns the animation play mode.

isAnimationFinished	back to summary
public boolean isAnimationFinished(float stateTime) Whether the animation would be finished if played without looping (PlayMode#NORMAL), given the state time. Returns:boolean whether the animation is finished.

isAnimationFinished

back to summary

public boolean isAnimationFinished(float stateTime)

Whether the animation would be finished if played without looping (PlayMode#NORMAL), given the state time.

Returns:boolean: whether the animation is finished.

setFrameDuration	back to summary
public void setFrameDuration(float frameDuration) Sets duration a frame will be displayed. Parameters frameDuration:float in seconds

setFrameDuration

back to summary

public void setFrameDuration(float frameDuration)

Sets duration a frame will be displayed.

Parameters

frameDuration:float: in seconds

setKeyFrames	back to summary
protected void setKeyFrames(T... keyFrames)

setPlayMode back to summary

setPlayMode	back to summary
public void setPlayMode(Animation.PlayMode playMode) Sets the animation play mode. Parameters playMode:Animation.PlayMode The animation `PlayMode` to use.

public void setPlayMode(Animation.PlayMode playMode)

Sets the animation play mode.

Parameters

playMode:Animation.PlayMode: The animation PlayMode to use.

com.badlogic.gdx.graphics.g2d back to summary

public final Enum Animation.PlayMode

Class Inheritance

extends Enum<Animation.PlayMode>

java.lang.Object
java.lang.Enum
com.badlogic.gdx.graphics.g2d.Animation.PlayMode

Defines possible playback modes for an Animation.

Field Summary

Modifier and Type	Field and Description
public static final Animation.PlayMode	LOOP
public static final Animation.PlayMode	LOOP_PINGPONG
public static final Animation.PlayMode	LOOP_RANDOM
public static final Animation.PlayMode	LOOP_REVERSED
public static final Animation.PlayMode	NORMAL
public static final Animation.PlayMode	REVERSED

Constructor Summary

Access	Constructor and Description
private	PlayMode()

Method Summary

Modifier and Type	Method and Description
public static Animation.PlayMode	valueOf(String name)
public static Animation.PlayMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

LOOP	back to summary
public static final Animation.PlayMode LOOP

LOOP_PINGPONG	back to summary
public static final Animation.PlayMode LOOP_PINGPONG

LOOP_RANDOM	back to summary
public static final Animation.PlayMode LOOP_RANDOM

LOOP_REVERSED	back to summary
public static final Animation.PlayMode LOOP_REVERSED

NORMAL	back to summary
public static final Animation.PlayMode NORMAL

REVERSED	back to summary
public static final Animation.PlayMode REVERSED

Constructor Detail

PlayMode	back to summary
private PlayMode()

Method Detail

valueOf	back to summary
public static Animation.PlayMode valueOf(String name)

values	back to summary
public static Animation.PlayMode[] values()

public Class Animation<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Animation.PlayMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail