Java Game API

8/20/2019 Java Game API

1/101

Package javax.microedition.lcdui.gamei. The Game API package provides a series of classes that enable the development of rich gaming content for wireless devices.

ii. Wireless devices have minimal processing power, so much of the API is intended to improve performance by minimizing the

amount of work done in Java; this approach also has the added benefit of reducing application size.

iii.

The API's are structured to provide considerable freedom when implementing them, thereby permitting the extensive use of

native code, hardware acceleration and device-specific image data formats as needed.

iv.

The API uses the standard low-level graphics classes from MIDP (Graphics, Image, etc.) so that the high-level Game API

classes can be used in conjunction with graphics primitives. For example, it would be possible to render a complex background

using the Game API and then render something on top of it using graphics primitives such as drawLine, etc.

v.

Methods that modify the state of Layer, LayerManager, Sprite, and TiledLayer objects generally do not have any immediatelyvisible side effects. Instead, this state is merely stored within the object and is used during subsequent calls to the paint()

method. This approach is suitable for gaming applications where there is a game cycle within which objects' states are updated,

and where the entire screen is redrawn at the end of every game cycle.

vi. The API is comprised of five classes:

Class Summary GameCanvas The GameCanvas class provides the basis for a game user interface.

Layer A Layer is an abstract class representing a visual element of a game.

LayerManager The LayerManager manages a series of Layers.

Sprite A Sprite is a basic visual element that can be rendered with one of several frames stored in an Image;

different frames can be shown to animate the Sprite.

TiledLayer A TiledLayer is a visual element composed of a grid of cells that can be filled with a set of tile

images.

Class GameCanvasi.

Declaration: public abstract class GameCanvas extends Canvas

ii.

The GameCanvas class provides the basis 'screen' functionality for a game user interface. In addition to the features inherited

from Canvas (commands, input events, etc.) it also provides game-specific capabilities such as an off-screen graphics buffer,

synchronous graphics flushing and the ability to query key status.

iii.

A dedicated buffer is created for each GameCanvas instance. Since a unique buffer is provided for each GameCanvas instance,

it is preferable to re-use a single GameCanvas instance in the interests of minimizing heap usage.

iv.

The developer can assume that the contents of this buffer are modified only by calls to the Graphics object(s) obtained from

the GameCanvas instance; the contents are not modified by external sources such as other MIDlets or system-level

notifications.

v.

The buffer is initially filled with white pixels.

vi. The buffer's size is set to the maximum dimensions of the GameCanvas. However, the area that may be flushed is limited by

the current dimensions of the GameCanvas (as influenced by the presence of a Ticker, Commands, etc.) when the flush is

requested. The current dimensions of the GameCanvas may be obtained by calling getWidth and getHeight.

vii.

A game may provide its own thread to run the game loop. A typical loop will check for input, implement the game logic, and

then render the updated user interface. The following code illustrates the structure of a typcial game loop:// Get the Graphics object for the off-screen bufferGraphics g = getGraphics();while (true) {

// Check user input and update positions if necessaryint keyState = getKeyStates();if ((keyState & LEFT_PRESSED) != 0) {

sprite.move(-1, 0);}

else if ((keyState & RIGHT_PRESSED) != 0) {sprite.move(1, 0);

}

// Clear the background to whiteg.setColor(0xFFFFFF);g.fillRect(0,0,getWidth(), getHeight());

// Draw the Spritesprite.paint(g);// Flush the off-screen bufferflushGraphics();

}

http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Canvas.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Displayable.html%23getWidth()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Displayable.html%23getWidth()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Displayable.html%23getWidth()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Displayable.html%23getHeight()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Displayable.html%23getHeight()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Displayable.html%23getHeight()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Displayable.html%23getHeight()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Displayable.html%23getWidth()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Canvas.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html


2/102

Field Summarystatic int DOWN_PRESSED

The bit representing the DOWN key.static int FIRE_PRESSED

The bit representing the FIRE key.static int GAME_A_PRESSED

The bit representing the GAME_A key (may not be supported on all devices).

static int GAME_B_PRESSED The bit representing the GAME_B key (may not be supported on all devices).

static int GAME_C_PRESSED

The bit representing the GAME_C key (may not be supported on all devices).static int GAME_D_PRESSED

The bit representing the GAME_D key (may not be supported on all devices).static int LEFT_PRESSED

The bit representing the LEFT key.static int RIGHT_PRESSED

The bit representing the RIGHT key.static int UP_PRESSED

The bit representing the UP key.

Constructor Summaryprotected GameCanvas(boolean suppressKeyEvents)

Creates a new instance of a GameCanvas.

Method Summaryvoid flushGraphics()

Flushes the off-screen buffer to the display.void flushGraphics(int x, int y, int width, int height)

Flushes the specified region of the off-screen buffer to the display.protected Graphics getGraphics()

Obtains the Graphics object for rendering a GameCanvas.int

getKeyStates() Gets the states of the physical game keys.void paint(Graphics g)

Paints this GameCanvas.

Class Layeri. Declaration:

public abstract class Layer extends Object

ii. The Layer class represents a visual element in a game such as a Sprite or a TiledLayer. This abstract class forms the basis for

the Layer framework and provides basic attributes such as location, size, and visibility.

iii. Each Layer has position (in terms of the upper-left corner of its visual bounds), width, height, and can be made visible or

invisible. Layer subclasses must implement a paint(Graphics) method so that they can be rendered.

iv.

The Layer's (x,y) position is always interpreted relative to the coordinate system of the Graphics object that is passed to the

Layer's paint() method. This coordinate system is referred to as the painter's coordinate system. The initial location of a Layeris (0,0).

Method Summaryint getHeight()

Gets the current height of this layer, in pixels.int getWidth()

Gets the current width of this layer, in pixels.int getX()

Gets the horizontal position of this Layer's upper-left corner in the painter's coordinate system.int getY()

Gets the vertical position of this Layer's upper-left corner in the painter's coordinate system.

http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23DOWN_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23DOWN_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23FIRE_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23FIRE_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_A_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_A_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_B_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_B_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_C_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_C_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_D_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_D_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23LEFT_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23LEFT_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23RIGHT_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23RIGHT_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23UP_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23UP_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GameCanvas(boolean)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23flushGraphics()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23flushGraphics(int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23getGraphics()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23getKeyStates()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/java/lang/Object.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/java/lang/Object.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getHeight()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getWidth()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getWidth()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getHeight()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/java/lang/Object.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23getKeyStates()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23getGraphics()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23flushGraphics(int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23flushGraphics()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GameCanvas(boolean)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23UP_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23RIGHT_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23LEFT_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_D_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_C_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_B_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23GAME_A_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23FIRE_PRESSEDhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/GameCanvas.html%23DOWN_PRESSED


3/103

boolean isVisible()

Gets the visibility of this Layer.void move(int dx, int dy)

Moves this Layer by the specified horizontal and vertical distances.abstract void paint(Graphics g)

Paints this Layer if it is visible.void setPosition(int x, int y)

Sets this Layer's position such that its upper-left corner is located at (x,y) in the painter's

coordinate system.

void setVisible(boolean visible) Sets the visibility of this Layer.

LayerManageri.

Declaration:public class LayerManager extends Object

ii.

The LayerManager manages a series of Layers. The LayerManager simplifies the process of rendering the Layers that have

been added to it by automatically rendering the correct regions of each Layer in the appropriate order.

iii.

The LayerManager maintains an ordered list to which Layers can be appended, inserted and removed. A Layer's index

correlates to its z-order; the layer at index 0 is closest to the user while a the Layer with the highest index is furthest away from

the user.

iv.

The indices are always contiguous; that is, if a Layer is removed, the indices of subsequent Layers will be adjusted to maintain

continuity.

v.

The LayerManager class provides several features that control how the game's Layers are rendered on the screen.vi.

The view window controls the size of the visible region and its position relative to the LayerManager's coordinate system.

Changing the position of the view window enables effects such as scrolling or panning the user's view. For example, to scroll to

the right, simply move the view window's location to the right. The size of the view window controls how large the user's view

will be, and is usually fixed at a size that is appropriate for the device's screen.

vii. In this example, the view window is set to 85 x 85 pixels and is located at (52, 11) in the LayerManager's coordinate system.

The Layers appear at their respective positions relative to the LayerManager's origin.

viii. The paint(Graphics, int, int) method includes an (x,y) location that controls where the view window is rendered

relative to the screen. Changing these parameters does not change the contents of the view window, it simply changes the

location where the view window is drawn. Note that this location is relative to the origin of the Graphics object, and thus it is

subject to the translation attributes of the Graphics object.

ix.

For example, if a game uses the top of the screen to display the current score, the view window may be rendered at (17, 17) to

provide enough space for the score.

Constructor Summary

LayerManager()

Creates a new LayerManager.

Method Summaryvoid append(Layer l)

Appends a Layer to this LayerManager.Layer getLayerAt(int index)

Gets the Layer with the specified index.int getSize()

Gets the number of Layers in this LayerManager.

http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23isVisible()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23move(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23setPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23setVisible(boolean)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23LayerManager()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23append(javax.microedition.lcdui.game.Layer)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23getLayerAt(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23getSize()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23getSize()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23getLayerAt(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23append(javax.microedition.lcdui.game.Layer)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23LayerManager()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23setVisible(boolean)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23setPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23move(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23isVisible()


4/104

void insert(Layer l, int index)

Inserts a new Layer in this LayerManager at the specified index.void paint(Graphics g, int x, int y)

Renders the LayerManager's current view window at the specified location.void remove(Layer l)

Removes the specified Layer from this LayerManager.void setViewWindow(int x, int y, int width, int height)

Sets the view window on the LayerManager.

TiledLayeri. Declaration:

public class TiledLayer extends Layer

ii. A TiledLayer is a visual element composed of a grid of cells that can be filled with a set of tile images. This class allows

large virtual layers to be created without the need for an extremely large Image. This technique is commonly used in 2D

gaming platforms to create very large scrolling backgrounds,

iii.

Tiles

The tiles used to fill the TiledLayer's cells are provided in a single Image object which may be mutable or immutable. The

Image is broken up into a series of equally-sized tiles; the tile size is specified along with the Image.

As shown in the figure below, the same tile set can be stored in several different arrangements depending on what is the

most convenient for the game developer.

Each tile is assigned a unique index number. The tile located in the upper-left corner of the Image is assigned an index of 1.

The remaining tiles are then numbered consecutively in row-major order (indices are assigned across the first row, then the

second row, and so on).

These tiles are regarded as static tiles because there is a fixed link between the tile and the image data associated with it. A

static tile set is created when the TiledLayer is instantiated; it can also be updated at any time using

the setStaticTileSet(javax.microedition.lcdui.Image, int, int) method.

In addition to the static tile set, the developer can also define several animated tiles. An animated tile is a virtual tile that is

dynamically associated with a static tile; the appearance of an animated tile will be that of the static tile that it is currently

associated with.

Animated tiles allow the developer to change the appearance of a group of cells very easily. With the group of cells all filledwith the animated tile, the appearance of the entire group can be changed by simply changing the static tile associated with

the animated tile. This technique is very useful for animating large repeating areas without having to explicitly change the

contents of numerous cells such as areas of water.

Animated tiles are created using the createAnimatedTile(int) method, which returns the index to be used for the new

animated tile. The animated tile indices are always negative and consecutive, beginning with -1. Once created, the static tile

associated with an animated tile can be changed using the setAnimatedTile(int, int) method.

iv.

Cells

The TiledLayer's grid is made up of equally sized cells; the number of rows and columns in the grid are specified in the

constructor, and the physical size of the cells is defined by the size of the tiles.

http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23insert(javax.microedition.lcdui.game.Layer,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23paint(javax.microedition.lcdui.Graphics,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23remove(javax.microedition.lcdui.game.Layer)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23setViewWindow(int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23createAnimatedTile(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23createAnimatedTile(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23createAnimatedTile(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23setAnimatedTile(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23setAnimatedTile(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23setAnimatedTile(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23setAnimatedTile(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23createAnimatedTile(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23setViewWindow(int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23remove(javax.microedition.lcdui.game.Layer)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23paint(javax.microedition.lcdui.Graphics,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/LayerManager.html%23insert(javax.microedition.lcdui.game.Layer,%20int)


5/105

The contents of each cell is specified by means of a tile index; a positive tile index refers to a static tile, and a negative tile

index refers to an animated tile. A tile index of 0 indicates that the cell is empty; an empty cell is fully transparent and

nothing is drawn in that area by the TiledLayer. By default, all cells contain tile index 0.

The contents of cells may be changed using setCell(int, int, int) and fillCells(int, int, int, int,

int). Several cells may contain the same tile; however, a single cell cannot contain more than one tile. The following

example illustrates how a simple background can be created using a TiledLayer.

In this example, the area of water is filled with an animated tile having an index of -1, which is initially associated with

static tile 5. The entire area of water may be animated by simply changing the associated static tile using

setAnimatedTile(-1, 7).

v.

Rendering a TiledLayer

A TiledLayer can be rendered by manually calling its paint method; it can also be rendered automatically using a

LayerManager object.

The paint method will attempt to render the entire TiledLayer subject to the clip region of the Graphics object; the upper

left corner of the TiledLayer is rendered at its current (x,y) position relative to the Graphics object's origin. The rendered

region may be controlled by setting the clip region of the Graphics object accordingly.

Constructor Summary

TiledLayer(int columns, int rows, Image image, int tileWidth, int tileHeight) Creates a new TiledLayer.

Method Summaryint createAnimatedTile(int staticTileIndex)

Creates a new animated tile and returns the index that refers to the new animated tile.void fillCells(int col, int row, int numCols, int numRows, int tileIndex)

Fills a region cells with the specific tile.int getAnimatedTile(int animatedTileIndex)

Gets the tile referenced by an animated tile.int getCell(int col, int row)

Gets the contents of a cell.

int getCellHeight() Gets the height of a single cell, in pixels.

int getCellWidth()

Gets the width of a single cell, in pixels.int getColumns()

Gets the number of columns in the TiledLayer grid.int getRows()

Gets the number of rows in the TiledLayer grid.void paint(Graphics g)

Draws the TiledLayer.void setAnimatedTile(int animatedTileIndex, int staticTileIndex)

Associates an animated tile with the specified static tile.

http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23setCell(int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23setCell(int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23setCell(int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23fillCells(int,%20int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23fillCells(int,%20int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23fillCells(int,%20int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23fillCells(int,%20int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23TiledLayer(int,%20int,%20javax.microedition.lcdui.Image,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Image.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23createAnimatedTile(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23fillCells(int,%20int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getAnimatedTile(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getCell(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getCellHeight()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getCellWidth()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getColumns()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getRows()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23setAnimatedTile(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23setAnimatedTile(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getRows()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getColumns()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getCellWidth()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getCellHeight()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getCell(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23getAnimatedTile(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23fillCells(int,%20int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23createAnimatedTile(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Image.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23TiledLayer(int,%20int,%20javax.microedition.lcdui.Image,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23fillCells(int,%20int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23fillCells(int,%20int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.html%23setCell(int,%20int,%20int)


6/10


7/107

For example, the diagram below shows how a special frame sequence might be used to animate a mosquito. The frame

sequence is designed so that the mosquito flaps its wings three times and then pauses for a moment before the cycle is

repeated.

By calling nextFrame() each time the display is updated, the resulting animation.

vii. Reference Pixel

Being a subclass of Layer, Sprite inherits various methods for setting and retrieving its location suchas setPosition(x,y), getX(), and getY(). These methods all define position in terms of the upper-left corner of the

Sprite's visual bounds.

However, in some cases, it is more convenient to define the Sprite's position in terms of an arbitrary pixel within its frame,

especially if transforms are applied to the Sprite.

Therefore, Sprite includes the concept of a reference pixel . The reference pixel is defined by specifying its location in the

Sprite's untransformed frame using defineReferencePixel(x,y).

By default, the reference pixel is defined to be the pixel at (0,0) in the frame. If desired, the reference pixel may be defined

outside of the frame's bounds.

In this example, the reference pixel is defined to be the pixel that the monkey appears to be hanging from

http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23nextFrame()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23nextFrame()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23nextFrame()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23setPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23setPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23setPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23defineReferencePixel(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23defineReferencePixel(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23defineReferencePixel(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23defineReferencePixel(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23setPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23nextFrame()


8/108

getRefPixelX() and getRefPixelY() can be used to query the location of the reference pixel in the painter's coordinate

system.

The developer can also use setRefPixelPosition(x,y) to position the Sprite so that reference pixel appears at a

specific location in the painter's coordinate system. These methods automatically account for any transforms applied to the

Sprite.

In this example, the reference pixel's position is set to a point at the end of a tree branch; the Sprite's location changes so that

the reference pixel appears at this point and the monkey appears to be hanging from the branch:

viii.

Sprite Transforms

Various transforms can be applied to a Sprite. The available transforms include rotations in multiples of 90 degrees, and

mirrored (about the vertical axis) versions of each of the rotations. A Sprite's transform is set by

calling setTransform(transform).

When a transform is applied, the Sprite is automatically repositioned such that the reference pixel appears stationary in the

painter's coordinate system. Thus, the reference pixel effectively becomes the center of the transform operation.

Since the reference pixel does not move, the values returned by getRefPixelX() and getRefPixelY() remain the same;

however, the values returned by getX() and getY() may change to reflect the movement of the Sprite's upper-left corner.

Referring to the monkey example once again, the position of the reference pixel remains at (48, 22) when a 90 degree

rotation is applied, thereby making it appear as if the monkey is swinging from the branch.

ix. Sprite Drawing

Sprites can be drawn at any time using the paint(Graphics) method. The Sprite will be drawn on the Graphics object

according to the current state information maintained by the Sprite (i.e. position, frame, visibility). Erasing the Sprite is always the responsibility of code outside the Sprite class.

Sprites can be implemented using whatever techniques a manufacturers wishes to use (e.g hardware acceleration may be

used for all Sprites, for certain sizes of Sprites, or not at all).

For some platforms, certain Sprite sizes may be more efficient than others; manufacturers may choose to provide developers

with information about device-specific characteristics such as these.

http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setRefPixelPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setRefPixelPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setRefPixelPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setTransform(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setTransform(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setTransform(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Layer.html%23getX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setTransform(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setRefPixelPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelX()


9/109

Field Summarystatic int TRANS_MIRROR

Causes the Sprite to appear reflected about its vertical center.static int TRANS_MIRROR_ROT180

Causes the Sprite to appear reflected about its vertical center and then rotated clockwise by 180

degrees.static int TRANS_MIRROR_ROT270

Causes the Sprite to appear reflected about its vertical center and then rotated clockwise by 270

degrees.static int TRANS_MIRROR_ROT90

Causes the Sprite to appear reflected about its vertical center and then rotated clockwise by 90degrees.static int TRANS_NONE

No transform is applied to the Sprite.static int TRANS_ROT180

Causes the Sprite to appear rotated clockwise by 180 degrees.static int TRANS_ROT270

Causes the Sprite to appear rotated clockwise by 270 degrees.static int TRANS_ROT90

Causes the Sprite to appear rotated clockwise by 90 degrees.

Constructor Summary

http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRRORhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRRORhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRROR_ROT180http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRROR_ROT180http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRROR_ROT270http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRROR_ROT270http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRROR_ROT90http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRROR_ROT90http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_NONEhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_NONEhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_ROT180http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_ROT180http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_ROT270http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_ROT270http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_ROT90http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_ROT90http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_ROT90http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_ROT270http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_ROT180http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_NONEhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRROR_ROT90http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRROR_ROT270http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRROR_ROT180http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23TRANS_MIRROR


10/1010

Sprite(Image image)

Creates a new non-animated Sprite using the provided Image.

Sprite(Image image, int frameWidth, int frameHeight)

Creates a new animated Sprite using frames contained in the provided Image.

Sprite(Sprite s)

Creates a new Sprite from another Sprite.

Method Summaryboolean collidesWith(Image image, int x, int y, boolean pixelLevel)

Checks for a collision between this Sprite and the specified Image with its upper left corner at thespecified location.

boolean collidesWith(Sprite s, boolean pixelLevel)

Checks for a collision between this Sprite and the specified Sprite.boolean collidesWith(TiledLayer t, boolean pixelLevel)

Checks for a collision between this Sprite and the specified TiledLayer.void defineCollisionRectangle(int x, int y, int width, int height)

Defines the Sprite's bounding rectangle that is used for collision detection purposes.void defineReferencePixel(int x, int y)

Defines the reference pixel for this Sprite.int getFrame()

Gets the current index in the frame sequence.int getFrameSequenceLength()

Gets the number of elements in the frame sequence.int getRawFrameCount()

Gets the number of raw frames for this Sprite.int getRefPixelX()

Gets the horizontal position of this Sprite's reference pixel in the painter's coordinate system.int getRefPixelY()

Gets the vertical position of this Sprite's reference pixel in the painter's coordinate system.void nextFrame()

Selects the next frame in the frame sequence.void paint(Graphics g)

Draws the Sprite.void prevFrame()

Selects the previous frame in the frame sequence.void setFrame(int sequenceIndex)

Selects the current frame in the frame sequence.void setFrameSequence(int[] sequence)

Set the frame sequence for this Sprite.void setImage(Image img, int frameWidth, int frameHeight)

Changes the Image containing the Sprite's frames.void setRefPixelPosition(int x, int y)

Sets this Sprite's position such that its reference pixel is located at (x,y) in the painter's coordinate

system.void setTransform(int transform)

Sets the transform for this Sprite.
http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23Sprite(javax.microedition.lcdui.Image)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Image.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23Sprite(javax.microedition.lcdui.Image,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Image.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23Sprite(javax.microedition.lcdui.game.Sprite)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23collidesWith(javax.microedition.lcdui.Image,%20int,%20int,%20boolean)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Image.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23collidesWith(javax.microedition.lcdui.game.Sprite,%20boolean)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23collidesWith(javax.microedition.lcdui.game.TiledLayer,%20boolean)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23defineCollisionRectangle(int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23defineReferencePixel(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getFrame()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getFrameSequenceLength()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRawFrameCount()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23nextFrame()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23prevFrame()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setFrame(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setFrameSequence(int%5b%5d)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setImage(javax.microedition.lcdui.Image,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Image.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setRefPixelPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setTransform(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setTransform(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setRefPixelPosition(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Image.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setImage(javax.microedition.lcdui.Image,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setFrameSequence(int%5b%5d)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23setFrame(int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23prevFrame()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Graphics.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23paint(javax.microedition.lcdui.Graphics)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23nextFrame()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelY()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRefPixelX()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getRawFrameCount()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getFrameSequenceLength()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23getFrame()http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23defineReferencePixel(int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23defineCollisionRectangle(int,%20int,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/TiledLayer.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23collidesWith(javax.microedition.lcdui.game.TiledLayer,%20boolean)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23collidesWith(javax.microedition.lcdui.game.Sprite,%20boolean)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Image.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23collidesWith(javax.microedition.lcdui.Image,%20int,%20int,%20boolean)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23Sprite(javax.microedition.lcdui.game.Sprite)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Image.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23Sprite(javax.microedition.lcdui.Image,%20int,%20int)http://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/Image.htmlhttp://c/Java_ME_platform_SDK_3.0/docs/api/midp-2.0/javax/microedition/lcdui/game/Sprite.html%23Sprite(javax.microedition.lcdui.Image)

Documents

Java Game API