Sprite (Nenya Core 1.6.1 API)

java.lang.Object
- com.threerings.media.AbstractMedia
- - com.threerings.media.sprite.Sprite

All Implemented Interfaces:

Pathable, DirectionCodes, Shape

Direct Known Subclasses:

AnimationSprite, ButtonSprite, ImageSprite, LabelSprite
```
public abstract class Sprite
extends AbstractMedia
implements DirectionCodes, Pathable
```
The sprite class represents a single movable object in an animated view. A sprite has a position and orientation within the view, and can be moved along a path.

Field Summary
- 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
`Sprite()` Constructs a sprite with an initially invalid location.
`Sprite(int width, int height)` Constructs a sprite with the supplied dimensions.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSpriteObserver(Object obs)` Add a sprite observer to observe this sprite's events.
`void`	`cancelMove()` Cancels any path that the sprite may currently be moving along.
`boolean`	`contains(int x, int y)` Returns true if the sprite's bounds contain the specified point, false if not.
`void`	`fastForward(long timeDelta)` Called when the appropriate media manager has been paused for some length of time and is then unpaused.
`int`	`getHeight()` Returns the sprite's height in pixels.
`int`	`getOrientation()` Returns the sprite's orientation as one of the eight cardinal directions: `DirectionCodes.NORTH`, `DirectionCodes.NORTHEAST`, etc.
`Path`	`getPath()` Returns the path being followed by this sprite or null if the sprite is not following a path.
`int`	`getWidth()` Returns the sprite's width in pixels.
`int`	`getX()` Returns the sprite's x position in screen coordinates.
`int`	`getXOffset()` Returns the offset to the sprite's origin from the upper-left of the sprite's image.
`int`	`getY()` Returns the sprite's y position in screen coordinates.
`int`	`getYOffset()` Returns the offset to the sprite's origin from the upper-left of the sprite's image.
`boolean`	`hitTest(int x, int y)` Returns true if the sprite's bounds contain the specified point, false if not.
`boolean`	`inside(Shape shape)` Returns whether the sprite is inside the given shape in pixel coordinates.
`boolean`	`intersects(Shape shape)` Returns whether the sprite's drawn rectangle intersects the given shape in pixel coordinates.
`boolean`	`isMoving()` Returns true if this sprite is currently following a path, false if it is not.
`void`	`move(Path path)` Set the sprite's active path and start moving it along its merry way.
`void`	`paint(Graphics2D gfx)` Called by the appropriate manager to request that the media render itself with the given graphics context.
`void`	`paintPath(Graphics2D gfx)` Paint the sprite's path, if any, to the specified 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`	`removeSpriteObserver(Object obs)` Remove a sprite observer.
`void`	`setLocation(int x, int y)` Set the location.
`void`	`setOrientation(int orient)` Sprites have an orientation in one of the eight cardinal directions: `DirectionCodes.NORTH`, `DirectionCodes.NORTHEAST`, etc.
`void`	`tick(long tickStamp)` Called periodically by this media's manager to give it a chance to do its thing.
`void`	`viewLocationDidChange(int dx, int dy)` Called by the `AbstractMediaManager` when we are in a `VirtualMediaPanel` that just scrolled.

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
  - Sprite
```
public Sprite()
```
    Constructs a sprite with an initially invalid location. Because sprite derived classes generally want to get in on the business when a sprite's location is set, it is not safe to do so in the constructor because their derived methods will be called before their constructor has been called. Thus a sprite should be fully constructed and then its location should be set.
  - Sprite
```
public Sprite(int width,
              int height)
```
    Constructs a sprite with the supplied dimensions. Because sprite derived classes generally want to get in on the business when a sprite's location is set, it is not safe to do so in the constructor because their derived methods will be called before their constructor has been called. Thus a sprite should be fully constructed and then its location should be set.
- Method Detail
  - getX
```
public int getX()
```
    Returns the sprite's x position in screen coordinates. This is the x coordinate of the sprite's origin, not the upper left of its bounds.
    
    Specified by:
    
    getX in interface Pathable
  - getY
```
public int getY()
```
    Returns the sprite's y position in screen coordinates. This is the y coordinate of the sprite's origin, not the upper left of its bounds.
    
    Specified by:
    
    getY in interface Pathable
  - getXOffset
```
public int getXOffset()
```
    Returns the offset to the sprite's origin from the upper-left of the sprite's image.
  - getYOffset
```
public int getYOffset()
```
    Returns the offset to the sprite's origin from the upper-left of the sprite's image.
  - getWidth
```
public int getWidth()
```
    Returns the sprite's width in pixels.
  - getHeight
```
public int getHeight()
```
    Returns the sprite's height in pixels.
  - setOrientation
```
public void setOrientation(int orient)
```
    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
    
    See Also:
    
    DirectionCodes
  - getOrientation
```
public int getOrientation()
```
    Returns the sprite's orientation as one of the eight cardinal directions: DirectionCodes.NORTH, DirectionCodes.NORTHEAST, etc.
    
    Specified by:
    
    getOrientation in interface Pathable
    
    See Also:
    
    DirectionCodes
  - setLocation
```
public void setLocation(int x,
                        int y)
```
    Description copied from class: AbstractMedia
    
    Set the location.
    
    Specified by:
    
    setLocation in interface Pathable
    
    Overrides:
    
    setLocation in class AbstractMedia
  - 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.
    
    Specified by:
    
    paint in class AbstractMedia
  - paintPath
```
public void paintPath(Graphics2D gfx)
```
    Paint the sprite's path, if any, to the specified graphics context.
    
    Parameters:
    
    gfx - the graphics context.
  - contains
```
public boolean contains(int x,
                        int y)
```
    Returns true if the sprite's bounds contain the specified point, false if not.
  - hitTest
```
public boolean hitTest(int x,
                       int y)
```
    Returns true if the sprite's bounds contain the specified point, false if not.
  - inside
```
public boolean inside(Shape shape)
```
    Returns whether the sprite is inside the given shape in pixel coordinates.
  - intersects
```
public boolean intersects(Shape shape)
```
    Returns whether the sprite's drawn rectangle intersects the given shape in pixel coordinates.
  - isMoving
```
public boolean isMoving()
```
    Returns true if this sprite is currently following a path, false if it is not.
  - move
```
public void move(Path path)
```
    Set the sprite's active path and start moving it along its merry way. If the sprite is already moving along a previous path the old path will be lost and the new path will begin to be traversed.
    
    Parameters:
    
    path - the path to follow.
  - cancelMove
```
public void cancelMove()
```
    Cancels any path that the sprite may currently be moving along.
  - getPath
```
public Path getPath()
```
    Returns the path being followed by this sprite or null if the sprite is not following a path.
  - pathBeginning
```
public void pathBeginning()
```
    Called by the active path when it begins.
    
    Specified by:
    
    pathBeginning in interface Pathable
  - pathCompleted
```
public void pathCompleted(long timestamp)
```
    Called by the active path when it has completed.
    
    Specified by:
    
    pathCompleted in interface Pathable
  - 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.
    
    Specified by:
    
    tick in class AbstractMedia
    
    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.
  - fastForward
```
public void fastForward(long timeDelta)
```
    Description copied from class: AbstractMedia
    
    Called when the appropriate media manager has been paused for some length of time and is then unpaused. Media should adjust any time stamps that are maintained internally forward by the delta so that time maintains the illusion of flowing smoothly forward.
    
    Overrides:
    
    fastForward in class AbstractMedia
  - addSpriteObserver
```
public void addSpriteObserver(Object obs)
```
    Add a sprite observer to observe this sprite's events.
    
    Parameters:
    
    obs - the sprite observer.
  - removeSpriteObserver
```
public void removeSpriteObserver(Object obs)
```
    Remove a sprite observer.
  - viewLocationDidChange
```
public void viewLocationDidChange(int dx,
                                  int dy)
```
    Description copied from class: AbstractMedia
    
    Called by the AbstractMediaManager when we are in a VirtualMediaPanel that just scrolled.
    
    Overrides:
    
    viewLocationDidChange in class AbstractMedia

Class Sprite

Field Summary

Fields inherited from class com.threerings.media.AbstractMedia

Fields inherited from interface com.threerings.util.DirectionCodes

Constructor Summary

Method Summary

Methods inherited from class com.threerings.media.AbstractMedia

Methods inherited from class java.lang.Object

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

Constructor Detail

Sprite

Sprite

Method Detail

getX

getY

getXOffset

getYOffset

getWidth

getHeight

setOrientation

getOrientation

setLocation

paint

paintPath

contains

hitTest

inside

intersects

isMoving

move

cancelMove

getPath

pathBeginning

pathCompleted

tick

fastForward

addSpriteObserver

removeSpriteObserver

viewLocationDidChange