de.gurkenlabs.litiengine.graphics.animation

Class Animation

java.lang.Object

de.gurkenlabs.litiengine.graphics.animation.Animation

All Implemented Interfaces:

ILaunchable, IUpdateable

public class Animation
extends java.lang.Object
implements IUpdateable, ILaunchable

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FRAME_DURATION

Constructor Summary

Constructors

Constructor and Description
Animation(Spritesheet spritesheet, boolean loop, boolean randomizeStart, int... keyFrameDurations)
Animation(Spritesheet spritesheet, boolean loop, int... keyFrameDurations)
Animation(java.lang.String spriteSheetName, boolean loop, boolean randomizeStart, int... keyFrameDurations)
Animation(java.lang.String name, Spritesheet spritesheet, boolean loop, boolean randomizeStart, int... keyFrameDurations)
Animation(java.lang.String name, Spritesheet spritesheet, boolean loop, int... keyFrameDurations)

Method Summary

Modifier and Type	Method and Description
KeyFrame	getCurrentKeyFrame()
java.util.List<KeyFrame>	getKeyframes()
java.lang.String	getName()
Spritesheet	getSpritesheet()
int	getTotalDuration() Gets to aggregated duration of all KeyFrames in this animation.
boolean	isLoop()
boolean	isPaused()
boolean	isPlaying()
void	pause()
void	restart()
void	setFrameDuration(int frameDuration) Sets the frame duration for all keyframes in this animation to the specified value.
void	setkeyFrameDurations(int... keyFrameDurations)
void	start()
void	terminate()
void	unpause()
void	update() This method is called by the game loop on all objects that need to update their attributes.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FRAME_DURATION

public static final int DEFAULT_FRAME_DURATION

See Also:

Constant Field Values

Constructor Detail

Animation

public Animation(java.lang.String spriteSheetName,
                 boolean loop,
                 boolean randomizeStart,
                 int... keyFrameDurations)

Animation

public Animation(Spritesheet spritesheet,
                 boolean loop,
                 boolean randomizeStart,
                 int... keyFrameDurations)

Animation

public Animation(Spritesheet spritesheet,
                 boolean loop,
                 int... keyFrameDurations)

Animation

public Animation(java.lang.String name,
                 Spritesheet spritesheet,
                 boolean loop,
                 boolean randomizeStart,
                 int... keyFrameDurations)

Animation

public Animation(java.lang.String name,
                 Spritesheet spritesheet,
                 boolean loop,
                 int... keyFrameDurations)

Method Detail

getCurrentKeyFrame

public KeyFrame getCurrentKeyFrame()

getKeyframes

public java.util.List<KeyFrame> getKeyframes()

getTotalDuration

public int getTotalDuration()

Gets to aggregated duration of all KeyFrames in this animation.

Returns:

The total duration of a single playback.

getName

public java.lang.String getName()

getSpritesheet

public Spritesheet getSpritesheet()

isLoop

public boolean isLoop()

isPaused

public boolean isPaused()

isPlaying

public boolean isPlaying()

pause

public void pause()

setFrameDuration

public void setFrameDuration(int frameDuration)

Sets the frame duration for all keyframes in this animation to the specified value.

Parameters:

frameDuration - The frameduration for all keyframes.

setkeyFrameDurations

public void setkeyFrameDurations(int... keyFrameDurations)

start

public void start()

Specified by:

start in interface ILaunchable

restart

public void restart()

terminate

public void terminate()

Specified by:

terminate in interface ILaunchable

unpause

public void unpause()

update

public void update()

Description copied from interface: IUpdateable

This method is called by the game loop on all objects that need to update their attributes. It is called on every tick, means, it is called Game.GameLoop.TICKS_PER_SECOND times per second.

Specified by:

update in interface IUpdateable