com.thekeirs.games.engine

Class Sprite

java.lang.Object

com.thekeirs.games.engine.GameObject

com.thekeirs.games.engine.Sprite

public class Sprite
extends GameObject

Represents a GameObject that has an image associated with it, and a location on the screen to draw that image (left x, upper y, width, height).

A Sprite has no behaviors on its own. Rather than using a Sprite directly, in most cases you will create a subclass of Sprite that has the behaviors you need.

All coordinates and width/height are in world units.

Field Summary

Fields

Modifier and Type	Field and Description
protected android.graphics.Bitmap	mImage Stores the bitmap image to be displayed by this sprite
protected int	mImageId Holds the resource ID (R.drawable.* or R.raw.*) for this sprite's image

Fields inherited from class com.thekeirs.games.engine.GameObject

boundingRect, manager, name

Constructor Summary

Constructors

Constructor and Description
Sprite(java.lang.String name, float x, float y, float width, float height) Returns a Sprite game object with the given name and location/size on the screen.
Sprite(java.lang.String name, float x, float y, float width, float height, int image_id) Returns a Sprite game object with the given name and location/size on the screen and the given image.

Method Summary

Modifier and Type	Method and Description
void	draw(android.graphics.Canvas c, float xScale, float yScale) Called by the Game Engine to draw this sprite onto the screen every frame.
void	loadImage(int id) Configures the Sprite to display the image with the given id.
void	onFling(float x, float y, float dx, float dy) Called when the user makes a fling motion on the screen, starting at a location inside this sprite's bounding box.
void	onTouch(float x, float y) Called when the user taps the screen at a location inside this sprite's bounding box.
void	update(int msec) Called once per screen refresh to do whatever modifications are desired to the sprite's location, size, etc.

Methods inherited from class com.thekeirs.games.engine.GameObject

contains, getTimeOnScreen, hop, hopToward, intersects, isFullyOffScreen, isFullyOnScreen, isInside, moveBy, removalRequested, requestRemoval, setManager, setMaxTimeOnScreen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mImageId

protected int mImageId

Holds the resource ID (R.drawable.* or R.raw.*) for this sprite's image

mImage

protected android.graphics.Bitmap mImage

Stores the bitmap image to be displayed by this sprite

Constructor Detail

Sprite

public Sprite(java.lang.String name,
              float x,
              float y,
              float width,
              float height)

Returns a Sprite game object with the given name and location/size on the screen. This constructor does not take an image_id, so nothing will be shown on the screen for a Sprite created this way until loadImage(int) is called.

Parameters:

name - GameObject name for this sprite

x - left edge of the sprite

y - top edge of the sprite

width - width of the sprite

height - height of the sprite

Sprite

public Sprite(java.lang.String name,
              float x,
              float y,
              float width,
              float height,
              int image_id)

Returns a Sprite game object with the given name and location/size on the screen and the given image.

Parameters:

name - GameObject name for this sprite

x - left edge of the sprite

y - top edge of the sprite

width - width of the sprite

height - height of the sprite

image_id - the ID of the image to display (eg R.id.my_sprite)

Method Detail

loadImage

public void loadImage(int id)

Configures the Sprite to display the image with the given id. This change takes effect on the very next screen redraw. A Sprite can change images as often as desired.

Parameters:

id - the ID of the image to display (eg R.id.my_sprite)

onTouch

public void onTouch(float x,
                    float y)

Called when the user taps the screen at a location inside this sprite's bounding box.

Overrides:

onTouch in class GameObject

Parameters:

x - horizontal coordinate in world units

y - vertical coordinate in world units

onFling

public void onFling(float x,
                    float y,
                    float dx,
                    float dy)

Called when the user makes a fling motion on the screen, starting at a location inside this sprite's bounding box.

Overrides:

onFling in class GameObject

Parameters:

x - horizontal coordinate in world units

y - vertical coordinate in world units

update

public void update(int msec)

Called once per screen refresh to do whatever modifications are desired to the sprite's location, size, etc.

By default, sprites have no behavior - they just sit in one place. Override this method if desired to make your sprite move.

Overrides:

update in class GameObject

Parameters:

msec - number of milliseconds since the last screen update.

draw

public void draw(android.graphics.Canvas c,
                 float xScale,
                 float yScale)

Called by the Game Engine to draw this sprite onto the screen every frame. Do not call this routine yourself.

Specified by:

draw in class GameObject

Parameters:

c - Canvas object provided by the operating system

xScale - horizontal scale factor between world and screen coordinates

yScale - horizontal scale factor between world and screen coordinates