com.threerings.media.sprite

Class ImageSprite

java.lang.Object

com.threerings.media.AbstractMedia

com.threerings.media.sprite.Sprite

com.threerings.media.sprite.ImageSprite

All Implemented Interfaces:

Pathable, DirectionCodes, Shape

Direct Known Subclasses:

CharacterSprite, OrientableImageSprite

public class ImageSprite
extends Sprite

Extends the sprite class to support rendering the sprite with one or more frames of image animation. Overrides various methods to provide correspondingly desirable functionality, e.g., hitTest(int, int) only reports a hit if the specified point is within a non-transparent pixel for the sprite's current image frame.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FRAME_RATE Default frame rate.
static int	MOVEMENT_CUED Animation mode indicating movement cued animation.
static int	NO_ANIMATION Animation mode indicating no animation.
static int	TIME_BASED Animation mode indicating time based animation.
static int	TIME_SEQUENTIAL Animation mode indicating sequential progressive animation.

Fields inherited from class com.threerings.media.AbstractMedia

HUD_LAYER

Fields inherited from interface com.threerings.util.DirectionCodes

CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST

Constructor Summary

Constructors

Constructor and Description
ImageSprite() Constructs an image sprite without any associated frames and with an invalid default initial location.
ImageSprite(Mirage image) Constructs an image sprite that will display the supplied single image when rendering itself.
ImageSprite(MultiFrameImage frames) Constructs an image sprite.

Method Summary

Modifier and Type	Method and Description
boolean	hitTest(int x, int y) Returns true if the sprite's bounds contain the specified point, and if there is a non-transparent pixel in the sprite's image at the specified point, false if not.
void	layout() Instructs this sprite to lay out its current frame and any accoutrements.
void	paint(Graphics2D gfx) Called by the appropriate manager to request that the media render itself with the given graphics context.
void	setAnimationMode(int mode) Sets the animation mode for this sprite.
void	setFrameRate(float fps) Sets the number of frames per second desired for the sprite animation.
void	setFrames(MultiFrameImage frames) Set the image array used to render the sprite.
void	setMirage(Mirage mirage) Set the image to be used for this sprite.
void	tick(long timestamp) Called periodically by this media's manager to give it a chance to do its thing.

Methods inherited from class com.threerings.media.sprite.Sprite

addSpriteObserver, cancelMove, contains, fastForward, getHeight, getOrientation, getPath, getWidth, getX, getXOffset, getY, getYOffset, inside, intersects, isMoving, move, paintPath, pathBeginning, pathCompleted, removeSpriteObserver, setLocation, setOrientation, viewLocationDidChange

Methods inherited from class com.threerings.media.AbstractMedia

contains, contains, contains, contains, getBounds, getBounds2D, getPathIterator, getPathIterator, getRenderOrder, init, intersects, intersects, invalidate, queueNotification, renderCompareTo, setRenderOrder, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.threerings.media.util.Pathable

getBounds

Field Detail

DEFAULT_FRAME_RATE

public static final int DEFAULT_FRAME_RATE

Default frame rate.

See Also:

Constant Field Values

NO_ANIMATION

public static final int NO_ANIMATION

Animation mode indicating no animation.

See Also:

Constant Field Values

MOVEMENT_CUED

public static final int MOVEMENT_CUED

Animation mode indicating movement cued animation.

See Also:

Constant Field Values

TIME_BASED

public static final int TIME_BASED

Animation mode indicating time based animation.

See Also:

Constant Field Values

TIME_SEQUENTIAL

public static final int TIME_SEQUENTIAL

Animation mode indicating sequential progressive animation. Frame 0 is guaranteed to be shown first for the full duration, and so on.

See Also:

Constant Field Values

Constructor Detail

ImageSprite

public ImageSprite()

Constructs an image sprite without any associated frames and with an invalid default initial location. The sprite should be populated with a set of frames used to display it via a subsequent call to setFrames(com.threerings.media.util.MultiFrameImage), and its location updated with AbstractMedia.setLocation(int, int).

ImageSprite

public ImageSprite(MultiFrameImage frames)

Constructs an image sprite.

Parameters:

frames - the multi-frame image used to display the sprite.

ImageSprite

public ImageSprite(Mirage image)

Constructs an image sprite that will display the supplied single image when rendering itself.

Method Detail

hitTest

public boolean hitTest(int x,
                       int y)

Returns true if the sprite's bounds contain the specified point, and if there is a non-transparent pixel in the sprite's image at the specified point, false if not.

Overrides:

hitTest in class Sprite

setAnimationMode

public void setAnimationMode(int mode)

Sets the animation mode for this sprite. The available modes are:

• TIME_BASED: cues the animation based on a target frame rate (specified via setFrameRate(float)).
• MOVEMENT_CUED: ticks the animation to the next frame every time the sprite is moved along its path.
• NO_ANIMATION: disables animation.

Parameters:

mode - the desired animation mode.

setFrameRate

public void setFrameRate(float fps)

Sets the number of frames per second desired for the sprite animation. This is only used when the animation mode is TIME_BASED.

Parameters:

fps - the desired frames per second.

setMirage

public void setMirage(Mirage mirage)

Set the image to be used for this sprite.

setFrames

public void setFrames(MultiFrameImage frames)

Set the image array used to render the sprite.

Parameters:

frames - the sprite images.

layout

public void layout()

Instructs this sprite to lay out its current frame and any accoutrements.

paint

public void paint(Graphics2D gfx)

Description copied from class: AbstractMedia

Called by the appropriate manager to request that the media render itself with the given graphics context. The media may wish to inspect the clipping region that has been set on the graphics context to render itself more efficiently. This method will only be called after it has been established that this media's bounds intersect the clipping region.

Overrides:

paint in class Sprite

tick

public void tick(long timestamp)

Description copied from class: AbstractMedia

Called periodically by this media's manager to give it a chance to do its thing.

Overrides:

tick in class Sprite

Parameters:

timestamp - a time stamp associated with this tick. Note: this is not obtained from a call to System.currentTimeMillis() and cannot be compared to timestamps obtained there from.