turtle

Class GameGrid

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.view.ContextThemeWrapper

android.app.Activity

turtle.GameGrid

All Implemented Interfaces:

android.content.ComponentCallbacks, android.media.MediaPlayer.OnCompletionListener, android.view.KeyEvent.Callback, android.view.LayoutInflater.Factory, android.view.View.OnCreateContextMenuListener, android.view.Window.Callback

Direct Known Subclasses:

Playground

public class GameGrid
extends android.app.Activity
implements android.media.MediaPlayer.OnCompletionListener

Class to create a container where the actors live in.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	turtleImage

Fields inherited from class android.app.Activity

DEFAULT_KEYS_DIALER, DEFAULT_KEYS_DISABLE, DEFAULT_KEYS_SEARCH_GLOBAL, DEFAULT_KEYS_SEARCH_LOCAL, DEFAULT_KEYS_SHORTCUT, RESULT_CANCELED, RESULT_FIRST_USER, RESULT_OK

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, AUDIO_SERVICE, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_NOT_FOREGROUND, CLIPBOARD_SERVICE, CONNECTIVITY_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DROPBOX_SERVICE, INPUT_METHOD_SERVICE, KEYGUARD_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MODE_APPEND, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NOTIFICATION_SERVICE, POWER_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, TELEPHONY_SERVICE, UI_MODE_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Method Summary

Methods

Modifier and Type	Method and Description
void	act() Empty method called in every simulation cycle after all actor act() calls.
GGStatusBar	addStatusBar(int barHeight) Adds a status bar at the bottom of the game grid window where a single line of text can be displayed.
GGStatusBar	addStatusBar(int ulx, int uly, int barWidth, int barHeight) Adds a status bar at a user defined position of the screen.
void	onCompletion(android.media.MediaPlayer mp) Notification method called when the playback of a media file terminates.
void	onConfigurationChanged(android.content.res.Configuration newConfig) Called by the system when the configuration is modified, e.g. when the device orientation changes.
boolean	onKeyDown(int keyCode, android.view.KeyEvent event) Notification method when a key is pressed.
boolean	onKeyLongPress(int keyCode, android.view.KeyEvent event) Notification method when a key is long pressed.
boolean	onKeyUp(int keyCode, android.view.KeyEvent event) Notification method when a key is released.
void	playgroundClicked(double x, double y) Event notification when the playground is clicked.
void	playgroundDragged(double x, double y) Event notification when the playground is dragged.
void	playgroundDragged(double x, double y, int pointerId) Event notification when the playground is dragged in a multi-touch event.
void	playgroundFlung(double xStart, double yStart, double xEnd, double yEnd, double v, double dir) Event notification when a fling event is detected.
void	playgroundLongPressed(double x, double y) Event notification when the playground is long pressed.
void	playgroundPointerPressed(double x, double y, int pointerId) Event notification when the playground is pressed (by the second, third, ... finger) in a multi-touch event.
void	playgroundPointerReleased(double x, double y, int pointerId) Event notification when the playground is released (by the second, third, ... finger) in a multi-touch event.
void	playgroundPressed(double x, double y) Event notification when the playground is pressed.
void	playgroundPressed(double x, double y, int pointerId) Event notification when the playground is pressed (by the first in a multi-touch event.
void	playgroundReleased(double x, double y) Event notification when the playground is released.
void	playgroundReleased(double x, double y, int pointerId) Event notification when the playground is released by the last finger in a multi-touch event.
void	playSound(java.lang.String soundResource) Same as playSound(String soundResource, boolean blocking) with blocking = true.
android.media.MediaPlayer	playSound(java.lang.String soundResource, boolean blocking) Plays the given sound resource.
void	refresh() Repaints the graphics to show any changes in the offscreen buffer.
void	setDragEnabled(boolean enable) Enable/disable drag event callbacks (to be active, touch must be enabled too) Because drag events may be triggered in rapid sequence, drag events are disabled by default.
void	setMultiDragEnabled(boolean enable) Enable/disable multi-touch drag event callbacks.
void	setMultiTouchEnabled(boolean enable) Enable/disable all multi-touch event callbacks.
void	setTouchEnabled(boolean enable) Enable/disable touch event callbacks (also fling events).
void	turtleClicked(Turtle turtle, double x, double y) Event notification when a turtle is clicked.
void	turtleDragged(Turtle turtle, double x, double y) Event notification when a turtle is dragged.
void	turtleLongPressed(Turtle turtle, double x, double y) Event notification when a turtle is long pressed.
void	turtlePressed(Turtle turtle, double x, double y) Event notification when a turtle is pressed.
void	turtleReleased(Turtle turtle, double x, double y) Event notification when a turtle is released.

Methods inherited from class android.app.Activity

addContentView, closeContextMenu, closeOptionsMenu, createPendingResult, dismissDialog, dispatchKeyEvent, dispatchPopulateAccessibilityEvent, dispatchTouchEvent, dispatchTrackballEvent, findViewById, finish, finishActivity, finishActivityFromChild, finishFromChild, getApplication, getCallingActivity, getCallingPackage, getChangingConfigurations, getComponentName, getCurrentFocus, getInstanceCount, getIntent, getLastNonConfigurationInstance, getLayoutInflater, getLocalClassName, getMenuInflater, getParent, getPreferences, getRequestedOrientation, getSystemService, getTaskId, getTitle, getTitleColor, getVolumeControlStream, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, getWindow, getWindowManager, hasWindowFocus, isChild, isFinishing, isTaskRoot, managedQuery, moveTaskToBack, onAttachedToWindow, onBackPressed, onContentChanged, onContextItemSelected, onContextMenuClosed, onCreateContextMenu, onCreateDescription, onCreateOptionsMenu, onCreatePanelMenu, onCreatePanelView, onCreateThumbnail, onCreateView, onDetachedFromWindow, onKeyMultiple, onLowMemory, onMenuItemSelected, onMenuOpened, onOptionsItemSelected, onOptionsMenuClosed, onPanelClosed, onPrepareOptionsMenu, onPreparePanel, onRetainNonConfigurationInstance, onSearchRequested, onTouchEvent, onTrackballEvent, onUserInteraction, onWindowAttributesChanged, onWindowFocusChanged, openContextMenu, openOptionsMenu, overridePendingTransition, registerForContextMenu, removeDialog, requestWindowFeature, runOnUiThread, setContentView, setContentView, setContentView, setDefaultKeyMode, setFeatureDrawable, setFeatureDrawableAlpha, setFeatureDrawableResource, setFeatureDrawableUri, setIntent, setPersistent, setProgress, setProgressBarIndeterminate, setProgressBarIndeterminateVisibility, setProgressBarVisibility, setRequestedOrientation, setResult, setResult, setSecondaryProgress, setTitle, setTitle, setTitleColor, setVisible, setVolumeControlStream, showDialog, showDialog, startActivity, startActivityForResult, startActivityFromChild, startActivityIfNeeded, startIntentSender, startIntentSenderForResult, startIntentSenderFromChild, startManagingCursor, startNextMatchingActivity, startSearch, stopManagingCursor, takeKeyEvents, triggerSearch, unregisterForContextMenu

Methods inherited from class android.view.ContextThemeWrapper

getTheme, setTheme

Methods inherited from class android.content.ContextWrapper

bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkUriPermission, checkUriPermission, clearWallpaper, createPackageContext, databaseList, deleteDatabase, deleteFile, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getContentResolver, getDatabasePath, getDir, getExternalCacheDir, getExternalFilesDir, getFilesDir, getFileStreamPath, getMainLooper, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getWallpaper, grantUriPermission, isRestricted, openFileInput, openFileOutput, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, removeStickyBroadcast, revokeUriPermission, sendBroadcast, sendBroadcast, sendOrderedBroadcast, sendOrderedBroadcast, sendStickyBroadcast, sendStickyOrderedBroadcast, setWallpaper, setWallpaper, startInstrumentation, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context

getString, getString, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes

Methods inherited from class java.lang.Object

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

Field Detail

turtleImage

public java.lang.String turtleImage

Method Detail

refresh

public void refresh()

Repaints the graphics to show any changes in the offscreen buffer. This method is automatically called in every simulation cycle (if not turned off by setRefreshEnabled(false)). Rapidly repeated refreshing by your own code may cause the graphics to flicker.

onConfigurationChanged

public void onConfigurationChanged(android.content.res.Configuration newConfig)

Called by the system when the configuration is modified, e.g. when the device orientation changes. If overridden, the superclass method should still be invoked.

Specified by:

onConfigurationChanged in interface android.content.ComponentCallbacks

Overrides:

onConfigurationChanged in class android.app.Activity

Parameters:

newConfig - a reference to the new configuration instance

act

public void act()

Empty method called in every simulation cycle after all actor act() calls. Override to get your own notification.

onKeyDown

public boolean onKeyDown(int keyCode,
                android.view.KeyEvent event)

Notification method when a key is pressed. Override to get your own key notification. Used when a navigation listener is registered.

Specified by:

onKeyDown in interface android.view.KeyEvent.Callback

Overrides:

onKeyDown in class android.app.Activity

Parameters:

keyCode - the code of the key

event - the type of event

Returns:

true, if the key is consumed; false, if the system function is still enabled

onKeyUp

public boolean onKeyUp(int keyCode,
              android.view.KeyEvent event)

Notification method when a key is released. Override to get your own key notification. Used when a navigation listener is registered.

Specified by:

onKeyUp in interface android.view.KeyEvent.Callback

Overrides:

onKeyUp in class android.app.Activity

Parameters:

keyCode - the code of the key

event - the type of event

Returns:

true, if the key is consumed; false, if the system function is still enabled

onKeyLongPress

public boolean onKeyLongPress(int keyCode,
                     android.view.KeyEvent event)

Notification method when a key is long pressed. Override to get your own key notification. Used when a navigation listener is registered.

Specified by:

onKeyLongPress in interface android.view.KeyEvent.Callback

Overrides:

onKeyLongPress in class android.app.Activity

Parameters:

keyCode - the code of the key

event - the type of event

Returns:

true, if the key is consumed; false, if the system function is still enabled

setTouchEnabled

public void setTouchEnabled(boolean enable)

Enable/disable touch event callbacks (also fling events).

Parameters:

enable - if true, the registered callbacks are enabled; otherwise disabled

setDragEnabled

public void setDragEnabled(boolean enable)

Enable/disable drag event callbacks (to be active, touch must be enabled too) Because drag events may be triggered in rapid sequence, drag events are disabled by default.

Parameters:

enable - if true, the registered callbacks are enabled; otherwise disabled

setMultiDragEnabled

public void setMultiDragEnabled(boolean enable)

Enable/disable multi-touch drag event callbacks. (to be active, multi-touch must be enabled too) Because multi-drag events may be triggered in rapid sequence, multi-drag events are disabled by default.

Parameters:

enable - if true, the registered callbacks are enabled; otherwise disabled

setMultiTouchEnabled

public void setMultiTouchEnabled(boolean enable)

Enable/disable all multi-touch event callbacks.

Parameters:

enable - if true, the registered callbacks are enabled; otherwise disabled

playSound

public android.media.MediaPlayer playSound(java.lang.String soundResource,
                                  boolean blocking)

Plays the given sound resource. (The following system sound resources are distributed by the ProjectBuilder: "boing_", "click_", "ping_".)

Parameters:

soundResource - the path name of the audio file (must have one of the supported audio format). If no file name extension is used, the resource file is searched in the 'raw' resource folder. If an extension is given, the resource file is searched in the given relative path on the sdcard (the prefix '/sdcard'/ is added by the system)

blocking - if true, blocks until sound has finished; otherwise returns immediately

Returns:

the MediaPlayer reference. May be used to check the state, if blocking = false

playSound

public void playSound(java.lang.String soundResource)

Same as playSound(String soundResource, boolean blocking) with blocking = true.

Parameters:

soundResource - the path name of the audio file (must have one of the supported audio format). If no file name extension is used, the resource file is searched in the 'raw' resource folder. If an extension is given, the resource file is searched in the given relative path on the sdcard (the prefix '/sdcard'/ is added by the system)

onCompletion

public void onCompletion(android.media.MediaPlayer mp)

Notification method called when the playback of a media file terminates. Calls MediaPlayer.release() to release all system resources. If overridden to get your own notification, call super.onCompletion() to release the resources.

Specified by:

onCompletion in interface android.media.MediaPlayer.OnCompletionListener

Parameters:

mp - the MediaPlayer that terminiates

addStatusBar

public GGStatusBar addStatusBar(int ulx,
                       int uly,
                       int barWidth,
                       int barHeight)

Adds a status bar at a user defined position of the screen. If it overlaps with the game grid window, it is put on top, hiding part of the game grid.
The method must be called in the public Playground constructor.
The following default attributes are used:
Text font: Typeface.DEFAULT (immutable)
Text height: 0.7 * barHeight (immutable)
Background color: Color.rgb(90, 90, 90) (mutable)
Border color: Color.WHITE (mutable)
Text color: Color.WHITE (mutable)
Auto refresh: disabled (mutable)

Parameters:

ulx - the pixel x-coordinate of the upper left vertex

uly - the pixel y-coordinate of the upper left vertex

barHeight - the height of the status bar in pixel units (the number of pixels is barHeight + 1).

barWidth - the width of the status bar in pixel units (the number of pixels is barWidth + 1).

Returns:

a reference to the created GGStatusBar

addStatusBar

public GGStatusBar addStatusBar(int barHeight)

Adds a status bar at the bottom of the game grid window where a single line of text can be displayed. The width of the bar is adapted to the width of the game grid window.
The method must be called in the public Playground constructor.
The game grid window is resized and displaced to give space for the status bar.
The following default attributes are used:
Text font: Typeface.DEFAULT (immutable)
Text height: 0.7 * barHeight (immutable)
Background color: Color.rgb(90, 90, 90) (mutable)
Border color: Color.WHITE (mutable)
Text color: Color.WHITE (mutable)
Auto refresh: disabled (mutable)

Parameters:

barHeight - the height of the status bar in pixel units (the number of pixels is barHeight + 1).

Returns:

a reference to the created GGStatusBar

playgroundPressed

public void playgroundPressed(double x,
                     double y)

Event notification when the playground is pressed. Empty implementation, override to get your own notification. Override to get your own notification. Invoked in a new independent thread.

Parameters:

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

playgroundPressed

public void playgroundPressed(double x,
                     double y,
                     int pointerId)

Event notification when the playground is pressed (by the first in a multi-touch event. Empty implementation, override to get your own notification. Override to get your own notification. Invoked in a new independent thread.

Parameters:

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

pointerId - the pointer ID of the touch event (always 0)

playgroundPointerPressed

public void playgroundPointerPressed(double x,
                            double y,
                            int pointerId)

Event notification when the playground is pressed (by the second, third, ... finger) in a multi-touch event. Empty implementation, override to get your own notification. Override to get your own notification. Invoked in a new independent thread.

Parameters:

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

pointerId - the pointer ID of the touch event

playgroundReleased

public void playgroundReleased(double x,
                      double y)

Event notification when the playground is released. Empty implementation, override to get your own notification. Invoked in a new independent thread.

Parameters:

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

playgroundReleased

public void playgroundReleased(double x,
                      double y,
                      int pointerId)

Event notification when the playground is released by the last finger in a multi-touch event. Empty implementation, override to get your own notification. Invoked in a new independent thread.

Parameters:

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

pointerId - the pointer ID of the touch event

playgroundPointerReleased

public void playgroundPointerReleased(double x,
                             double y,
                             int pointerId)

Event notification when the playground is released (by the second, third, ... finger) in a multi-touch event. Empty implementation, override to get your own notification. Override to get your own notification. Invoked in a new independent thread.

Parameters:

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

pointerId - the pointer ID of the touch event

playgroundLongPressed

public void playgroundLongPressed(double x,
                         double y)

Event notification when the playground is long pressed. Empty implementation, override to get your own notification. Invoked in a new independent thread.

Parameters:

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

playgroundClicked

public void playgroundClicked(double x,
                     double y)

Event notification when the playground is clicked. Empty implementation, override to get your own notification. Invoked in a new independent thread.

Parameters:

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

playgroundDragged

public void playgroundDragged(double x,
                     double y)

Event notification when the playground is dragged. Empty implementation, override to get your own notification. Invoked in a new independent thread.

Parameters:

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

playgroundDragged

public void playgroundDragged(double x,
                     double y,
                     int pointerId)

Event notification when the playground is dragged in a multi-touch event. Empty implementation, override to get your own notification. Invoked in a new independent thread.

Parameters:

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

pointerId - the pointer ID of the touch event

playgroundFlung

public void playgroundFlung(double xStart,
                   double yStart,
                   double xEnd,
                   double yEnd,
                   double v,
                   double dir)

Event notification when a fling event is detected. Empty implementation, override to get your own notification. Invoked in a new independent thread.

Parameters:

xStart - the x coordinate of the finger touch location (turtle coordinate system)

yStart - the y coordinate of the finger touch location (turtle coordinate system)

xEnd - the x coordinate of the finger release location (turtle coordinate system)

yEnd - the y coordinate of the finger release location (turtle coordinate system)

v - the speed of the fling (in turtle coordinates per seconds)

dir - the direction of the fling (in degrees, 0 to north, clockwise)

turtleClicked

public void turtleClicked(Turtle turtle,
                 double x,
                 double y)

Event notification when a turtle is clicked. Empty implementation, override to get your own notification. When turtles are overlaid, the topmost turtle fires the event. Invoked in a new independent thread.

Parameters:

turtle - the reference of the touched turtle

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtlec oordinate system)

turtleDragged

public void turtleDragged(Turtle turtle,
                 double x,
                 double y)

Event notification when a turtle is dragged. Empty implementation, override to get your own notification. When turtles are overlaid, the topmost turtle fires the event. Invoked in a new independent thread.

Parameters:

turtle - the reference of the touched turtle

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

turtlePressed

public void turtlePressed(Turtle turtle,
                 double x,
                 double y)

Event notification when a turtle is pressed. Empty implementation, override to get your own notification. When turtles are overlaid, the topmost turtle fires the event. Invoked in a new independent thread.

Parameters:

turtle - the reference of the touched turtle

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

turtleReleased

public void turtleReleased(Turtle turtle,
                  double x,
                  double y)

Event notification when a turtle is released. Empty implementation, override to get your own notification. When turtles are overlaid, the topmost turtle fires the event. Invoked in a new independent thread.

Parameters:

turtle - the reference of the touched turtle

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)

turtleLongPressed

public void turtleLongPressed(Turtle turtle,
                     double x,
                     double y)

Event notification when a turtle is long pressed. Empty implementation, override to get your own notification. When turtles are overlaid, the topmost turtle fires the event. Invoked in a new independent thread.

Parameters:

turtle - the reference of the touched turtle

x - the x coordinate of the touch event (turtle coordinate system)

y - the y coordinate of the touch event (turtle coordinate system)