Class AnimationController

java.lang.Object

de.gurkenlabs.litiengine.graphics.animation.AnimationController

All Implemented Interfaces:

IAnimationController, IUpdateable

Direct Known Subclasses:

EntityAnimationController

public class AnimationController
extends Object
implements IAnimationController

Constructor Summary

Constructors

Constructor	Description
AnimationController()	Initializes a new instance of the AnimationController class.
AnimationController(Animation defaultAnimation)	Initializes a new instance of the AnimationController class with the specified default animation.
AnimationController(Animation defaultAnimation, Animation... animations)	Initializes a new instance of the AnimationController class with the specified default animation.
AnimationController(Spritesheet sprite)	Initializes a new instance of the AnimationController class with the specified default animation.
AnimationController(Spritesheet sprite, boolean loop)	Initializes a new instance of the AnimationController class with the specified default animation.

Method Summary

Modifier and Type	Method	Description
void	add(Animation animation)	Add the specified Animation to this controller instance.
void	add(ImageEffect effect)	Adds the specified ImageEffect to be applied when the current image is retrieved from this controller.
void	addListener(AnimationListener listener)	Adds the specified animation listener to receive events and callbacks when animation playbacks are started and finished.
void	attach()	Attach the AnimationController, as well as all its Animations to the Game loop.
protected 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.
static Animation	flippedAnimation(Animation anim, String newSpriteName, boolean vertical)	Creates a new animation with the sprites flipped either vertically or horizontally.
Animation	get(String animationName)	Gets the Animation instance with the specified name from this controller.
AffineTransform	getAffineTransform()	Gets the AffineTransform instance assigned to this controller that can be used to externally transform the current image when rendering it with the ImageRenderer.
Collection<Animation>	getAll()	Gets all Animation instances managed by this controller.
Animation	getCurrent()	Gets the currently active Animation of this controller.
BufferedImage	getCurrentImage()	Gets the current sprite (keyframe) of the currently active animation of this controller.
BufferedImage	getCurrentImage(int width, int height)	Gets the current sprite scaled by the specified dimensions of the currently active animation of this controller.
Animation	getDefault()	Gets the default Animation of this controller.
List<ImageEffect>	getImageEffects()	Gets all image effects assigned to this controller.
boolean	hasAnimation(String animationName)	Determines whether this controller has an Animation with the specified name.
boolean	isEnabled()	Determines whether this controller is currently enabled.
boolean	isPlaying(String animationName)	Determines whether this controller is currently playing an Animation with the specified name.
void	play(String animationName)	Plays the Animation with the specified name.
void	remove(Animation animation)	Removes the specified Animation from this controller instance.
void	remove(ImageEffect effect)	Removes the specified ImageEffect from this controller.
void	removeListener(AnimationListener listener)	Removes the specified animation listener.
void	setAffineTransform(AffineTransform affineTransform)	Sets the AffineTransform instance for this controller that can be used to externally transform the current image when rendering it with the ImageRenderer.
void	setDefault(Animation defaultAnimation)	Sets the specified Animation as default for this controller.
void	setEnabled(boolean enabled)	Sets a flag that defines whether this controller is enabled or not.
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 Details

AnimationController

public AnimationController()

Initializes a new instance of the AnimationController class.

AnimationController

public AnimationController(Animation defaultAnimation)

Initializes a new instance of the AnimationController class with the specified default animation.

Parameters:

defaultAnimation - The default animation for this controller.

See Also:

• getDefault()

AnimationController

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

Initializes a new instance of the AnimationController class with the specified default animation.

Parameters:

defaultAnimation - The default animation for this controller.

animations - Additional animations that are managed by this controller instance.

See Also:

• getDefault()
• getAll()

AnimationController

public AnimationController(Spritesheet sprite)

Initializes a new instance of the AnimationController class with the specified default animation.

Parameters:

sprite - The sprite sheet used by the default animation of this controller.

AnimationController

public AnimationController(Spritesheet sprite,
 boolean loop)

Initializes a new instance of the AnimationController class with the specified default animation.

Parameters:

sprite - The sprite sheet used by the default animation of this controller.

loop - A flag indicating whether the default animation should be looped or only played once.

Method Details

flippedAnimation

public static Animation flippedAnimation(Animation anim,
 String newSpriteName,
 boolean vertical)

Creates a new animation with the sprites flipped either vertically or horizontally.

Parameters:

anim - The original animation to be flipped.

newSpriteName - The name for the new flipped spritesheet.

vertical - A boolean flag indicating whether to flip the sprites vertically. If false, the sprites will be flipped horizontally.

Returns:

A new Animation object with the flipped sprites.

add

public void add(Animation animation)

Description copied from interface: IAnimationController

Add the specified Animation to this controller instance.

Animations with the same name will be replaced by this method.

Specified by:

add in interface IAnimationController

Parameters:

animation - The animation to add.

See Also:

• IAnimationController.remove(Animation)
• IAnimationController.hasAnimation(String)
• IAnimationController.clear()

add

public void add(ImageEffect effect)

Description copied from interface: IAnimationController

Adds the specified ImageEffect to be applied when the current image is retrieved from this controller.

Specified by:

add in interface IAnimationController

Parameters:

effect - The image effect to be added.

addListener

public void addListener(AnimationListener listener)

Description copied from interface: IAnimationController

Adds the specified animation listener to receive events and callbacks when animation playbacks are started and finished.

Specified by:

addListener in interface IAnimationController

Parameters:

listener - The listener to add.

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(String animationName)

Description copied from interface: IAnimationController

Gets the Animation instance with the specified name from this controller.

The name of an Animation is case sensitive.

Specified by:

get in interface IAnimationController

Parameters:

animationName - The name of the animation.

Returns:

The animation with the specified name or null if no such animation is managed by this controller.

See Also:

• IAnimationController.getCurrent()
• IAnimationController.getDefault()
• IAnimationController.hasAnimation(String)

getAffineTransform

public AffineTransform getAffineTransform()

Description copied from interface: IAnimationController

Gets the AffineTransform instance assigned to this controller that can be used to externally transform the current image when rendering it with the ImageRenderer.

Specified by:

getAffineTransform in interface IAnimationController

Returns:

The AffineTransform instance assigned to this controller or null.

See Also:

• AffineTransform
• ImageRenderer.renderTransformed(java.awt.Graphics2D, java.awt.Image, AffineTransform)
• IAnimationController.setAffineTransform(AffineTransform)
• IAnimationController.getCurrentImage()

getAll

public Collection<Animation> getAll()

Description copied from interface: IAnimationController

Gets all Animation instances managed by this controller.

Specified by:

getAll in interface IAnimationController

Returns:

All Animation instances.

getCurrent

public Animation getCurrent()

Description copied from interface: IAnimationController

Gets the currently active Animation of this controller.

The current active animation provides the current image that is being rendered by consumers of this controller (e.g. the render engine or any explicit, custom render mechanism).

Specified by:

getCurrent in interface IAnimationController

Returns:

The currently active animation.

See Also:

• IAnimationController.getDefault()
• IAnimationController.get(String)
• RenderEngine.renderEntity(java.awt.Graphics2D, de.gurkenlabs.litiengine.entities.IEntity)

getCurrentImage

public BufferedImage getCurrentImage()

Description copied from interface: IAnimationController

Gets the current sprite (keyframe) of the currently active animation of this controller.

The implementation of this method applies all registered ImageEffects.

Specified by:

getCurrentImage in interface IAnimationController

Returns:

The current sprite of the current animation with applied effects; or null, if this controller is currently disabled.

See Also:

• IAnimationController.getCurrent()
• Animation.getCurrentKeyFrame()
• IAnimationController.isEnabled()

getCurrentImage

public BufferedImage getCurrentImage(int width,
 int height)

Description copied from interface: IAnimationController

Gets the current sprite scaled by the specified dimensions of the currently active animation of this controller.

The implementation of this method applies all registered ImageEffects.

Specified by:

getCurrentImage in interface IAnimationController

Parameters:

width - The width of the image.

height - The height of the image.

Returns:

The current sprite of the current animation scaled by the defined dimensions with applied effects; or null, if this controller is currently disabled.

See Also:

• IAnimationController.getCurrent()
• IAnimationController.getCurrentImage()
• Animation.getCurrentKeyFrame()
• IAnimationController.isEnabled()

getDefault

public Animation getDefault()

Description copied from interface: IAnimationController

Gets the default Animation of this controller.

This animation is played when no other animation is currently active.

Specified by:

getDefault in interface IAnimationController

Returns:

The default animation of this controller.

See Also:

• IAnimationController.getCurrent()
• IAnimationController.get(String)
• IAnimationController.setDefault(Animation)

getImageEffects

public List<ImageEffect> getImageEffects()

Description copied from interface: IAnimationController

Gets all image effects assigned to this controller.

Specified by:

getImageEffects in interface IAnimationController

Returns:

All image effects of this controller.

See Also:

• IAnimationController.add(ImageEffect)
• IAnimationController.remove(ImageEffect)

hasAnimation

public boolean hasAnimation(String animationName)

Description copied from interface: IAnimationController

Determines whether this controller has an Animation with the specified name.

The name of an Animation is case sensitive.

Specified by:

hasAnimation in interface IAnimationController

Parameters:

animationName - The name of the animation.

Returns:

True if this controller contains an Animation with the specified name; otherwise false.

See Also:

• IAnimationController.add(Animation)
• IAnimationController.remove(Animation)

isEnabled

public boolean isEnabled()

Description copied from interface: IAnimationController

Determines whether this controller is currently enabled.

Specified by:

isEnabled in interface IAnimationController

Returns:

True if this controller is enabled; otherwise false.

isPlaying

public boolean isPlaying(String animationName)

Description copied from interface: IAnimationController

Determines whether this controller is currently playing an Animation with the specified name.

The name of an Animation is case sensitive.

Specified by:

isPlaying in interface IAnimationController

Parameters:

animationName - The name of the animation.

Returns:

True if this controller is currently playing the Animation with the specified name.

See Also:

• IAnimationController.getCurrent()

play

public void play(String animationName)

Description copied from interface: IAnimationController

Plays the Animation with the specified name.

Does nothing if this controller doesn't contain an Animation with the specified name.

This method also publishes the "played" event to all subscribed AnimationListener instances.

Specified by:

play in interface IAnimationController

Parameters:

animationName - The name of the Animation to be played.

See Also:

• AnimationListener.played(Animation)
• IAnimationController.getCurrent()

remove

public void remove(Animation animation)

Description copied from interface: IAnimationController

Removes the specified Animation from this controller instance.

Specified by:

remove in interface IAnimationController

Parameters:

animation - The animation to remove.

See Also:

• IAnimationController.add(Animation)
• IAnimationController.hasAnimation(String)
• IAnimationController.clear()

remove

public void remove(ImageEffect effect)

Description copied from interface: IAnimationController

Removes the specified ImageEffect from this controller.

Specified by:

remove in interface IAnimationController

Parameters:

effect - The image effect to be removed.

removeListener

public void removeListener(AnimationListener listener)

Description copied from interface: IAnimationController

Removes the specified animation listener.

Specified by:

removeListener in interface IAnimationController

Parameters:

listener - The listener to remove.

setAffineTransform

public void setAffineTransform(AffineTransform affineTransform)

Description copied from interface: IAnimationController

Sets the AffineTransform instance for this controller that can be used to externally transform the current image when rendering it with the ImageRenderer.

Specified by:

setAffineTransform in interface IAnimationController

Parameters:

affineTransform - The AffineTransform instance for this controller.

See Also:

• AffineTransform
• IAnimationController.getAffineTransform()

setDefault

public void setDefault(Animation defaultAnimation)

Description copied from interface: IAnimationController

Sets the specified Animation as default for this controller.

Specified by:

setDefault in interface IAnimationController

Parameters:

defaultAnimation - The animation to be set as default.

See Also:

• IAnimationController.getDefault()

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: IAnimationController

Sets a flag that defines whether this controller is enabled or not.

Specified by:

setEnabled in interface IAnimationController

Parameters:

enabled - True if the controller should be enabled; otherwise false.

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 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