jhelp.util.gui

Class JHelpAnimatedImage

java.lang.Object

jhelp.util.gui.JHelpAnimatedImage

public class JHelpAnimatedImage
extends java.lang.Object

Animate an image on using frames .
A frame is an image to draw over the current image at a specified position on a specified time.
Animation can be play in 2 modes, LOOP or REVESE. For example if animation is made with frame 1, to 4, LOOP will do 1, 2, 3, 4, 1, 2, 3, 4, 1, 2, 3, 4, 1, 2, 3, 4, 1, 2, ... and REVESE 1,2 3, 4, 3, 2, 1, 2, 3, 4, 3, 2, 1, 2, ...

Author:

JHelp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JHelpAnimatedImage.AnimationFrame Represents a frame of the animation
static class	JHelpAnimatedImage.AnimationMode Animation mode

Field Summary

Fields

Modifier and Type	Field and Description
private JHelpAnimatedImage.AnimationMode	animationMode Actual mode
private java.util.ArrayList<JHelpAnimatedImage.AnimationFrame>	frames Frames
private JHelpImage	imageToRefresh Image where draw the animation
private int	index Actual frame index
private int	timePass Time passed in the current frame
private int	way Actual way for changing frames

Constructor Summary

Constructors

Constructor and Description
JHelpAnimatedImage(JHelpImage imageToRefresh, JHelpAnimatedImage.AnimationMode animationMode) Create a new instance of JHelpAnimatedImage

Method Summary

Methods

Modifier and Type	Method and Description
void	addFrame(JHelpAnimatedImage.AnimationFrame animationFrame) Add a frame to the animation
void	addFrame(JHelpImage image, int x, int y, int time) Add a frame
java.util.List<JHelpAnimatedImage.AnimationFrame>	getAnimationFrames() List of animations
JHelpAnimatedImage.AnimationMode	getAnimatonMode() Animation mode
void	nextTime() Signal to animation that one unit of time passed, and refresh the image if need
private void	refreshImage() Refresh the image
void	start() Start the animation, or restart the animation from the start

Methods inherited from class java.lang.Object

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

Field Detail

animationMode

private final JHelpAnimatedImage.AnimationMode animationMode

Actual mode

frames

private final java.util.ArrayList<JHelpAnimatedImage.AnimationFrame> frames

Frames

imageToRefresh

private final JHelpImage imageToRefresh

Image where draw the animation

index

private int index

Actual frame index

timePass

private int timePass

Time passed in the current frame

way

private int way

Actual way for changing frames

Constructor Detail

JHelpAnimatedImage

public JHelpAnimatedImage(JHelpImage imageToRefresh,
                  JHelpAnimatedImage.AnimationMode animationMode)

Create a new instance of JHelpAnimatedImage

Parameters:

imageToRefresh - Image where draw animation

animationMode - Mode to use

Method Detail

refreshImage

private void refreshImage()

Refresh the image

addFrame

public void addFrame(JHelpAnimatedImage.AnimationFrame animationFrame)

Add a frame to the animation

Parameters:

animationFrame - Frame to add

addFrame

public void addFrame(JHelpImage image,
            int x,
            int y,
            int time)

Add a frame

Parameters:

image - Image to draw

x - X position

y - Y position

time - Time duration

getAnimationFrames

public java.util.List<JHelpAnimatedImage.AnimationFrame> getAnimationFrames()

List of animations

Returns:

List of animations

getAnimatonMode

public JHelpAnimatedImage.AnimationMode getAnimatonMode()

Animation mode

Returns:

Animation mode

nextTime

public void nextTime()

Signal to animation that one unit of time passed, and refresh the image if need

start

public void start()

Start the animation, or restart the animation from the start