de.gurkenlabs.litiengine.graphics.animation

Class PropAnimationController<T extends Prop>

java.lang.Object

de.gurkenlabs.litiengine.graphics.animation.AnimationController

de.gurkenlabs.litiengine.graphics.animation.EntityAnimationController<T>

de.gurkenlabs.litiengine.graphics.animation.PropAnimationController<T>

All Implemented Interfaces:

IEntityController, IAnimationController, IEntityAnimationController<T>, IUpdateable

public class PropAnimationController<T extends Prop>
extends EntityAnimationController<T>

Nested Class Summary

Nested classes/interfaces inherited from class de.gurkenlabs.litiengine.graphics.animation.EntityAnimationController

EntityAnimationController.AnimationRule<T extends IEntity>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
PropAnimationController(T prop) Initializes a new instance of the PropAnimationController class.

Method Summary

Modifier and Type	Method and Description
java.awt.image.BufferedImage	getCurrentImage() Gets the current sprite (keyframe) of the currently active animation of this controller.
static java.lang.String	getSpriteName(Prop prop, boolean appendState) Gets the sprite name for the specified prop and state.
static java.lang.String	getSpriteName(Prop prop, PropState state, boolean appendState) Gets the sprite name for the specified prop and state.
boolean	isAutoScaling() Gets a flag indicating whether this controller instance is auto scaling its animations by the dimensions of the entity.
void	update() This method is called by the game loop on all objects that are attached to the loop.

Methods inherited from class de.gurkenlabs.litiengine.graphics.animation.EntityAnimationController

addRule, addRule, getDefaultSpritePrefixes, getEntity, getSpritePrefix, scaleSprite, scaleSprite, setAutoScaling, setSpritePrefix

Methods inherited from class de.gurkenlabs.litiengine.graphics.animation.AnimationController

add, add, addListener, attach, buildCurrentCacheKey, clear, detach, get, getAffineTransform, getAll, getCurrent, getCurrentImage, getDefault, getImageEffects, hasAnimation, isEnabled, isPlaying, play, remove, remove, removeListener, setAffineTransform, setDefault, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gurkenlabs.litiengine.graphics.animation.IAnimationController

add, add, addListener, clear, get, getAffineTransform, getAll, getCurrent, getCurrentImage, getDefault, getImageEffects, hasAnimation, isEnabled, isPlaying, play, remove, remove, removeListener, setAffineTransform, setDefault, setEnabled

Methods inherited from interface de.gurkenlabs.litiengine.entities.IEntityController

attach, detach

Field Detail

PROP_IDENTIFIER

public static final java.lang.String PROP_IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

PropAnimationController

public PropAnimationController(T prop)

Initializes a new instance of the PropAnimationController class.

Parameters:

prop - The prop related to this controller.

Method Detail

getSpriteName

public static java.lang.String getSpriteName(Prop prop,
                                             boolean appendState)

Gets the sprite name for the specified prop and state.

Parameters:

prop - The prop to retrieve the sprite name for.

appendState - A flag indicating whether the state should be appended to the name.

Returns:

A string representing the sprite name for the specified prop in its state.

See Also:

Prop.getSpritesheetName(), Prop.getState()

getSpriteName

public static java.lang.String getSpriteName(Prop prop,
                                             PropState state,
                                             boolean appendState)

Gets the sprite name for the specified prop and state.

Parameters:

prop - The prop to retrieve the sprite name for.

state - The state of the prop.

appendState - A flag indicating whether the state should be appended to the name.

Returns:

A string representing the sprite name for the specified prop in its state.

See Also:

Prop.getSpritesheetName(), Prop.getState()

getCurrentImage

public java.awt.image.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

Overrides:

getCurrentImage in class AnimationController

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

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

Overrides:

update in class EntityAnimationController<T extends Prop>

See Also:

ClientConfiguration.setMaxFps(int)

isAutoScaling

public boolean isAutoScaling()

Description copied from interface: IEntityAnimationController

Gets a flag indicating whether this controller instance is auto scaling its animations by the dimensions of the entity.

Specified by:

isAutoScaling in interface IEntityAnimationController<T extends Prop>

Overrides:

isAutoScaling in class EntityAnimationController<T extends Prop>

Returns:

True if this instance is automatically scaling to the dimensions of the entity; otherwise false.