de.smits_net.games.framework.image

Class AnimatedImage

java.lang.Object

de.smits_net.games.framework.image.ImageBase

de.smits_net.games.framework.image.AnimatedImage

public class AnimatedImage
extends ImageBase

A set of images that form an animated image. The difference to the ImagePack is that the class automatically tracks the time that passed since the last draw call and changes the image automatically if the requested animatedImage time has passed.

Author:

Thomas Smits

Field Summary

Fields

Modifier and Type	Field and Description
protected ImagePack	images The images comprising the animatedImage.
protected long	lastRun Last change of the sprite.
protected int	time Time between two frames in milliseconds.

Fields inherited from class de.smits_net.games.framework.image.ImageBase

imageCache

Constructor Summary

Constructors

Constructor and Description
AnimatedImage(int time, boolean wrapAround, ImagePack images) Creates a new animatedImage object.
AnimatedImage(int time, boolean wrapAround, java.lang.String path, java.lang.String... fileNames) Convenience constructor that creates the image pack for the caller to make usage easier.
AnimatedImage(int time, ImagePack images) Creates a new object.
AnimatedImage(int time, int number, java.lang.String imageFilePath) Convenience constructor that creates the striped image for the caller to make usage easier.
AnimatedImage(int time, java.lang.String path, java.lang.String... fileNames) Convenience constructor that creates the image pack for the caller to make usage easier.

Method Summary

Modifier and Type	Method and Description
void	draw(java.awt.Graphics g, java.awt.Point position, java.awt.image.ImageObserver observer) Draw the image at the given position.
java.awt.Dimension	getDimension() Dimension of the image.
ImagePack	getImages() Returns the images comprising the animatedImage.
AnimatedImage	getSubAnimation(int start, int end) Returns an animation that contains the images from this animation starting with picture start (inclusive) up to picture end (exclusive).
int	getTime() Returns the time before the image is changed.

Methods inherited from class de.smits_net.games.framework.image.ImageBase

loadImage, loadImage, toBufferedImage

Methods inherited from class java.lang.Object

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

Field Detail

images

protected ImagePack images

The images comprising the animatedImage.

lastRun

protected long lastRun

Last change of the sprite.

time

protected int time

Time between two frames in milliseconds.

Constructor Detail

AnimatedImage

public AnimatedImage(int time,
                     boolean wrapAround,
                     ImagePack images)

Creates a new animatedImage object.

Parameters:

time - the time one image is shown in milliseconds

wrapAround - if set to true the animation cycles infinitely through the images. If set to false it stops at the last image.

images - the images comprising the animatedImage

AnimatedImage

public AnimatedImage(int time,
                     boolean wrapAround,
                     java.lang.String path,
                     java.lang.String... fileNames)

Convenience constructor that creates the image pack for the caller to make usage easier.

Parameters:

time - the time one image is shown in milliseconds

wrapAround - if set to true the animation cycles infinitely through the images. If set to false it stops at the last image.

path - path to the image

fileNames - names of the files to be loaded

AnimatedImage

public AnimatedImage(int time,
                     ImagePack images)

Creates a new object. The animation will cycle infinitely through the provided images.

Parameters:

time - the time one image is shown in milliseconds

images - the images comprising the animatedImage

AnimatedImage

public AnimatedImage(int time,
                     int number,
                     java.lang.String imageFilePath)

Convenience constructor that creates the striped image for the caller to make usage easier.

Parameters:

time - the time one image is shown in milliseconds

number - the number of elements

imageFilePath - the striped image

AnimatedImage

public AnimatedImage(int time,
                     java.lang.String path,
                     java.lang.String... fileNames)

Convenience constructor that creates the image pack for the caller to make usage easier.

Parameters:

time - the time one image is shown in milliseconds

path - path to the image

fileNames - names of the files to be loaded

Method Detail

draw

public void draw(java.awt.Graphics g,
                 java.awt.Point position,
                 java.awt.image.ImageObserver observer)

Description copied from class: ImageBase

Draw the image at the given position.

Specified by:

draw in class ImageBase

Parameters:

g - graphics context

position - position to draw image at

observer - image observer

getDimension

public java.awt.Dimension getDimension()

Description copied from class: ImageBase

Dimension of the image.

Specified by:

getDimension in class ImageBase

Returns:

the dimension (in pixel)

getImages

public ImagePack getImages()

Returns the images comprising the animatedImage.

Returns:

the images

getSubAnimation

public AnimatedImage getSubAnimation(int start,
                                     int end)

Returns an animation that contains the images from this animation starting with picture start (inclusive) up to picture end (exclusive).

Parameters:

start - index of the first picture of the animation

end - index of the last picture (exclusive) of the animation

Returns:

a new animation with the selected images

getTime

public int getTime()

Returns the time before the image is changed.

Returns:

time in milliseconds