com.threerings.cast

Class CharacterSprite

java.lang.Object

com.threerings.media.AbstractMedia

com.threerings.media.sprite.Sprite

com.threerings.media.sprite.ImageSprite

com.threerings.cast.CharacterSprite

All Implemented Interfaces:

StandardActions, Pathable, DirectionCodes, Shape

public class CharacterSprite
extends ImageSprite
implements StandardActions

A character sprite is a sprite that animates itself while walking about in a scene.

Field Summary

Fields inherited from class com.threerings.media.sprite.ImageSprite

DEFAULT_FRAME_RATE, MOVEMENT_CUED, NO_ANIMATION, TIME_BASED, TIME_SEQUENTIAL

Fields inherited from class com.threerings.media.AbstractMedia

HUD_LAYER

Fields inherited from interface com.threerings.cast.StandardActions

CROP_TYPE, SHADOW_TYPE, STANDING, WALKING

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
CharacterSprite()

Method Summary

Modifier and Type	Method and Description
void	cancelMove() Cancels any path that the sprite may currently be moving along.
String	getFollowingPathAction() Returns the action to be used when the sprite is following a path.
String	getRestingAction() Returns the action to be used when the sprite is at rest.
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	init(CharacterDescriptor descrip, CharacterManager charmgr) Initializes this character sprite with the specified character descriptor and character manager.
void	paint(Graphics2D gfx) Called by the appropriate manager to request that the media render itself with the given graphics context.
void	pathBeginning() Called by the active path when it begins.
void	pathCompleted(long timestamp) Called by the active path when it has completed.
void	setActionSequence(String action) Sets the action sequence used when rendering the character, from the set of available sequences.
void	setCharacterDescriptor(CharacterDescriptor descrip) Reconfigures this sprite to use the specified character descriptor.
void	setFollowingPathAction(String action) Specifies the action to use when the sprite is following a path.
void	setOrientation(int orient) Sprites have an orientation in one of the eight cardinal directions: DirectionCodes.NORTH, DirectionCodes.NORTHEAST, etc.
void	setRestingAction(String action) Specifies the action to use when the sprite is at rest.
void	tick(long tickStamp) Called periodically by this media's manager to give it a chance to do its thing.

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

layout, setAnimationMode, setFrameRate, setFrames, setMirage

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

addSpriteObserver, contains, fastForward, getHeight, getOrientation, getPath, getWidth, getX, getXOffset, getY, getYOffset, inside, intersects, isMoving, move, paintPath, removeSpriteObserver, setLocation, 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

Constructor Detail

CharacterSprite

public CharacterSprite()

Method Detail

init

public void init(CharacterDescriptor descrip,
                 CharacterManager charmgr)

Initializes this character sprite with the specified character descriptor and character manager. It will obtain animation data from the supplied character manager.

setCharacterDescriptor

public void setCharacterDescriptor(CharacterDescriptor descrip)

Reconfigures this sprite to use the specified character descriptor.

setRestingAction

public void setRestingAction(String action)

Specifies the action to use when the sprite is at rest. The default is STANDING.

getRestingAction

public String getRestingAction()

Returns the action to be used when the sprite is at rest. Derived classes may wish to override this method and vary the action based on external parameters (or randomly).

setFollowingPathAction

public void setFollowingPathAction(String action)

Specifies the action to use when the sprite is following a path. The default is WALKING.

getFollowingPathAction

public String getFollowingPathAction()

Returns the action to be used when the sprite is following a path. Derived classes may wish to override this method and vary the action based on external parameters (or randomly).

setActionSequence

public void setActionSequence(String action)

Sets the action sequence used when rendering the character, from the set of available sequences.

setOrientation

public void setOrientation(int orient)

Description copied from class: Sprite

Sprites have an orientation in one of the eight cardinal directions: DirectionCodes.NORTH, DirectionCodes.NORTHEAST, etc. Derived classes can choose to override this member function and select a different set of images based on their orientation, or they can ignore the orientation information.

Specified by:

setOrientation in interface Pathable

Overrides:

setOrientation in class Sprite

See Also:

DirectionCodes

hitTest

public boolean hitTest(int x,
                       int y)

Description copied from class: ImageSprite

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 ImageSprite

tick

public void tick(long tickStamp)

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 ImageSprite

Parameters:

tickStamp - 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.

cancelMove

public void cancelMove()

Description copied from class: Sprite

Cancels any path that the sprite may currently be moving along.

Overrides:

cancelMove in class Sprite

pathBeginning

public void pathBeginning()

Description copied from class: Sprite

Called by the active path when it begins.

Specified by:

pathBeginning in interface Pathable

Overrides:

pathBeginning in class Sprite

pathCompleted

public void pathCompleted(long timestamp)

Description copied from class: Sprite

Called by the active path when it has completed.

Specified by:

pathCompleted in interface Pathable

Overrides:

pathCompleted in class Sprite

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 ImageSprite