com.thekeirs.games.engine

Class BackgroundImageScene

java.lang.Object

com.thekeirs.games.engine.Scene

com.thekeirs.games.engine.BackgroundImageScene

public class BackgroundImageScene
extends Scene

A scene consisting of a single fixed background image

If you want your game to have a background more interesting than a SolidColorScene, create a new instance of this class with your desired image and pass that to the GameObjectManager.setScene(Scene) method.

Constructor Summary

Constructors

Constructor and Description
BackgroundImageScene(GameObjectManager manager, int id) Create a new BackgroundImageScene with the given image.

Method Summary

Modifier and Type	Method and Description
void	draw(android.graphics.Canvas c) Used by the game engine to draw the image on the screen.
void	setImage(int id) Change the image associated with this scene.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundImageScene

public BackgroundImageScene(GameObjectManager manager,
                            int id)

Create a new BackgroundImageScene with the given image.

Parameters:

manager - pointer to the current game object manager

id - resource ID of the image (eg R.raw.background_level1)

Method Detail

setImage

public void setImage(int id)

Change the image associated with this scene.

This can be used sparingly (for example, if you want the "lights" to turn off on a scene so it gets darker at some point) but probably isn't high-preformance enough to use it to make an animated background (ie, don't call setImage every single game update() loop!

Parameters:

id - resource ID of the image (eg R.raw.background_level2)

draw

public void draw(android.graphics.Canvas c)

Used by the game engine to draw the image on the screen. Do not call this directly.

Specified by:

draw in class Scene

Parameters:

c - the canvas object for the current screen