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, a rectangle, or an 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(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
`void`	`bound()` Moves this sprite so that it is within the bounds of its canvas.
`void`	`bound(Canvas canvas)` Moves this sprite so that it is within the bounds of the given canvas.
`void`	`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.
`void`	`bound(RectF rect)` Moves this sprite so that it is within the bounds of the given rectangle.
`void`	`boundHorizontal()` Moves this sprite so that it is within the horizontal (x) bounds of its canvas.
`void`	`boundHorizontal(Canvas canvas)` Moves this sprite so that it is within the horizontal (x) bounds of the given canvas.
`void`	`boundHorizontal(float leftX, float rightX)` Moves this sprite so that it is within the horizontal (x) bounds of the given x area.
`void`	`boundHorizontal(RectF rect)` Moves this sprite so that it is within the horizontal (x) bounds of the given rectangle.
`void`	`boundVertical()` Moves this sprite so that it is within the vertical (y) bounds of its canvas.
`void`	`boundVertical(Canvas canvas)` Moves this sprite so that it is within the vertical (y) bounds of the given canvas.
`void`	`boundVertical(float topY, float bottomY)` Moves this sprite so that it is within the vertical (y) bounds of the given y area.
`void`	`boundVertical(RectF rect)` Moves this sprite so that it is within the vertical (y) bounds of the given rectangle.
`void`	`clearExtras()` Removes all extra properties inside this sprite.
`boolean`	`collidesWith(GSprite otherSprite)` Returns true if this sprite collides with the given other sprite.
`void`	`flipVelocity()` Inverts the sign of the sprite's velocity in both directions.
`void`	`flipVelocityX()` Inverts the sign of the sprite's velocity in the x direction.
`void`	`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`	`getBottomY()` Returns this sprite's bottom y-coordinate.
`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.
`<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.
`float`	`getLeftX()` Returns this sprite's leftmost x-coordinate.
`float`	`getRightX()` Returns this sprite's rightmost x-coordinate.
`float`	`getTopY()` Returns this sprite's top y-coordinate.
`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.
`boolean`	`isVisible()` Returns whether the sprite is visible.
`void`	`paint(Canvas canvas)` Draws this sprite onto the given graphical canvas.
`void`	`putExtras(Bundle bundle)` Adds all extras from the given Bundle into this Sprite.
`void`	`removeExtra(String name)` Removes the extra property inside this sprite with the given name.
`void`	`rotateVelocity(float degrees)` Rotates this sprite's velocity in x and y dimension by the given angle in degrees, clockwise.
`void`	`setAcceleration(float accelerationX, float accelerationY)` Sets the x and y acceleration of this sprite.
`void`	`setAccelerationX(float accelerationX)` Sets the x acceleration of this sprite.
`void`	`setAccelerationY(float accelerationY)` Sets the y acceleration of this sprite.
`void`	`setBitmap(Bitmap bitmap)` Sets this sprite to use the given bitmap to draw itself.
`void`	`setBitmaps(ArrayList<Bitmap> bitmaps)` Sets the list of bitmaps for this sprite.
`void`	`setBitmaps(Bitmap... bitmaps)` Sets the list of bitmaps for this sprite.
`void`	`setCollidable(boolean collidable)` Sets whether it is possible to collide with this sprite.
`void`	`setCollisionMargin(float px)` Sets a collision margin for this sprite.
`void`	`setCollisionMargin(float pxX, float pxY)` Sets a collision margin for this sprite on all four sides.
`void`	`setCollisionMargin(float pxLeft, float pxTop, float pxRight, float pxBottom)` Sets a collision margin for this sprite on all four sides.
`void`	`setCollisionMarginBottom(float pxBottom)` Sets a collision margin for this sprite on the bottom side.
`void`	`setCollisionMarginLeft(float pxLeft)` Sets a collision margin for this sprite on the left side only.
`void`	`setCollisionMarginRight(float pxRight)` Sets a collision margin for this sprite on the right side only.
`void`	`setCollisionMarginTop(float pxTop)` Sets a collision margin for this sprite on the top side.
`void`	`setCollisionMarginX(float pxX)` Sets a collision margin for this sprite on the left and right sides.
`void`	`setCollisionMarginX(float pxLeft, float pxRight)` Sets a collision margin for this sprite on the left and right sides.
`void`	`setCollisionMarginY(float pxY)` Sets a collision margin for this sprite on the top and bottom sides.
`void`	`setCollisionMarginY(float pxTop, float pxBottom)` Sets a collision margin for this sprite on the top and bottom sides.
`int`	`setCurrentBitmapIndex()` Returns the index of the bitmap currently being displayed in this sprite's list of bitmaps.
`void`	`setCurrentBitmapIndex(int index)` Sets the index of the bitmap currently being displayed in this sprite's list of bitmaps.
`static void`	`setDebug(boolean debug)`
`void`	`setExtra(String name, Object value)` Sets the extra property inside this sprite with the given name.
`void`	`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.
`void`	`setLocation(float x, float y)` Moves this sprite to the given x/y location.
`void`	`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.
`void`	`setSize(float width, float height)` Sets this sprite to use the given size.
`void`	`setVelocity(float dx, float dy)` Sets this sprite to move with the given velocity.
`void`	`setVelocityX(float dx)` Sets this sprite to move with the given velocity in the x direction.
`void`	`setVelocityY(float dy)` Sets this sprite to move with the given velocity in the y direction.
`void`	`setVisible(boolean visible)` Sets whether this sprite is visible.
`void`	`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.
`void`	`update()` Called by SimpleCanvas every time the animation ticks.

Methods inherited from class stanford.androidlib.graphics.GObject
contains, contains, getBounds, getCenterX, getCenterY, getColor, getGCanvas, getLocation, getPaint, getSize, intersects, moveBy, moveByPolar, moveTo, moveTo, moveToPolar, repaint, sendBackward, sendForward, sendToBack, sendToFront, setBottomY, setCanvas, setColor, setGCanvas, setLocation, setPaint, setRightX, setX, setY, translate

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.
- Method Detail
  - setDebug
```
public static void setDebug(boolean debug)
```
  - 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.
  - 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.
  - hasCollisionBoundary
```
public boolean hasCollisionBoundary()
```
    Returns true if you have set a collision margin.
  - paint
```
public void paint(Canvas canvas)
```
    Draws this sprite onto the given graphical canvas.
    
    Specified by:
    
    paint in class GObject
  - flipVelocityX
```
public void flipVelocityX()
```
    Inverts the sign of the sprite's velocity in the x direction.
  - flipVelocityY
```
public void flipVelocityY()
```
    Inverts the sign of the sprite's velocity in the y direction.
  - flipVelocity
```
public void flipVelocity()
```
    Inverts the sign of the sprite's velocity in both directions.
  - rotateVelocity
```
public void 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.
  - 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.
  - 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
  - getLeftX
```
public float getLeftX()
```
    Returns this sprite's leftmost x-coordinate.
  - getRightX
```
public float getRightX()
```
    Returns this sprite's rightmost x-coordinate. This is equal to its leftmost x-coordinate plus its width.
    
    Overrides:
    
    getRightX in class GObject
  - getTopY
```
public float getTopY()
```
    Returns this sprite's top y-coordinate.
  - getBottomY
```
public float getBottomY()
```
    Returns this sprite's bottom y-coordinate. This is equal to its top y-coordinate plus its height.
    
    Overrides:
    
    getBottomY in class GObject
  - getWidth
```
public float getWidth()
```
    Returns the sprite's width.
    
    Overrides:
    
    getWidth in class GObject
  - getHeight
```
public float getHeight()
```
    Returns this sprite's height.
    
    Overrides:
    
    getHeight in class GObject
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - setBitmaps
```
public void setBitmaps(ArrayList<Bitmap> bitmaps)
```
    Sets the list of bitmaps for this sprite.
  - setBitmaps
```
public void setBitmaps(Bitmap... bitmaps)
```
    Sets the list of bitmaps for this sprite.
  - setCurrentBitmapIndex
```
public int setCurrentBitmapIndex()
```
    Returns the index of the bitmap currently being displayed in this sprite's list of bitmaps.
  - setCurrentBitmapIndex
```
public void setCurrentBitmapIndex(int index)
```
    Sets the index of the bitmap currently being displayed in this sprite's list of bitmaps.
  - 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.
  - setFramesPerBitmap
```
public void 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.
  - isCollidable
```
public boolean isCollidable()
```
    Returns whether this sprite can be collided with. This will be true unless you have called setCollidable.
  - isMoving
```
public boolean isMoving()
```
    Returns whether this sprite has a non-zero velocity in any dimension.
  - 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.
  - bound
```
public void 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 void 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 void 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 void 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 void 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 void 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 void 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 void 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 void 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 void 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 void 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 void 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.
  - isVisible
```
public boolean isVisible()
```
    Returns whether the sprite is visible. This will be true unless you have called setVisible.
    
    Overrides:
    
    isVisible in class GObject
  - setAccelerationX
```
public void 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 void 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 void 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.
  - setCollisionMargin
```
public void 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 void 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 void 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.
  - setCollisionMarginX
```
public void setCollisionMarginX(float pxX)
```
    Sets a collision margin for this sprite on the left and right sides.
  - setCollisionMarginLeft
```
public void setCollisionMarginLeft(float pxLeft)
```
    Sets a collision margin for this sprite on the left side only.
  - setCollisionMarginRight
```
public void setCollisionMarginRight(float pxRight)
```
    Sets a collision margin for this sprite on the right side only.
  - setCollisionMarginX
```
public void setCollisionMarginX(float pxLeft,
                                float pxRight)
```
    Sets a collision margin for this sprite on the left and right sides.
  - setCollisionMarginY
```
public void setCollisionMarginY(float pxY)
```
    Sets a collision margin for this sprite on the top and bottom sides.
  - setCollisionMarginY
```
public void setCollisionMarginY(float pxTop,
                                float pxBottom)
```
    Sets a collision margin for this sprite on the top and bottom sides.
  - setCollisionMarginTop
```
public void setCollisionMarginTop(float pxTop)
```
    Sets a collision margin for this sprite on the top side.
  - setCollisionMarginBottom
```
public void setCollisionMarginBottom(float pxBottom)
```
    Sets a collision margin for this sprite on the bottom side.
  - setBitmap
```
public void 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.
  - setCollidable
```
public void setCollidable(boolean collidable)
```
    Sets whether it is possible to collide with this sprite. If false, collidesWith will always return false.
  - setLocation
```
public void setLocation(float x,
                        float y)
```
    Moves this sprite to the given x/y location.
    
    Overrides:
    
    setLocation in class GObject
  - setSize
```
public void setSize(float width,
                    float height)
```
    Sets this sprite to use the given size.
  - setVisible
```
public void setVisible(boolean visible)
```
    Sets whether this sprite is visible. By default sprites are visible. If false, will not be drawn on the screen.
    
    Overrides:
    
    setVisible in class GObject
  - setVelocity
```
public void 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 void 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 void 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.
  - 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.
  - putExtras
```
public void putExtras(Bundle bundle)
```
    Adds all extras from the given Bundle into this Sprite. Does not clear any previously existing extras. Makes a deep copy.
  - hasExtra
```
public boolean hasExtra(String name)
```
    Returns whether this sprite has the given extra property inside it.
  - removeExtra
```
public void 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.
  - clearExtras
```
public void clearExtras()
```
    Removes all extra properties inside this sprite.
  - setExtra
```
public void 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.
  - stop
```
public void 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.
  - update
```
public void update()
```
    Called by SimpleCanvas every time the animation ticks. Moves the sprite by dx and dy and applies acceleration.
  - setLoopBitmaps
```
public void 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.
  - 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.

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

Method Detail

setDebug

collidesWith

intersects

hasCollisionBoundary

paint

flipVelocityX

flipVelocityY

flipVelocity

rotateVelocity

getAccelerationX

getAccelerationY

getX

getY

getLeftX

getRightX

getTopY

getBottomY

getWidth

getHeight

getVelocityX

getVelocityY

getCollisionMarginX

getCollisionMarginLeft

getCollisionMarginRight

getCollisionMarginY

getCollisionMarginTop

getCollisionMarginBottom

getBitmap

getBitmaps

setBitmaps

setBitmaps

setCurrentBitmapIndex

setCurrentBitmapIndex

getFramesPerBitmap

setFramesPerBitmap

isCollidable

isMoving

isInBounds

isInBounds

isInBounds

isInBounds

isInBoundsHorizontal

isInBoundsHorizontal

isInBoundsHorizontal

isInBoundsHorizontal

isInBoundsVertical

isInBoundsVertical

isInBoundsVertical

isInBoundsVertical

bound

bound

bound

bound

boundHorizontal

boundHorizontal

boundHorizontal

boundHorizontal

boundVertical

boundVertical

boundVertical

boundVertical

isVisible

setAccelerationX

setAccelerationY

setAcceleration