de.gurkenlabs.litiengine.graphics.animation

Class AnimationController

java.lang.Object

de.gurkenlabs.litiengine.graphics.animation.AnimationController

All Implemented Interfaces:

IAnimationController, IUpdateable

Direct Known Subclasses:

EntityAnimationController

public class AnimationController
extends java.lang.Object
implements IAnimationController

Constructor Summary

Constructors

Constructor and Description
AnimationController()
AnimationController(Animation defaultAnimation)
AnimationController(Animation defaultAnimation, Animation... animations)
AnimationController(Spritesheet sprite)
AnimationController(Spritesheet sprite, boolean loop)

Method Summary

Modifier and Type	Method and Description
void	add(Animation animation)
void	add(ImageEffect effect)
void	addListener(AnimationListener listener)
void	attach() Attach the AnimationController, as well as all its Animations to the Game loop.
protected java.lang.String	buildCurrentCacheKey() Build a unique cache key for the current frame.
void	clear() Remove all Animations from the AnimationController.
void	detach() Detach the AnimationController, as well as all its Animations from the Game loop.
Animation	get(java.lang.String animationName)
java.awt.geom.AffineTransform	getAffineTransform()
java.util.Collection<Animation>	getAll()
Animation	getCurrent()
java.awt.image.BufferedImage	getCurrentSprite()
java.awt.image.BufferedImage	getCurrentSprite(int width, int height)
Animation	getDefault()
java.util.List<ImageEffect>	getImageEffects()
boolean	hasAnimation(java.lang.String animationName)
boolean	isEnabled()
boolean	isPlaying(java.lang.String animationName)
void	play(java.lang.String animationName)
void	remove(Animation animation)
void	remove(ImageEffect effect)
void	removeListener(AnimationListener listener)
void	setAffineTransform(java.awt.geom.AffineTransform affineTransform)
void	setDefault(Animation defaultAnimation)
void	setEnabled(boolean enabled)
void	update() This method is called by the game loop on all objects that are attached to the loop.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnimationController

public AnimationController()

AnimationController

public AnimationController(Animation defaultAnimation)

AnimationController

public AnimationController(Animation defaultAnimation,
                           Animation... animations)

AnimationController

public AnimationController(Spritesheet sprite)

AnimationController

public AnimationController(Spritesheet sprite,
                           boolean loop)

Method Detail

add

public void add(Animation animation)

Specified by:

add in interface IAnimationController

add

public void add(ImageEffect effect)

Specified by:

add in interface IAnimationController

addListener

public void addListener(AnimationListener listener)

Specified by:

addListener in interface IAnimationController

attach

public void attach()

Attach the AnimationController, as well as all its Animations to the Game loop.

See Also:

ILoop

clear

public void clear()

Description copied from interface: IAnimationController

Remove all Animations from the AnimationController.

Specified by:

clear in interface IAnimationController

detach

public void detach()

Detach the AnimationController, as well as all its Animations from the Game loop.

See Also:

ILoop

get

public Animation get(java.lang.String animationName)

Specified by:

get in interface IAnimationController

getAffineTransform

public java.awt.geom.AffineTransform getAffineTransform()

Specified by:

getAffineTransform in interface IAnimationController

getAll

public java.util.Collection<Animation> getAll()

Specified by:

getAll in interface IAnimationController

getCurrent

public Animation getCurrent()

Specified by:

getCurrent in interface IAnimationController

getCurrentSprite

public java.awt.image.BufferedImage getCurrentSprite()

Specified by:

getCurrentSprite in interface IAnimationController

getCurrentSprite

public java.awt.image.BufferedImage getCurrentSprite(int width,
                                                     int height)

Specified by:

getCurrentSprite in interface IAnimationController

getDefault

public Animation getDefault()

Specified by:

getDefault in interface IAnimationController

getImageEffects

public java.util.List<ImageEffect> getImageEffects()

Specified by:

getImageEffects in interface IAnimationController

hasAnimation

public boolean hasAnimation(java.lang.String animationName)

Specified by:

hasAnimation in interface IAnimationController

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface IAnimationController

isPlaying

public boolean isPlaying(java.lang.String animationName)

Specified by:

isPlaying in interface IAnimationController

play

public void play(java.lang.String animationName)

Specified by:

play in interface IAnimationController

remove

public void remove(Animation animation)

Specified by:

remove in interface IAnimationController

remove

public void remove(ImageEffect effect)

Specified by:

remove in interface IAnimationController

removeListener

public void removeListener(AnimationListener listener)

Specified by:

removeListener in interface IAnimationController

setAffineTransform

public void setAffineTransform(java.awt.geom.AffineTransform affineTransform)

Specified by:

setAffineTransform in interface IAnimationController

setDefault

public void setDefault(Animation defaultAnimation)

Specified by:

setDefault in interface IAnimationController

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface IAnimationController

update

public void update()

Description copied from interface: IUpdateable

This method is called by the game loop on all objects that are attached to the loop. It's called on every tick of the loop and the frequency can be configured using the ClientConfiguration.

Specified by:

update in interface IUpdateable

See Also:

ClientConfiguration.setMaxFps(int)

buildCurrentCacheKey

protected java.lang.String buildCurrentCacheKey()

Build a unique cache key for the current frame. The spritesheet's hashCode, the current keyframe's sprite index, as well as all applied ImageEffects' names, are considered when determining the current cache key.

Returns:

the unique cache key for the current key frame