org.simbrain.world.odorworld.entities

Class Animation

java.lang.Object

org.simbrain.world.odorworld.entities.Animation

public class Animation
extends java.lang.Object

The Animation class manages a series of images (frames) and the amount of time to display each frame.

Author:

David Brackeen, Lam Nguyen, Jeff Yoshimi

Constructor Summary

Constructors

Constructor and Description
Animation(java.lang.String imageLocation) An animation with a single image; equivalent to a static image.
Animation(java.lang.String[] imageLocations, long frameDuration) Creates an animation from a list of images, specified in terms of their file locations.

Method Summary

Modifier and Type	Method and Description
void	addFrame(java.awt.Image image, long frameDuration) Adds an image to the animation with the specified duration (time to display the image).
java.awt.Image	getImage() Gets this Animation's current image.
java.lang.String[]	getImageLocations()
void	initializeImages() Initialize images relative to their locations.
void	start() Starts this animation over from the beginning.
void	update() Updates this animation's current image (frame), if necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

Animation

public Animation(java.lang.String[] imageLocations,
                 long frameDuration)

Creates an animation from a list of images, specified in terms of their file locations.

Parameters:

imageLocations - array of image locations.

frameDuration - time to display each frame.

Animation

public Animation(java.lang.String imageLocation)

An animation with a single image; equivalent to a static image.

Parameters:

imageLocation - file name of image

Method Detail

addFrame

public void addFrame(java.awt.Image image,
                     long frameDuration)

Adds an image to the animation with the specified duration (time to display the image).

Parameters:

image -

frameDuration -

start

public void start()

Starts this animation over from the beginning.

update

public void update()

Updates this animation's current image (frame), if necessary.

getImage

public java.awt.Image getImage()

Gets this Animation's current image. Returns null if this animation has no images.

Returns:

the image associated with the current frame.

getImageLocations

public java.lang.String[] getImageLocations()

Returns:

the imageNames

initializeImages

public void initializeImages()

Initialize images relative to their locations. Used when opening saved odor world files.