net.stemkoski.bagel

Class Animation

java.lang.Object

net.stemkoski.bagel.Animation

public class Animation
extends java.lang.Object

A sequence of Textures displayed in rapid succession to create the appearance of movement. Animation objects are created using the load(String, int, int, double, boolean) method. Multiple instances of a Sprite should not share a single Animation reference, as each Sprite will require its own elapsedTime field; in this case, use the clone() method to create a copy of the original Animation.

Field Summary

Fields

Modifier and Type	Field and Description
Texture	currentTexture The texture that should be displayed by this animation, according to the amount of time that has elapsed (elapsedTime).
(package private) double	elapsedTime The amount of time that has elapsed since this animation began playing.
(package private) double	frameDuration The amount of time each texture should be displayed by this animation.
(package private) boolean	loop Determines if this animation should repeat after displaying the last texture in the list.
boolean	paused Determines if this animation should stop updating.
(package private) java.util.ArrayList<Texture>	textureList List of the textures that will be displayed in sequence by this animation.
(package private) double	totalDuration The total amount of time required to display all textures in this animation.

Constructor Summary

Constructors

Constructor and Description
Animation() Create an empty animation.

Method Summary

Modifier and Type	Method and Description
Animation	clone()
boolean	isFinished() Determines if this animation has finished playing.
static Animation	load(java.lang.String imageFileName, int rows, int cols, double frameDuration, boolean loop) Create an animation object from a sprite sheet.
void	update(double dt) Update elapsedTime and currentTexture based on the amount of time that has passed since last update.

Methods inherited from class java.lang.Object

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

Field Detail

currentTexture

public Texture currentTexture

The texture that should be displayed by this animation, according to the amount of time that has elapsed (elapsedTime).

paused

public boolean paused

Determines if this animation should stop updating.

textureList

java.util.ArrayList<Texture> textureList

List of the textures that will be displayed in sequence by this animation.

frameDuration

double frameDuration

The amount of time each texture should be displayed by this animation.

loop

boolean loop

Determines if this animation should repeat after displaying the last texture in the list.

elapsedTime

double elapsedTime

The amount of time that has elapsed since this animation began playing.

totalDuration

double totalDuration

The total amount of time required to display all textures in this animation.

Constructor Detail

Animation

Animation()

Create an empty animation. Useful when reusing a previously loaded image; used by clone().

Method Detail

update

public void update(double dt)

Update elapsedTime and currentTexture based on the amount of time that has passed since last update.

Parameters:

dt - amount of time that has passed since the last iteration of the game loop

isFinished

public boolean isFinished()

Determines if this animation has finished playing. Calculated by elapsed time, number of textures, frame duration, and loop.

Returns:

true if this animation has finished playing

clone

public Animation clone()

Overrides:

clone in class java.lang.Object

load

public static Animation load(java.lang.String imageFileName,
                             int rows,
                             int cols,
                             double frameDuration,
                             boolean loop)

Create an animation object from a sprite sheet.

Parameters:

imageFileName - name of image file

rows - number of rows of individual images in file

cols - number of columns of individual images in file

frameDuration - amount of time to display each individual image

loop - whether this animation should repeat after last image is displayed

Returns:

an Animation created according to the given parameters