de.smits_net.games.framework.image

Class ImagePack

java.lang.Object

de.smits_net.games.framework.image.ImageBase

de.smits_net.games.framework.image.ImagePack

All Implemented Interfaces:

java.lang.Iterable<java.awt.image.BufferedImage>

Direct Known Subclasses:

TiledImage

public class ImagePack
extends ImageBase
implements java.lang.Iterable<java.awt.image.BufferedImage>

A pack (collection) of images. This class can be used if more than one image has to be transferred. It can also contain only one image. The class has one "current" image, which can be retrieved using the getImage() method. The user can cycle through the images with the cycle() method.

Author:

Thomas Smits

Field Summary

Fields

Modifier and Type	Field and Description
protected int	currentImage Image currently displayed, used for cycling through the images.
protected java.util.List<java.awt.image.BufferedImage>	imageList The images.

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

imageCache

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImagePack() Constructor for internal use.
	ImagePack(java.awt.image.BufferedImage... images) Creates a new set of images.
	ImagePack(java.lang.String path, java.lang.String... fileNames) Creates a new set of images.

Method Summary

Modifier and Type	Method and Description
void	addImage(java.awt.Image img) Adds an image to the stack.
java.awt.Image	cycle() Cycle through the images.
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.
java.awt.image.BufferedImage	getImage() Gets the current image.
java.awt.image.BufferedImage	getImage(int index) Gets the image at the given position.
java.util.Iterator<java.awt.image.BufferedImage>	iterator()
int	size() Number of the images stored.

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

currentImage

protected int currentImage

Image currently displayed, used for cycling through the images.

imageList

protected java.util.List<java.awt.image.BufferedImage> imageList

The images.

Constructor Detail

ImagePack

protected ImagePack()

Constructor for internal use.

ImagePack

public ImagePack(java.awt.image.BufferedImage... images)

Creates a new set of images.

Parameters:

images - to be stored

ImagePack

public ImagePack(java.lang.String path,
                 java.lang.String... fileNames)

Creates a new set of images.

Parameters:

path - path to the image

fileNames - names of the files to be loaded

Method Detail

addImage

public void addImage(java.awt.Image img)

Adds an image to the stack.

Parameters:

img - the image.

cycle

public java.awt.Image cycle()

Cycle through the images.

Returns:

the current image

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)

getImage

public java.awt.image.BufferedImage getImage()

Gets the current image.

Returns:

the current image.

getImage

public java.awt.image.BufferedImage getImage(int index)

Gets the image at the given position.

Parameters:

index - position of the image

Returns:

the image at the position.

iterator

public java.util.Iterator<java.awt.image.BufferedImage> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.awt.image.BufferedImage>

See Also:

Iterable.iterator()

size

public int size()

Number of the images stored.

Returns:

the number of images.