GSprite

java.lang.Object
- stanford.androidlib.graphics.GObject
- - stanford.androidlib.graphics.GSprite

```
public class GSprite
extends GObject
```
This class can be useful for creating objects in basic 2D games. It represents a basic in-game entity with a position and size that can move with a given velocity and acceleration around the screen. It can also collide with other sprites. A sprite can be drawn as either a bitmap image or a GObject such as a rectangle/oval.

Since we cannot possibly think of all possible attributes you would want to store inside your sprite objects, we provide an internal map of key/value pairs called 'extra' properties. You can call getExtra and setExtra to retrieve/store extra data inside any sprite.

Constructor Summary

Constructors
Constructor and Description
`GSprite()` Constructs a new empty sprite at (0, 0).
`GSprite(ArrayList<Bitmap> bitmaps)` Constructs a new sprite at (0, 0) that displays the given bitmaps.
`GSprite(ArrayList<Bitmap> bitmaps, float x, float y)` Constructs a new sprite at the given x/y location that displays the given bitmaps.
`GSprite(Bitmap bitmap)` Constructs a new sprite at (0, 0) that displays the given bitmap.
`GSprite(Bitmap bitmap, float x, float y)` Constructs a new sprite at the given x/y location that displays the given bitmap.
`GSprite(Bitmap bitmap, float x, float y, float width, float height)` Constructs a new sprite at the given x/y location and size that displays the given bitmap.
`GSprite(float x, float y, float width, float height)` Constructs a new sprite at the given x/y location that displays a plain rectangle of the given size.
`GSprite(GCanvas canvas)` Constructs a new empty sprite at (0, 0).
`GSprite(GCanvas canvas, ArrayList<Bitmap> bitmaps)` Constructs a new sprite at (0, 0) that displays the given bitmaps.
`GSprite(GCanvas canvas, ArrayList<Bitmap> bitmaps, float x, float y)` Constructs a new sprite at the given x/y location that displays the given bitmaps.
`GSprite(GCanvas canvas, Bitmap bitmap)` Constructs a new sprite at (0, 0) that displays the given bitmap.
`GSprite(GCanvas canvas, Bitmap bitmap, float x, float y)` Constructs a new sprite at the given x/y location that displays the given bitmap.
`GSprite(GCanvas canvas, Bitmap bitmap, float x, float y, float width, float height)` Constructs a new sprite at the given x/y location and size that displays the given bitmap.
`GSprite(GCanvas canvas, float x, float y, float width, float height)` Constructs a new sprite at the given x/y location that displays a plain rectangle of the given size.
`GSprite(GCanvas canvas, GObject object)` Constructs a new sprite at the given x/y location that displays the given graphical object.
`GSprite(GObject object)` Constructs a new sprite at the given x/y location that displays the given graphical object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GSprite`	`addTo(GCanvas canvas)` Adds this sprite to the given graphical canvas.
`GSprite`	`addTo(GCanvas canvas, float x, float y)` Adds this sprite to the given graphical canvas.
`GSprite`	`addTo(GCanvas canvas, GPoint location)` Adds this GObject to the given graphical canvas.
`GSprite`	`bound()` Moves this sprite so that it is within the bounds of its canvas.
`GSprite`	`bound(Canvas canvas)` Moves this sprite so that it is within the bounds of the given canvas.
`GSprite`	`bound(float leftX, float topY, float rightX, float bottomY)` Moves this sprite so that it is within the bounds of the given x/y area.
`GSprite`	`bound(RectF rect)` Moves this sprite so that it is within the bounds of the given rectangle.
`GSprite`	`boundHorizontal()` Moves this sprite so that it is within the horizontal (x) bounds of its canvas.
`GSprite`	`boundHorizontal(Canvas canvas)` Moves this sprite so that it is within the horizontal (x) bounds of the given canvas.
`GSprite`	`boundHorizontal(float leftX, float rightX)` Moves this sprite so that it is within the horizontal (x) bounds of the given x area.
`GSprite`	`boundHorizontal(RectF rect)` Moves this sprite so that it is within the horizontal (x) bounds of the given rectangle.
`GSprite`	`boundVertical()` Moves this sprite so that it is within the vertical (y) bounds of its canvas.
`GSprite`	`boundVertical(Canvas canvas)` Moves this sprite so that it is within the vertical (y) bounds of the given canvas.
`GSprite`	`boundVertical(float topY, float bottomY)` Moves this sprite so that it is within the vertical (y) bounds of the given y area.
`GSprite`	`boundVertical(RectF rect)` Moves this sprite so that it is within the vertical (y) bounds of the given rectangle.
`GSprite`	`clearExtras()` Removes all extra properties inside this sprite.
`boolean`	`collidesWith(GSprite otherSprite)` Returns true if this sprite collides with the given other sprite.
`GSprite`	`flipVelocity()` Inverts the sign of the sprite's velocity in both directions.
`GSprite`	`flipVelocityX()` Inverts the sign of the sprite's velocity in the x direction.
`GSprite`	`flipVelocityY()` Inverts the sign of the sprite's velocity in the y direction.
`float`	`getAccelerationX()` Returns this sprite's x acceleration; this will be 0 unless you have called setAcceleration.
`float`	`getAccelerationY()` Returns this sprite's yacceleration; this will be 0 unless you have called setAcceleration.
`Bitmap`	`getBitmap()` Returns the bitmap for this sprite as passed to the constructor.
`ArrayList<Bitmap>`	`getBitmaps()` Returns the list of bitmaps for this sprite.
`float`	`getCollisionMarginBottom()` Returns this sprite's collision margin in the y direction.
`float`	`getCollisionMarginLeft()` Returns this sprite's collision margin in the x direction on the left side.
`float`	`getCollisionMarginRight()` Returns this sprite's collision margin in the x direction on the right side.
`float`	`getCollisionMarginTop()` Returns this sprite's collision margin in the y direction on top.
`float`	`getCollisionMarginX()` Returns this sprite's collision margin in the x direction.
`float`	`getCollisionMarginY()` Returns this sprite's collision margin in the y direction on top.
`int`	`getCurrentBitmapIndex()` Returns the index of the bitmap currently being displayed in this sprite's list of bitmaps.
`<T> T`	`getExtra(String name)` Returns the extra property inside this sprite with the given name.
`Bundle`	`getExtras()` Returns all extras in this sprite as a Bundle.
`int`	`getFramesPerBitmap()` Returns the number of frames of animation that each bitmap in the list should be displayed before automatically cycling to the next frame bitmap.
`float`	`getHeight()` Returns this sprite's height.
`<T extends GObject> T`	`getShape()` Returns the GObject that was passed to this GSprite's constructor, if any.
`float`	`getVelocityX()` Returns this sprite's velocity in the x direction.
`float`	`getVelocityY()` Returns this sprite's velocity in the y direction.
`float`	`getWidth()` Returns the sprite's width.
`float`	`getX()` Returns this sprite's leftmost x-coordinate.
`float`	`getY()` Returns this sprite's top y-coordinate.
`boolean`	`hasCollisionBoundary()` Returns true if you have set a collision margin.
`boolean`	`hasExtra(String name)` Returns whether this sprite has the given extra property inside it.
`boolean`	`intersects(GSprite otherSprite)` Returns true if this sprite collides with the given other sprite.
`boolean`	`isCollidable()` Returns whether this sprite can be collided with.
`boolean`	`isInBounds()` Returns whether this sprite is within the bounds of its canvas.
`boolean`	`isInBounds(Canvas canvas)` Returns whether this sprite is within the bounds of the given canvas.
`boolean`	`isInBounds(float leftX, float topY, float rightX, float bottomY)` Returns whether this sprite is within the bounds of the given x/y area.
`boolean`	`isInBounds(RectF rect)` Returns whether this sprite is within the bounds of the given rectangle.
`boolean`	`isInBoundsHorizontal()` Returns whether this sprite is within the horizontal (x) bounds of its canvas.
`boolean`	`isInBoundsHorizontal(Canvas canvas)` Returns whether this sprite is within the horizontal (x) bounds of the given canvas.
`boolean`	`isInBoundsHorizontal(float leftX, float rightX)` Returns whether this sprite is within the horizontal (x) bounds of the given x area.
`boolean`	`isInBoundsHorizontal(RectF rect)` Returns whether this sprite is within the horizontal (x) bounds of the given rectangle.
`boolean`	`isInBoundsVertical()` Returns whether this sprite is within the vertical (y) bounds of its canvas.
`boolean`	`isInBoundsVertical(Canvas canvas)` Returns whether this sprite is within the vertical (y) bounds of the given canvas.
`boolean`	`isInBoundsVertical(float topY, float bottomY)` Returns whether this sprite is within the vertical (y) bounds of the given y area.
`boolean`	`isInBoundsVertical(RectF rect)` Returns whether this sprite is within the vertical (y) bounds of the given rectangle.
`boolean`	`isLoopBitmaps()` Returns whether the sequence of bitmaps (as passed to the constructor or setBitmaps) should loop back to the first one after it ends.
`boolean`	`isMoving()` Returns whether this sprite has a non-zero velocity in any dimension.
`GSprite`	`moveTo(float x, float y)` Moves the sprite on the screen to the given x/y position.
`GSprite`	`moveTo(GPoint point)` Moves the sprite on the screen to the given point's x/y position.
`void`	`paint(Canvas canvas)` Draws this sprite onto the given graphical canvas.
`GSprite`	`putExtra(String name, Object value)` Sets the extra property inside this sprite with the given name.
`GSprite`	`putExtras(Bundle bundle)` Adds all extras from the given Bundle into this Sprite.
`GSprite`	`remove()` Removes this sprite from its graphical canvas, if it is added to one.
`GSprite`	`removeExtra(String name)` Removes the extra property inside this sprite with the given name.
`GSprite`	`rotateVelocity(float degrees)` Rotates this sprite's velocity in x and y dimension by the given angle in degrees, clockwise.
`GSprite`	`scale(float sf)` Scales the sprite on the screen by the scale factor `sf`, which applies in both dimensions.
`GSprite`	`scale(float sx, float sy)` Scales the object on the screen by the scale factors `sx` and `sy`.
`GSprite`	`setAcceleration(float accelerationX, float accelerationY)` Sets the x and y acceleration of this sprite.
`GSprite`	`setAccelerationX(float accelerationX)` Sets the x acceleration of this sprite.
`GSprite`	`setAccelerationY(float accelerationY)` Sets the y acceleration of this sprite.
`GSprite`	`setBitmap(Bitmap bitmap)` Sets this sprite to use the given bitmap to draw itself.
`GSprite`	`setBitmaps(ArrayList<Bitmap> bitmaps)` Sets the list of bitmaps for this sprite.
`GSprite`	`setBitmaps(Bitmap... bitmaps)` Sets the list of bitmaps for this sprite.
`GSprite`	`setBounds(float x, float y, float width, float height)` Changes the bounds of this object to the specified values.
`GSprite`	`setBounds(GPoint location, GDimension size)` Changes the bounds of this object to the specified values.
`GSprite`	`setCollidable(boolean collidable)` Sets whether it is possible to collide with this sprite.
`GSprite`	`setCollisionMargin(float px)` Sets a collision margin for this sprite.
`GSprite`	`setCollisionMargin(float pxX, float pxY)` Sets a collision margin for this sprite on all four sides.
`GSprite`	`setCollisionMargin(float pxLeft, float pxTop, float pxRight, float pxBottom)` Sets a collision margin for this sprite on all four sides.
`GSprite`	`setCollisionMarginBottom(float pxBottom)` Sets a collision margin for this sprite on the bottom side.
`GSprite`	`setCollisionMarginLeft(float pxLeft)` Sets a collision margin for this sprite on the left side only.
`GSprite`	`setCollisionMarginRight(float pxRight)` Sets a collision margin for this sprite on the right side only.
`GSprite`	`setCollisionMarginTop(float pxTop)` Sets a collision margin for this sprite on the top side.
`GSprite`	`setCollisionMarginX(float pxX)` Sets a collision margin for this sprite on the left and right sides.
`GSprite`	`setCollisionMarginX(float pxLeft, float pxRight)` Sets a collision margin for this sprite on the left and right sides.
`GSprite`	`setCollisionMarginY(float pxY)` Sets a collision margin for this sprite on the top and bottom sides.
`GSprite`	`setCollisionMarginY(float pxTop, float pxBottom)` Sets a collision margin for this sprite on the top and bottom sides.
`GSprite`	`setColor(Paint paint)` Sets the color used to display this sprite.
`GSprite`	`setCurrentBitmapIndex(int index)` Sets the index of the bitmap currently being displayed in this sprite's list of bitmaps.
`static void`	`setDebug(boolean debug)` Sets a global "debug" flag that will cause some log messages to be printed, as well as drawing a light-green "collision rectangle" around all sprites to help see when they will collide.
`GSprite`	`setExtra(String name, Object value)` Sets the extra property inside this sprite with the given name.
`GSprite`	`setExtras(Bundle bundle)` Adds all extras from the given Bundle into this Sprite.
`GSprite`	`setFillColor(Paint color)` Sets the color used to display the filled region of this object.
`GSprite`	`setFilled(boolean fill)` Sets whether this object is filled.
`GSprite`	`setFramesPerBitmap(int framesPerBitmap)` Sets the number of frames of animation that each bitmap in the list should be displayed before automatically cycling to the next frame bitmap.
`GSprite`	`setGCanvas(GCanvas gcanvas)` Sets the canvas on which this GObject should be drawn.
`GSprite`	`setLocation(float x, float y)` Moves this sprite to the given x/y location.
`GSprite`	`setLocation(GObject gobj)` Moves this GObject to have the same location as the given other GObject.
`GSprite`	`setLocation(GPoint point)` Sets the location of this object to the given point's (x, y) location.
`GSprite`	`setLoopBitmaps(boolean loop)` Sets whether the sequence of bitmaps (as passed to the constructor or setBitmaps) should loop back to the first one after it ends.
`GSprite`	`setPaint(Paint paint)` Sets the color used to display this object.
`GSprite`	`setShape(GObject object)` Sets the GObject for this GSprite to draw.
`GSprite`	`setSize(float width, float height)` Sets this sprite to use the given size.
`GSprite`	`setSize(GDimension size)` Changes the size of this sprite to the specified `GDimension`.
`GSprite`	`setVelocity(float dx, float dy)` Sets this sprite to move with the given velocity.
`GSprite`	`setVelocityX(float dx)` Sets this sprite to move with the given velocity in the x direction.
`GSprite`	`setVelocityY(float dy)` Sets this sprite to move with the given velocity in the y direction.
`GSprite`	`setVisible(boolean visible)` Sets whether this object is visible.
`GSprite`	`setX(float x)` Sets the x-location of this object.
`GSprite`	`setY(float y)` Sets the y-location of this object.
`GSprite`	`stop()` Halts the object, setting its velocity and acceleration to 0.
`String`	`toString()` Returns a string representation of this sprite for debugging, including its GObject if any, and its collision rectangle.
`GSprite`	`translate(float dx, float dy)` Moves the object on the screen using the displacements dx and dy.
`void`	`update()` Called by SimpleCanvas every time the animation ticks.

Methods inherited from class stanford.androidlib.graphics.GObject
contains, contains, getBottomY, getBounds, getCenterX, getCenterY, getColor, getFillColor, getGCanvas, getLeftX, getLocation, getPaint, getRightX, getSize, getTopY, intersects, isFilled, isVisible, moveBy, moveByPolar, moveTo, moveToPolar, repaint, sendBackward, sendForward, sendToBack, sendToFront, setBottomY, setBounds, setCanvas, setRightX

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GSprite
```
public GSprite()
```
    Constructs a new empty sprite at (0, 0).
  - GSprite
```
public GSprite(Bitmap bitmap)
```
    Constructs a new sprite at (0, 0) that displays the given bitmap.
  - GSprite
```
public GSprite(ArrayList<Bitmap> bitmaps)
```
    Constructs a new sprite at (0, 0) that displays the given bitmaps. The list of bitmaps must be non-null and non-empty.
  - GSprite
```
public GSprite(ArrayList<Bitmap> bitmaps,
               float x,
               float y)
```
    Constructs a new sprite at the given x/y location that displays the given bitmaps. The list of bitmaps must be non-null and non-empty.
  - GSprite
```
public GSprite(Bitmap bitmap,
               float x,
               float y)
```
    Constructs a new sprite at the given x/y location that displays the given bitmap.
  - GSprite
```
public GSprite(Bitmap bitmap,
               float x,
               float y,
               float width,
               float height)
```
    Constructs a new sprite at the given x/y location and size that displays the given bitmap.
  - GSprite
```
public GSprite(GObject object)
```
    Constructs a new sprite at the given x/y location that displays the given graphical object.
  - GSprite
```
public GSprite(float x,
               float y,
               float width,
               float height)
```
    Constructs a new sprite at the given x/y location that displays a plain rectangle of the given size.
  - GSprite
```
public GSprite(GCanvas canvas)
```
    Constructs a new empty sprite at (0, 0).
  - GSprite
```
public GSprite(GCanvas canvas,
               Bitmap bitmap)
```
    Constructs a new sprite at (0, 0) that displays the given bitmap.
  - GSprite
```
public GSprite(GCanvas canvas,
               ArrayList<Bitmap> bitmaps)
```
    Constructs a new sprite at (0, 0) that displays the given bitmaps. The list of bitmaps must be non-null and non-empty.
  - GSprite
```
public GSprite(GCanvas canvas,
               ArrayList<Bitmap> bitmaps,
               float x,
               float y)
```
    Constructs a new sprite at the given x/y location that displays the given bitmaps. The list of bitmaps must be non-null and non-empty.
  - GSprite
```
public GSprite(GCanvas canvas,
               Bitmap bitmap,
               float x,
               float y)
```
    Constructs a new sprite at the given x/y location that displays the given bitmap.
  - GSprite
```
public GSprite(GCanvas canvas,
               Bitmap bitmap,
               float x,
               float y,
               float width,
               float height)
```
    Constructs a new sprite at the given x/y location and size that displays the given bitmap.
  - GSprite
```
public GSprite(GCanvas canvas,
               GObject object)
```
    Constructs a new sprite at the given x/y location that displays the given graphical object.
  - GSprite
```
public GSprite(GCanvas canvas,
               float x,
               float y,
               float width,
               float height)
```
    Constructs a new sprite at the given x/y location that displays a plain rectangle of the given size.
- Method Detail
  - setDebug
```
public static void setDebug(boolean debug)
```
    Sets a global "debug" flag that will cause some log messages to be printed, as well as drawing a light-green "collision rectangle" around all sprites to help see when they will collide.
  - addTo
```
public GSprite addTo(GCanvas canvas)
```
    Adds this sprite to the given graphical canvas. A convenience method that just calls the canvas's add(GObject) method.
    
    Overrides:
    
    addTo in class GObject
  - addTo
```
public GSprite addTo(GCanvas canvas,
                     float x,
                     float y)
```
    Adds this sprite to the given graphical canvas. A convenience method that just calls the canvas's add(GObject) method.
    
    Overrides:
    
    addTo in class GObject
  - addTo
```
public GSprite addTo(GCanvas canvas,
                     GPoint location)
```
    Adds this GObject to the given graphical canvas. A convenience method that just calls the canvas's add(GObject) method.
    
    Overrides:
    
    addTo in class GObject
  - bound
```
public GSprite bound()
```
    Moves this sprite so that it is within the bounds of its canvas. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the top/left edges if needed. This will use the canvas last passed to paint() if any.
  - bound
```
public GSprite bound(Canvas canvas)
```
    Moves this sprite so that it is within the bounds of the given canvas. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the top/left edges if needed.
  - bound
```
public GSprite bound(RectF rect)
```
    Moves this sprite so that it is within the bounds of the given rectangle. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the top/left edges if needed.
  - bound
```
public GSprite bound(float leftX,
                     float topY,
                     float rightX,
                     float bottomY)
```
    Moves this sprite so that it is within the bounds of the given x/y area. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the top/left edges if needed.
  - boundHorizontal
```
public GSprite boundHorizontal()
```
    Moves this sprite so that it is within the horizontal (x) bounds of its canvas. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the left edge if needed.
  - boundHorizontal
```
public GSprite boundHorizontal(Canvas canvas)
```
    Moves this sprite so that it is within the horizontal (x) bounds of the given canvas. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the left edge if needed.
  - boundHorizontal
```
public GSprite boundHorizontal(RectF rect)
```
    Moves this sprite so that it is within the horizontal (x) bounds of the given rectangle. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the left edge if needed.
  - boundHorizontal
```
public GSprite boundHorizontal(float leftX,
                               float rightX)
```
    Moves this sprite so that it is within the horizontal (x) bounds of the given x area. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the left edge if needed.
  - boundVertical
```
public GSprite boundVertical()
```
    Moves this sprite so that it is within the vertical (y) bounds of its canvas. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the top edge if needed.
  - boundVertical
```
public GSprite boundVertical(Canvas canvas)
```
    Moves this sprite so that it is within the vertical (y) bounds of the given canvas. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the top edge if needed.
  - boundVertical
```
public GSprite boundVertical(RectF rect)
```
    Moves this sprite so that it is within the vertical (y) bounds of the given rectangle. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the top edge if needed.
  - boundVertical
```
public GSprite boundVertical(float topY,
                             float bottomY)
```
    Moves this sprite so that it is within the vertical (y) bounds of the given y area. If it is outside the bounds on a given edge, it will be moved to that edge, favoring the top edge if needed.
  - clearExtras
```
public GSprite clearExtras()
```
    Removes all extra properties inside this sprite.
  - collidesWith
```
public boolean collidesWith(GSprite otherSprite)
```
    Returns true if this sprite collides with the given other sprite. Collision is determined by the collision rectangles of the two sprites. By default this is just the bounding boxes of their bitmaps or GObjects. But if you have set a collision margin, then that margin is used here.
  - flipVelocity
```
public GSprite flipVelocity()
```
    Inverts the sign of the sprite's velocity in both directions.
  - flipVelocityX
```
public GSprite flipVelocityX()
```
    Inverts the sign of the sprite's velocity in the x direction.
  - flipVelocityY
```
public GSprite flipVelocityY()
```
    Inverts the sign of the sprite's velocity in the y direction.
  - getAccelerationX
```
public float getAccelerationX()
```
    Returns this sprite's x acceleration; this will be 0 unless you have called setAcceleration.
  - getAccelerationY
```
public float getAccelerationY()
```
    Returns this sprite's yacceleration; this will be 0 unless you have called setAcceleration.
  - getBitmap
```
public Bitmap getBitmap()
```
    Returns the bitmap for this sprite as passed to the constructor. If a GObject was passed instead, this will be null.
  - getBitmaps
```
public ArrayList<Bitmap> getBitmaps()
```
    Returns the list of bitmaps for this sprite. If a GObject was passed instead, this will be null.
  - getCollisionMarginBottom
```
public float getCollisionMarginBottom()
```
    Returns this sprite's collision margin in the y direction. This will be 0 unless you have called setCollisionMargin previously. The collision margin can be used to make a smaller collision rectangle for collision detection.
  - getCollisionMarginLeft
```
public float getCollisionMarginLeft()
```
    Returns this sprite's collision margin in the x direction on the left side. This will be 0 unless you have called setCollisionMargin previously. The collision margin can be used to make a smaller collision rectangle for collision detection.
  - getCollisionMarginRight
```
public float getCollisionMarginRight()
```
    Returns this sprite's collision margin in the x direction on the right side. This will be 0 unless you have called setCollisionMargin previously. The collision margin can be used to make a smaller collision rectangle for collision detection.
  - getCollisionMarginTop
```
public float getCollisionMarginTop()
```
    Returns this sprite's collision margin in the y direction on top. This will be 0 unless you have called setCollisionMargin previously. The collision margin can be used to make a smaller collision rectangle for collision detection.
  - getCollisionMarginX
```
public float getCollisionMarginX()
```
    Returns this sprite's collision margin in the x direction. This will be 0 unless you have called setCollisionMargin previously. The collision margin can be used to make a smaller collision rectangle for collision detection.
  - getCollisionMarginY
```
public float getCollisionMarginY()
```
    Returns this sprite's collision margin in the y direction on top. This will be 0 unless you have called setCollisionMargin previously. The collision margin can be used to make a smaller collision rectangle for collision detection.
  - getCurrentBitmapIndex
```
public int getCurrentBitmapIndex()
```
    Returns the index of the bitmap currently being displayed in this sprite's list of bitmaps.
  - getExtra
```
public <T> T getExtra(String name)
```
    Returns the extra property inside this sprite with the given name. If the given extra property has not been previously set inside this sprite, returns null. The sprite's internal map of extra properties is meant as a catch-all to allow you to stuff arbitrary data inside a sprite that is useful for your particular game. The return type here is 'T' so you don't need to typecast.
  - getExtras
```
public Bundle getExtras()
```
    Returns all extras in this sprite as a Bundle. This is a deep copy; modifying the bundle does not modify this sprite.
  - getFramesPerBitmap
```
public int getFramesPerBitmap()
```
    Returns the number of frames of animation that each bitmap in the list should be displayed before automatically cycling to the next frame bitmap.
  - getHeight
```
public float getHeight()
```
    Returns this sprite's height.
    
    Overrides:
    
    getHeight in class GObject
  - getShape
```
public <T extends GObject> T getShape()
```
    Returns the GObject that was passed to this GSprite's constructor, if any.
  - getVelocityX
```
public float getVelocityX()
```
    Returns this sprite's velocity in the x direction.
  - getVelocityY
```
public float getVelocityY()
```
    Returns this sprite's velocity in the y direction.
  - getWidth
```
public float getWidth()
```
    Returns the sprite's width.
    
    Overrides:
    
    getWidth in class GObject
  - getX
```
public float getX()
```
    Returns this sprite's leftmost x-coordinate.
    
    Overrides:
    
    getX in class GObject
  - getY
```
public float getY()
```
    Returns this sprite's top y-coordinate.
    
    Overrides:
    
    getY in class GObject
  - hasCollisionBoundary
```
public boolean hasCollisionBoundary()
```
    Returns true if you have set a collision margin.
  - hasExtra
```
public boolean hasExtra(String name)
```
    Returns whether this sprite has the given extra property inside it.
  - intersects
```
public boolean intersects(GSprite otherSprite)
```
    Returns true if this sprite collides with the given other sprite. Collision is determined by the collision rectangles of the two sprites. By default this is just the bounding boxes of their bitmaps or GObjects. But if you have set a collision margin, then that margin is used here.
  - isCollidable
```
public boolean isCollidable()
```
    Returns whether this sprite can be collided with. This will be true unless you have called setCollidable.
  - isInBounds
```
public boolean isInBounds()
```
    Returns whether this sprite is within the bounds of its canvas. This will use the canvas last passed to paint() if any.
  - isInBounds
```
public boolean isInBounds(Canvas canvas)
```
    Returns whether this sprite is within the bounds of the given canvas.
  - isInBounds
```
public boolean isInBounds(RectF rect)
```
    Returns whether this sprite is within the bounds of the given rectangle.
  - isInBounds
```
public boolean isInBounds(float leftX,
                          float topY,
                          float rightX,
                          float bottomY)
```
    Returns whether this sprite is within the bounds of the given x/y area.
  - isInBoundsHorizontal
```
public boolean isInBoundsHorizontal()
```
    Returns whether this sprite is within the horizontal (x) bounds of its canvas. This will use the canvas last passed to paint() if any.
  - isInBoundsHorizontal
```
public boolean isInBoundsHorizontal(Canvas canvas)
```
    Returns whether this sprite is within the horizontal (x) bounds of the given canvas.
  - isInBoundsHorizontal
```
public boolean isInBoundsHorizontal(RectF rect)
```
    Returns whether this sprite is within the horizontal (x) bounds of the given rectangle.
  - isInBoundsHorizontal
```
public boolean isInBoundsHorizontal(float leftX,
                                    float rightX)
```
    Returns whether this sprite is within the horizontal (x) bounds of the given x area.
  - isInBoundsVertical
```
public boolean isInBoundsVertical()
```
    Returns whether this sprite is within the vertical (y) bounds of its canvas. This will use the canvas last passed to paint() if any.
  - isInBoundsVertical
```
public boolean isInBoundsVertical(Canvas canvas)
```
    Returns whether this sprite is within the vertical (y) bounds of the given canvas.
  - isInBoundsVertical
```
public boolean isInBoundsVertical(RectF rect)
```
    Returns whether this sprite is within the vertical (y) bounds of the given rectangle.
  - isInBoundsVertical
```
public boolean isInBoundsVertical(float topY,
                                  float bottomY)
```
    Returns whether this sprite is within the vertical (y) bounds of the given y area.
  - isLoopBitmaps
```
public boolean isLoopBitmaps()
```
    Returns whether the sequence of bitmaps (as passed to the constructor or setBitmaps) should loop back to the first one after it ends. Default true.
  - isMoving
```
public boolean isMoving()
```
    Returns whether this sprite has a non-zero velocity in any dimension.
  - moveTo
```
public GSprite moveTo(float x,
                      float y)
```
    Moves the sprite on the screen to the given x/y position.
    
    Overrides:
    
    moveTo in class GObject
  - moveTo
```
public GSprite moveTo(GPoint point)
```
    Moves the sprite on the screen to the given point's x/y position.
    
    Overrides:
    
    moveTo in class GObject
  - paint
```
public void paint(Canvas canvas)
```
    Draws this sprite onto the given graphical canvas.
    
    Specified by:
    
    paint in class GObject
  - putExtra
```
public GSprite putExtra(String name,
                        Object value)
```
    Sets the extra property inside this sprite with the given name. The sprite's internal map of extra properties is meant as a catch-all to allow you to stuff arbitrary data inside a sprite that is useful for your particular game. Equivalent to setExtra.
  - putExtras
```
public GSprite putExtras(Bundle bundle)
```
    Adds all extras from the given Bundle into this Sprite. Does not clear any previously existing extras. Makes a deep copy. Equivalent to setExtras.
  - remove
```
public GSprite remove()
```
    Removes this sprite from its graphical canvas, if it is added to one. Equivalent to calling remove(thisGSprite) on the object.
    
    Overrides:
    
    remove in class GObject
  - removeExtra
```
public GSprite removeExtra(String name)
```
    Removes the extra property inside this sprite with the given name. The sprite's internal map of extra properties is meant as a catch-all to allow you to stuff arbitrary data inside a sprite that is useful for your particular game.
  - rotateVelocity
```
public GSprite rotateVelocity(float degrees)
```
    Rotates this sprite's velocity in x and y dimension by the given angle in degrees, clockwise. For example, passing 90 is a 'right' turn, -90 is a 'left' turn, and 180 is an about-face.
  - scale
```
public GSprite scale(float sf)
```
    Scales the sprite on the screen by the scale factor sf, which applies in both dimensions.
    
    Overrides:
    
    scale in class GObject
    
    Parameters:
    
    sf - The factor used to scale all coordinates in both dimensions
    
    Throws:
    
    IllegalArgumentException - if sf is not a positive number
    
    Usage:
    
    gobj.scale(sf);
  - scale
```
public GSprite scale(float sx,
                     float sy)
```
    Scales the object on the screen by the scale factors sx and sy.
    
    Overrides:
    
    scale in class GObject
    
    Parameters:
    
    sx - The factor used to scale all coordinates in the x direction
    
    sy - The factor used to scale all coordinates in the y direction
    
    Throws:
    
    IllegalArgumentException - if sx or sy is not a positive number
    
    Usage:
    
    gobj.scale(sx, sy);
  - setAccelerationX
```
public GSprite setAccelerationX(float accelerationX)
```
    Sets the x acceleration of this sprite. Acceleration will be applied on each tick of animation, increasing or decreasing the sprite's velocity.
  - setAccelerationY
```
public GSprite setAccelerationY(float accelerationY)
```
    Sets the y acceleration of this sprite. Acceleration will be applied on each tick of animation, increasing or decreasing the sprite's velocity.
  - setAcceleration
```
public GSprite setAcceleration(float accelerationX,
                               float accelerationY)
```
    Sets the x and y acceleration of this sprite. Acceleration will be applied on each tick of animation, increasing or decreasing the sprite's velocity.
  - setBitmap
```
public GSprite setBitmap(Bitmap bitmap)
```
    Sets this sprite to use the given bitmap to draw itself. If the sprite has both a bitmap and a GObject set, the bitmap will take predence and will be drawn. If the sprite uses a cycle of multiple bitmaps, use setBitmaps instead.
  - setBitmaps
```
public GSprite setBitmaps(ArrayList<Bitmap> bitmaps)
```
    Sets the list of bitmaps for this sprite.
  - setBitmaps
```
public GSprite setBitmaps(Bitmap... bitmaps)
```
    Sets the list of bitmaps for this sprite.
  - setBounds
```
public GSprite setBounds(float x,
                         float y,
                         float width,
                         float height)
```
    Changes the bounds of this object to the specified values.
    
    Overrides:
    
    setBounds in class GObject
    
    Parameters:
    
    x - The new x-coordinate for the object
    
    y - The new y-coordinate for the object
    
    width - The new width of the object
    
    height - The new height of the object
    
    Throws:
    
    IllegalArgumentException - if width or height is negative
    
    Usage:
    
    gimage.setBounds(x, y, width, height);
  - setBounds
```
public GSprite setBounds(GPoint location,
                         GDimension size)
```
    Changes the bounds of this object to the specified values.
    
    Overrides:
    
    setBounds in class GObject
    
    Parameters:
    
    location - The new x/y-coordinates for the object
    
    size - The new width/height of the object
    
    Throws:
    
    IllegalArgumentException - if width or height is negative
    
    Usage:
    
    gimage.setBounds(x, y, width, height);
  - setCollidable
```
public GSprite setCollidable(boolean collidable)
```
    Sets whether it is possible to collide with this sprite. If false, collidesWith will always return false.
  - setCollisionMargin
```
public GSprite setCollisionMargin(float px)
```
    Sets a collision margin for this sprite. Collision is determined by the collision rectangles of the two sprites. By default this is just the bounding boxes of their bitmaps or GObjects. But if you have set a collision margin, then that margin is used here. For example, on a 20x20 pixel sprite, setting a collision margin of 5px would mean that only the innermost 10x10 pixels would count as a collision.
  - setCollisionMargin
```
public GSprite setCollisionMargin(float pxX,
                                  float pxY)
```
    Sets a collision margin for this sprite on all four sides. Collision is determined by the collision rectangles of the two sprites. By default this is just the bounding boxes of their bitmaps or GObjects. But if you have set a collision margin, then that margin is used here. For example, on a 20x20 pixel sprite, setting a collision margin of 4px and 6px would mean that only the innermost 12x8 pixels would count as a collision.
  - setCollisionMargin
```
public GSprite setCollisionMargin(float pxLeft,
                                  float pxTop,
                                  float pxRight,
                                  float pxBottom)
```
    Sets a collision margin for this sprite on all four sides. Collision is determined by the collision rectangles of the two sprites. By default this is just the bounding boxes of their bitmaps or GObjects. But if you have set a collision margin, then that margin is used here. For example, on a 20x20 pixel sprite, setting a collision margin of 4px and 6px would mean that only the innermost 12x8 pixels would count as a collision.
  - setCollisionMarginBottom
```
public GSprite setCollisionMarginBottom(float pxBottom)
```
    Sets a collision margin for this sprite on the bottom side.
  - setCollisionMarginLeft
```
public GSprite setCollisionMarginLeft(float pxLeft)
```
    Sets a collision margin for this sprite on the left side only.
  - setCollisionMarginRight
```
public GSprite setCollisionMarginRight(float pxRight)
```
    Sets a collision margin for this sprite on the right side only.
  - setCollisionMarginTop
```
public GSprite setCollisionMarginTop(float pxTop)
```
    Sets a collision margin for this sprite on the top side.
  - setCollisionMarginX
```
public GSprite setCollisionMarginX(float pxX)
```
    Sets a collision margin for this sprite on the left and right sides.
  - setCollisionMarginX
```
public GSprite setCollisionMarginX(float pxLeft,
                                   float pxRight)
```
    Sets a collision margin for this sprite on the left and right sides.
  - setCollisionMarginY
```
public GSprite setCollisionMarginY(float pxY)
```
    Sets a collision margin for this sprite on the top and bottom sides.
  - setCollisionMarginY
```
public GSprite setCollisionMarginY(float pxTop,
                                   float pxBottom)
```
    Sets a collision margin for this sprite on the top and bottom sides.
  - setColor
```
public GSprite setColor(Paint paint)
```
    Sets the color used to display this sprite.
    
    Overrides:
    
    setColor in class GObject
    
    Throws:
    
    NullPointerException - if paint is null.
  - setCurrentBitmapIndex
```
public GSprite setCurrentBitmapIndex(int index)
```
    Sets the index of the bitmap currently being displayed in this sprite's list of bitmaps.
  - setExtra
```
public GSprite setExtra(String name,
                        Object value)
```
    Sets the extra property inside this sprite with the given name. The sprite's internal map of extra properties is meant as a catch-all to allow you to stuff arbitrary data inside a sprite that is useful for your particular game. Equivalent to putExtra.
  - setExtras
```
public GSprite setExtras(Bundle bundle)
```
    Adds all extras from the given Bundle into this Sprite. Does not clear any previously existing extras. Makes a deep copy. Equivalent to putExtras.
  - setFillColor
```
public GSprite setFillColor(Paint color)
```
    Sets the color used to display the filled region of this object.
    
    Overrides:
    
    setFillColor in class GObject
    
    Parameters:
    
    color - The color used to display the filled region of this object
    
    Throws:
    
    NullPointerException - if color is null
    
    Usage:
    
    gobj.setFillColor(color);
  - setFilled
```
public GSprite setFilled(boolean fill)
```
    Sets whether this object is filled.
    
    Overrides:
    
    setFilled in class GObject
    
    Parameters:
    
    fill - true if the object should be filled, false for an outline
    
    Usage:
    
    gobj.setFilled(fill);
  - setFramesPerBitmap
```
public GSprite setFramesPerBitmap(int framesPerBitmap)
```
    Sets the number of frames of animation that each bitmap in the list should be displayed before automatically cycling to the next frame bitmap.
  - setGCanvas
```
public GSprite setGCanvas(GCanvas gcanvas)
```
    Sets the canvas on which this GObject should be drawn. You probably should not call this directly, and should call add(GObject) on the canvas instead. If gcanvas is null, this object will not be associated with any canvas.
    
    Overrides:
    
    setGCanvas in class GObject
  - setLocation
```
public GSprite setLocation(float x,
                           float y)
```
    Moves this sprite to the given x/y location.
    
    Overrides:
    
    setLocation in class GObject
  - setLocation
```
public GSprite setLocation(GObject gobj)
```
    Moves this GObject to have the same location as the given other GObject.
    
    Overrides:
    
    setLocation in class GObject
    
    Throws:
    
    NullPointerException - if gobj is null.
  - setLocation
```
public GSprite setLocation(GPoint point)
```
    Sets the location of this object to the given point's (x, y) location.
    
    Overrides:
    
    setLocation in class GObject
  - setLoopBitmaps
```
public GSprite setLoopBitmaps(boolean loop)
```
    Sets whether the sequence of bitmaps (as passed to the constructor or setBitmaps) should loop back to the first one after it ends. Default true.
  - setPaint
```
public GSprite setPaint(Paint paint)
```
    Sets the color used to display this object.
    
    Overrides:
    
    setPaint in class GObject
    
    Throws:
    
    NullPointerException - if paint is null.
  - setShape
```
public GSprite setShape(GObject object)
```
    Sets the GObject for this GSprite to draw.
  - setSize
```
public GSprite setSize(float width,
                       float height)
```
    Sets this sprite to use the given size.
    
    Overrides:
    
    setSize in class GObject
    
    Parameters:
    
    width - The new width of the object
    
    height - The new height of the object
  - setSize
```
public GSprite setSize(GDimension size)
```
    Changes the size of this sprite to the specified GDimension.
    
    Overrides:
    
    setSize in class GObject
    
    Parameters:
    
    size - A GDimension object specifying the size
    
    Throws:
    
    NullPointerException - if size is null
    
    Usage:
    
    gspr.setSize(size);
    
    Noshow:
  - setVelocity
```
public GSprite setVelocity(float dx,
                           float dy)
```
    Sets this sprite to move with the given velocity. Every time update() is called, its x/y position will change by the given dx and dy amounts.
  - setVelocityX
```
public GSprite setVelocityX(float dx)
```
    Sets this sprite to move with the given velocity in the x direction. Every time update() is called, its x position will change by the given dx amount. dy is unchanged by this call.
  - setVelocityY
```
public GSprite setVelocityY(float dy)
```
    Sets this sprite to move with the given velocity in the y direction. Every time update() is called, its y position will change by the given dy amount. dx is unchanged by this call.
  - setVisible
```
public GSprite setVisible(boolean visible)
```
    Sets whether this object is visible.
    
    Overrides:
    
    setVisible in class GObject
  - setX
```
public GSprite setX(float x)
```
    Sets the x-location of this object. The y-location is unchanged.
    
    Overrides:
    
    setX in class GObject
  - setY
```
public GSprite setY(float y)
```
    Sets the y-location of this object. The x-location is unchanged.
    
    Overrides:
    
    setY in class GObject
  - stop
```
public GSprite stop()
```
    Halts the object, setting its velocity and acceleration to 0.
  - toString
```
public String toString()
```
    Returns a string representation of this sprite for debugging, including its GObject if any, and its collision rectangle.
    
    Overrides:
    
    toString in class GObject
    
    Returns:
    
    a string representation of the object.
  - translate
```
public GSprite translate(float dx,
                         float dy)
```
    Moves the object on the screen using the displacements dx and dy.
    
    Overrides:
    
    translate in class GObject
  - update
```
public void update()
```
    Called by SimpleCanvas every time the animation ticks. Moves the sprite by dx and dy and applies acceleration.

Class GSprite

Constructor Summary

Method Summary

Methods inherited from class stanford.androidlib.graphics.GObject

Methods inherited from class java.lang.Object

Constructor Detail

GSprite

GSprite

GSprite

GSprite

GSprite

GSprite

GSprite

GSprite

GSprite

GSprite

GSprite

GSprite

GSprite

GSprite

GSprite

GSprite

Method Detail

setDebug

addTo

addTo

addTo

bound

bound

bound

bound

boundHorizontal

boundHorizontal

boundHorizontal

boundHorizontal

boundVertical

boundVertical

boundVertical

boundVertical

clearExtras

collidesWith

flipVelocity

flipVelocityX

flipVelocityY

getAccelerationX

getAccelerationY

getBitmap

getBitmaps

getCollisionMarginBottom

getCollisionMarginLeft

getCollisionMarginRight

getCollisionMarginTop

getCollisionMarginX

getCollisionMarginY

getCurrentBitmapIndex

getExtra

getExtras

getFramesPerBitmap

getHeight

getShape

getVelocityX

getVelocityY

getWidth

getX

getY

hasCollisionBoundary

hasExtra

intersects

isCollidable

isInBounds

isInBounds

isInBounds

isInBounds

isInBoundsHorizontal

isInBoundsHorizontal

isInBoundsHorizontal

isInBoundsHorizontal

isInBoundsVertical

isInBoundsVertical

isInBoundsVertical