com.badlogic.gdx.graphics.g2d

Class Animation

java.lang.Object

com.badlogic.gdx.graphics.g2d.Animation

public class Animation
extends Object

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

Author:

mzechner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Animation.PlayMode Defines possible playback modes for an Animation.

Constructor Summary

Constructors

Constructor and Description
Animation(float frameDuration, Array<? extends TextureRegion> keyFrames) Constructor, storing the frame duration and key frames.
Animation(float frameDuration, Array<? extends TextureRegion> keyFrames, Animation.PlayMode playMode) Constructor, storing the frame duration, key frames and play type.
Animation(float frameDuration, TextureRegion... keyFrames) Constructor, storing the frame duration and key frames.

Method Summary

Methods

Modifier and Type	Method and Description
float	getAnimationDuration()
float	getFrameDuration()
TextureRegion	getKeyFrame(float stateTime) Returns a TextureRegion based on the so called state time.
TextureRegion	getKeyFrame(float stateTime, boolean looping) Returns a TextureRegion based on the so called state time.
int	getKeyFrameIndex(float stateTime) Returns the current frame number.
TextureRegion[]	getKeyFrames() Returns the keyFrames[] array where all the TextureRegions of the animation are stored.
Animation.PlayMode	getPlayMode() Returns the animation play mode.
boolean	isAnimationFinished(float stateTime) Whether the animation would be finished if played without looping (PlayMode#NORMAL), given the state time.
void	setFrameDuration(float frameDuration) Sets duration a frame will be displayed.
void	setPlayMode(Animation.PlayMode playMode) Sets the animation play mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

Animation

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

Constructor, storing the frame duration and key frames.

Parameters:

frameDuration - the time between frames in seconds.

keyFrames - the TextureRegions representing the frames.

Animation

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

Constructor, storing the frame duration, key frames and play type.

Parameters:

frameDuration - the time between frames in seconds.

keyFrames - the TextureRegions representing the frames.

playMode - the animation playback mode.

Animation

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

Constructor, storing the frame duration and key frames.

Parameters:

frameDuration - the time between frames in seconds.

keyFrames - the TextureRegions representing the frames.

Method Detail

getKeyFrame

public TextureRegion getKeyFrame(float stateTime,
                        boolean looping)

Returns a TextureRegion 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 - the time spent in the state represented by this animation.

looping - whether the animation is looping or not.

Returns:

the TextureRegion representing the frame of animation for the given state time.

getKeyFrame

public TextureRegion getKeyFrame(float stateTime)

Returns a TextureRegion 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.

Parameters:

stateTime -

Returns:

the TextureRegion representing the frame of animation for the given state time.

getKeyFrameIndex

public int getKeyFrameIndex(float stateTime)

Returns the current frame number.

Parameters:

stateTime -

Returns:

current frame number

getKeyFrames

public TextureRegion[] getKeyFrames()

Returns the keyFrames[] array where all the TextureRegions of the animation are stored.

Returns:

keyFrames[] field

getPlayMode

public Animation.PlayMode getPlayMode()

Returns the animation play mode.

setPlayMode

public void setPlayMode(Animation.PlayMode playMode)

Sets the animation play mode.

Parameters:

playMode - The animation Animation.PlayMode to use.

isAnimationFinished

public boolean isAnimationFinished(float stateTime)

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

Parameters:

stateTime -

Returns:

whether the animation is finished.

setFrameDuration

public void setFrameDuration(float frameDuration)

Sets duration a frame will be displayed.

Parameters:

frameDuration - in seconds

getFrameDuration

public float getFrameDuration()

Returns:

the duration of a frame in seconds

getAnimationDuration

public float getAnimationDuration()

Returns:

the duration of the entire animation, number of frames times frame duration, in seconds