com.threerings.media.util
Class SingleFrameImageImpl

java.lang.Object
  com.threerings.media.util.SingleFrameImageImpl

All Implemented Interfaces:

MultiFrameImage

public class SingleFrameImageImpl
extends Object
implements MultiFrameImage

The single frame image class is a basic implementation of the MultiFrameImage interface intended to facilitate the creation of MFIs whose display frames consist of only a single image.

Field Summary

protected Mirage

_mirage The frame image.

Constructor Summary

SingleFrameImageImpl(Mirage mirage)
Constructs a single frame image object.

Method Summary

int	getFrameCount() Returns the number of frames in this multi-frame image.
int	getHeight(int index) Returns the height of the specified frame image.
int	getWidth(int index) Returns the width of the specified frame image.
boolean	hitTest(int index, int x, int y) Returns true if the specified frame contains a non-transparent pixel at the specified coordinates.
void	paintFrame(Graphics2D g, int index, int x, int y) Renders the specified frame into the specified graphics object at the specified coordinates.

Methods inherited from class java.lang.Object

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

Field Detail

_mirage

protected Mirage _mirage

The frame image.

Constructor Detail

SingleFrameImageImpl

public SingleFrameImageImpl(Mirage mirage)

Constructs a single frame image object.

Method Detail

getFrameCount

public int getFrameCount()

Description copied from interface: MultiFrameImage

Returns the number of frames in this multi-frame image.

Specified by:

getFrameCount in interface MultiFrameImage

getWidth

public int getWidth(int index)

Description copied from interface: MultiFrameImage

Returns the width of the specified frame image.

Specified by:

getWidth in interface MultiFrameImage

getHeight

public int getHeight(int index)

Description copied from interface: MultiFrameImage

Returns the height of the specified frame image.

Specified by:

getHeight in interface MultiFrameImage

paintFrame

public void paintFrame(Graphics2D g,
                       int index,
                       int x,
                       int y)

Description copied from interface: MultiFrameImage

Renders the specified frame into the specified graphics object at the specified coordinates.

Specified by:

paintFrame in interface MultiFrameImage

hitTest

public boolean hitTest(int index,
                       int x,
                       int y)

Description copied from interface: MultiFrameImage

Returns true if the specified frame contains a non-transparent pixel at the specified coordinates.

Specified by:

hitTest in interface MultiFrameImage