com.enterprisemath.utils.image

Class ConstantFileImageAnimation

java.lang.Object

com.enterprisemath.utils.image.ConstantFileImageAnimation

All Implemented Interfaces:

ImageAnimation

public class ConstantFileImageAnimation
extends Object
implements ImageAnimation

Implementation of image animation which takes frames from one constant file image. One image is used for all frames.

Author:

radek.hecl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConstantFileImageAnimation.Builder Builder object.

Constructor Summary

Constructors

Constructor and Description
ConstantFileImageAnimation(ConstantFileImageAnimation.Builder builder) Creates new instance.

Method Summary

Modifier and Type	Method and Description
static ConstantFileImageAnimation	create(String framePath, int frameDuration, int numFrames) Creates new instance.
RenderedImage	getFrame(int index) Returns the frame on the the specified index.
int	getFrameDuration() Returns duration of one frame in milliseconds.
int	getFrameHeight() Returns frame height.
int	getFrameWidth() Returns frame width.
int	getNumFrames() Returns total number of frames.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantFileImageAnimation

public ConstantFileImageAnimation(ConstantFileImageAnimation.Builder builder)

Creates new instance.

Parameters:

builder - builder object

Method Detail

getFrameWidth

public int getFrameWidth()

Description copied from interface: ImageAnimation

Returns frame width. Implementation is responsible to keep all the frames with this width.

Specified by:

getFrameWidth in interface ImageAnimation

Returns:

frame width

getFrameHeight

public int getFrameHeight()

Description copied from interface: ImageAnimation

Returns frame height. Implementation is responsible to keep all the frames with this height.

Specified by:

getFrameHeight in interface ImageAnimation

Returns:

frame height

getNumFrames

public int getNumFrames()

Description copied from interface: ImageAnimation

Returns total number of frames.

Specified by:

getNumFrames in interface ImageAnimation

Returns:

total number of frames

getFrameDuration

public int getFrameDuration()

Description copied from interface: ImageAnimation

Returns duration of one frame in milliseconds.

Specified by:

getFrameDuration in interface ImageAnimation

Returns:

duration of one frame in milliseconds

getFrame

public RenderedImage getFrame(int index)

Description copied from interface: ImageAnimation

Returns the frame on the the specified index. It is responsibility of the implementation to return frame with the frameWidth and frameHeight.

Specified by:

getFrame in interface ImageAnimation

Parameters:

index - index of the frame, must be in interval [0, numFrames - 1]

Returns:

image frame

toString

public String toString()

Overrides:

toString in class Object

create

public static ConstantFileImageAnimation create(String framePath,
                                                int frameDuration,
                                                int numFrames)

Creates new instance. frame size is calculated from the image.

Parameters:

framePath - path to the frame image

frameDuration - frame duration

numFrames - number of frames

Returns:

created object