Package de.gurkenlabs.litiengine.graphics.animation

Interface IAnimationController

All Superinterfaces:

IUpdateable

All Known Subinterfaces:

IEntityAnimationController<T>

All Known Implementing Classes:

AnimationController, CreatureAnimationController, EntityAnimationController, PropAnimationController

public interface IAnimationController
extends IUpdateable

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	clear()	Remove all Animations from the AnimationController.
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 animation)	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.

Methods inherited from interface de.gurkenlabs.litiengine.IUpdateable

update

Method Details

addListener

void addListener(AnimationListener listener)

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

Parameters:

listener - The listener to add.

removeListener

void removeListener(AnimationListener listener)

Removes the specified animation listener.

Parameters:

listener - The listener to remove.

add

void add(Animation animation)

Add the specified Animation to this controller instance.

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

Parameters:

animation - The animation to add.

See Also:

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

remove

void remove(Animation animation)

Removes the specified Animation from this controller instance.

Parameters:

animation - The animation to remove.

See Also:

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

clear

void clear()

Remove all Animations from the AnimationController.

getAll

Collection<Animation> getAll()

Gets all Animation instances managed by this controller.

Returns:

All Animation instances.

get

Animation get(String animationName)

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

The name of an Animation is case sensitive.

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:

• getCurrent()
• getDefault()
• hasAnimation(String)

getCurrent

Animation getCurrent()

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

Returns:

The currently active animation.

See Also:

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

getDefault

Animation getDefault()

Gets the default Animation of this controller.

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

Returns:

The default animation of this controller.

See Also:

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

hasAnimation

boolean hasAnimation(String animationName)

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

The name of an Animation is case sensitive.

Parameters:

animationName - The name of the animation.

Returns:

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

See Also:

• add(Animation)
• remove(Animation)

isPlaying

boolean isPlaying(String animationName)

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

The name of an Animation is case sensitive.

Parameters:

animationName - The name of the animation.

Returns:

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

See Also:

• getCurrent()

play

void play(String animationName)

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.

Parameters:

animationName - The name of the Animation to be played.

See Also:

• AnimationListener.played(Animation)
• getCurrent()

setDefault

void setDefault(Animation animation)

Sets the specified Animation as default for this controller.

Parameters:

animation - The animation to be set as default.

See Also:

• getDefault()

getCurrentImage

BufferedImage getCurrentImage()

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

The implementation of this method applies all registered ImageEffects.

Returns:

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

See Also:

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

getCurrentImage

BufferedImage getCurrentImage(int width,
 int height)

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.

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:

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

getAffineTransform

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.

Returns:

The AffineTransform instance assigned to this controller or null.

See Also:

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

setAffineTransform

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.

Parameters:

affineTransform - The AffineTransform instance for this controller.

See Also:

• AffineTransform
• getAffineTransform()

add

void add(ImageEffect effect)

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

Parameters:

effect - The image effect to be added.

remove

void remove(ImageEffect effect)

Removes the specified ImageEffect from this controller.

Parameters:

effect - The image effect to be removed.

getImageEffects

List<ImageEffect> getImageEffects()

Gets all image effects assigned to this controller.

Returns:

All image effects of this controller.

See Also:

• add(ImageEffect)
• remove(ImageEffect)

isEnabled

boolean isEnabled()

Determines whether this controller is currently enabled.

Returns:

True if this controller is enabled; otherwise false.

setEnabled

void setEnabled(boolean enabled)

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

Parameters:

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