com.jme3.app

Class AndroidHarnessFragment

java.lang.Object

android.app.Fragment

com.jme3.app.AndroidHarnessFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.content.DialogInterface.OnClickListener, android.view.View.OnCreateContextMenuListener, android.view.View.OnLayoutChangeListener, com.jme3.input.controls.InputListener, com.jme3.input.controls.TouchListener, com.jme3.system.SystemListener

public class AndroidHarnessFragment
extends android.app.Fragment
implements com.jme3.input.controls.TouchListener, android.content.DialogInterface.OnClickListener, android.view.View.OnLayoutChangeListener, com.jme3.system.SystemListener

Author:

iwgeric

Nested Class Summary

Nested classes/interfaces inherited from class android.app.Fragment

android.app.Fragment.InstantiationException, android.app.Fragment.SavedState

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	appClass The application class to start
protected java.lang.String	audioRendererType Sets the type of Audio Renderer to be used.
protected int	eglAlphaBits Sets the desired number of Alpha bits for the surfaceview.
protected int	eglBitsPerPixel Sets the desired RGB size for the surfaceview.
protected int	eglDepthBits The number of depth bits specifies the precision of the depth buffer.
protected int	eglSamples Sets the number of samples to use for multisampling. Leave 0 (default) to disable multisampling. Set to 2 or 4 to enable multisampling.
protected int	eglStencilBits Set the number of stencil bits.
protected java.lang.String	exitDialogMessage Message of the exit dialog, default is "Use your home key to bring this app into the background or exit to terminate it."
protected java.lang.String	exitDialogTitle Title of the exit dialog, default is "Do you want to exit?"
protected boolean	finishOnAppStop if true finish this activity when the jme app is stopped
protected android.widget.FrameLayout	frameLayout
protected int	frameRate Set the desired frame rate.
protected boolean	handleExitHook set to false if you don't want the harness to handle the exit hook
protected boolean	joystickEventsEnabled If true Android Sensors are used as simulated Joysticks.
protected boolean	keyEventsEnabled If true KeyEvents are generated from TouchEvents
protected int	maxResolutionDimension Set the maximum resolution for the surfaceview in either the width or height screen direction depending on the screen size.
protected boolean	mouseEventsEnabled If true MouseEvents are generated from TouchEvents
protected boolean	mouseEventsInvertX Flip X axis
protected boolean	mouseEventsInvertY Flip Y axis
protected android.widget.ImageView	splashImageView
protected int	splashPicID Splash Screen picture Resource ID.
protected android.opengl.GLSurfaceView	view

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
AndroidHarnessFragment()

Method Summary

Modifier and Type	Method and Description
void	createLayout()
void	destroy()
void	gainFocus()
com.jme3.app.Application	getJmeApplication()
void	handleError(java.lang.String errorMsg, java.lang.Throwable t) Called when an error has occurred.
void	initialize()
protected void	initializeLogHandler() Removes the standard Android log handler due to an issue with not logging entries lower than INFO level and adds a handler that produces JME formatted log messages.
void	loseFocus()
void	onActivityCreated(android.os.Bundle savedInstanceState)
void	onAttach(android.app.Activity activity)
void	onClick(android.content.DialogInterface dialog, int whichButton) Called by the android alert dialog, terminate the activity and OpenGL rendering
void	onCreate(android.os.Bundle savedInstanceState) This Fragment uses setRetainInstance(true) so the onCreate method will only be called once.
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState) Called by the system to create the View hierchy associated with this Fragment.
void	onDestroy() Called by the system when the application is being destroyed.
void	onDestroyView() Called by the Android system each time the Activity is destroyed or recreated.
void	onDetach()
void	onLayoutChange(android.view.View v, int left, int top, int right, int bottom, int oldLeft, int oldTop, int oldRight, int oldBottom)
void	onPause() When the Fragment pauses (ie.
void	onResume() When the Fragment resumes (ie.
void	onStart()
void	onStop()
void	onTouch(java.lang.String name, com.jme3.input.event.TouchEvent evt, float tpf) Gets called by the InputManager on all touch/drag/scale events
void	removeSplashScreen()
void	requestClose(boolean esc)
void	reshape(int width, int height)
void	update()

Methods inherited from class android.app.Fragment

dump, equals, getActivity, getArguments, getChildFragmentManager, getFragmentManager, getId, getLoaderManager, getParentFragment, getResources, getRetainInstance, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isRemoving, isResumed, isVisible, onActivityResult, onConfigurationChanged, onContextItemSelected, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroyOptionsMenu, onHiddenChanged, onInflate, onInflate, onLowMemory, onOptionsItemSelected, onOptionsMenuClosed, onPrepareOptionsMenu, onSaveInstanceState, onTrimMemory, onViewCreated, onViewStateRestored, registerForContextMenu, setArguments, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setRetainInstance, setTargetFragment, setUserVisibleHint, startActivity, startActivity, startActivityForResult, startActivityForResult, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

appClass

protected java.lang.String appClass

The application class to start

eglBitsPerPixel

protected int eglBitsPerPixel

Sets the desired RGB size for the surfaceview. 16 = RGB565, 24 = RGB888. (default = 24)

eglAlphaBits

protected int eglAlphaBits

Sets the desired number of Alpha bits for the surfaceview. This affects how the surfaceview is able to display Android views that are located under the surfaceview jME uses to render the scenegraph. 0 = Opaque surfaceview background (fastest) 1->7 = Transparent surfaceview background 8 or higher = Translucent surfaceview background (default = 0)

eglDepthBits

protected int eglDepthBits

The number of depth bits specifies the precision of the depth buffer. (default = 16)

eglSamples

protected int eglSamples

Sets the number of samples to use for multisampling.
Leave 0 (default) to disable multisampling.
Set to 2 or 4 to enable multisampling.

eglStencilBits

protected int eglStencilBits

Set the number of stencil bits. (default = 0)

frameRate

protected int frameRate

Set the desired frame rate. If frameRate > 0, the application will be capped at the desired frame rate. (default = -1, no frame rate cap)

maxResolutionDimension

protected int maxResolutionDimension

Set the maximum resolution for the surfaceview in either the width or height screen direction depending on the screen size. If the surfaceview is retangular, the longest side (width or height) will have the resolution set to a maximum of maxResolutionDimension. The other direction will be set to a value that maintains the aspect ratio of the surfaceview.
Any value < 0 (default = -1) will result in the surfaceview having the same resolution as the view layout (ie. no max resolution).

audioRendererType

protected java.lang.String audioRendererType

Sets the type of Audio Renderer to be used.

Android MediaPlayer / SoundPool can be used on all supported Android platform versions (2.2+)
OpenAL Soft uses an OpenSL backend and is only supported on Android versions 2.3+.

Only use ANDROID_ static strings found in AppSettings

joystickEventsEnabled

protected boolean joystickEventsEnabled

If true Android Sensors are used as simulated Joysticks. Users can use the Android sensor feedback through the RawInputListener or by registering JoyAxisTriggers.

keyEventsEnabled

protected boolean keyEventsEnabled

If true KeyEvents are generated from TouchEvents

mouseEventsEnabled

protected boolean mouseEventsEnabled

If true MouseEvents are generated from TouchEvents

mouseEventsInvertX

protected boolean mouseEventsInvertX

Flip X axis

mouseEventsInvertY

protected boolean mouseEventsInvertY

Flip Y axis

finishOnAppStop

protected boolean finishOnAppStop

if true finish this activity when the jme app is stopped

handleExitHook

protected boolean handleExitHook

set to false if you don't want the harness to handle the exit hook

exitDialogTitle

protected java.lang.String exitDialogTitle

Title of the exit dialog, default is "Do you want to exit?"

exitDialogMessage

protected java.lang.String exitDialogMessage

Message of the exit dialog, default is "Use your home key to bring this app into the background or exit to terminate it."

splashPicID

protected int splashPicID

Splash Screen picture Resource ID. If a Splash Screen is desired, set splashPicID to the value of the Resource ID (i.e. R.drawable.picname). If splashPicID = 0, then no splash screen will be displayed.

frameLayout

protected android.widget.FrameLayout frameLayout

view

protected android.opengl.GLSurfaceView view

splashImageView

protected android.widget.ImageView splashImageView

Constructor Detail

AndroidHarnessFragment

public AndroidHarnessFragment()

Method Detail

getJmeApplication

public com.jme3.app.Application getJmeApplication()

onAttach

public void onAttach(android.app.Activity activity)

Overrides:

onAttach in class android.app.Fragment

onCreate

public void onCreate(android.os.Bundle savedInstanceState)

This Fragment uses setRetainInstance(true) so the onCreate method will only be called once. During device configuration changes, the instance of this Fragment will be reused in the new Activity. This method should not contain any View related objects. They are created and destroyed by other methods. View related objects should not be reused, but rather created and destroyed along with the Activity.

Overrides:

onCreate in class android.app.Fragment

Parameters:

savedInstanceState -

onCreateView

public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                      android.view.ViewGroup container,
                                      android.os.Bundle savedInstanceState)

Called by the system to create the View hierchy associated with this Fragment. For jME, this is a FrameLayout that contains the GLSurfaceView and an overlaying SplashScreen Image (if used). The View that is returned will be placed on the screen within the boundries of the View borders defined by the Activity's layout parameters for this Fragment. For jME, we also update the application reference to the new view.

Overrides:

onCreateView in class android.app.Fragment

Parameters:

inflater -

container -

savedInstanceState -

Returns:

onActivityCreated

public void onActivityCreated(android.os.Bundle savedInstanceState)

Overrides:

onActivityCreated in class android.app.Fragment

onStart

public void onStart()

Overrides:

onStart in class android.app.Fragment

onResume

public void onResume()

When the Fragment resumes (ie. after app resumes or device screen turned back on), call the gainFocus() in the jME application.

Overrides:

onResume in class android.app.Fragment

onPause

public void onPause()

When the Fragment pauses (ie. after home button pressed on the device or device screen turned off) , call the loseFocus() in the jME application.

Overrides:

onPause in class android.app.Fragment

onStop

public void onStop()

Overrides:

onStop in class android.app.Fragment

onDestroyView

public void onDestroyView()

Called by the Android system each time the Activity is destroyed or recreated. For jME, we clear references to the GLSurfaceView.

Overrides:

onDestroyView in class android.app.Fragment

onDestroy

public void onDestroy()

Called by the system when the application is being destroyed. In this case, the jME application is actually closed as well. This method is not called during device configuration changes or when the application is put in the background.

Overrides:

onDestroy in class android.app.Fragment

onDetach

public void onDetach()

Overrides:

onDetach in class android.app.Fragment

handleError

public void handleError(java.lang.String errorMsg,
                        java.lang.Throwable t)

Called when an error has occurred. By default, will show an error message to the user and print the exception/error to the log.

Specified by:

handleError in interface com.jme3.system.SystemListener

onClick

public void onClick(android.content.DialogInterface dialog,
                    int whichButton)

Called by the android alert dialog, terminate the activity and OpenGL rendering

Specified by:

onClick in interface android.content.DialogInterface.OnClickListener

Parameters:

dialog -

whichButton -

onTouch

public void onTouch(java.lang.String name,
                    com.jme3.input.event.TouchEvent evt,
                    float tpf)

Gets called by the InputManager on all touch/drag/scale events

Specified by:

onTouch in interface com.jme3.input.controls.TouchListener

createLayout

public void createLayout()

removeSplashScreen

public void removeSplashScreen()

initializeLogHandler

protected void initializeLogHandler()

Removes the standard Android log handler due to an issue with not logging entries lower than INFO level and adds a handler that produces JME formatted log messages.

initialize

public void initialize()

Specified by:

initialize in interface com.jme3.system.SystemListener

reshape

public void reshape(int width,
                    int height)

Specified by:

reshape in interface com.jme3.system.SystemListener

update

public void update()

Specified by:

update in interface com.jme3.system.SystemListener

requestClose

public void requestClose(boolean esc)

Specified by:

requestClose in interface com.jme3.system.SystemListener

destroy

public void destroy()

Specified by:

destroy in interface com.jme3.system.SystemListener

gainFocus

public void gainFocus()

Specified by:

gainFocus in interface com.jme3.system.SystemListener

loseFocus

public void loseFocus()

Specified by:

loseFocus in interface com.jme3.system.SystemListener

onLayoutChange

public void onLayoutChange(android.view.View v,
                           int left,
                           int top,
                           int right,
                           int bottom,
                           int oldLeft,
                           int oldTop,
                           int oldRight,
                           int oldBottom)

Specified by:

onLayoutChange in interface android.view.View.OnLayoutChangeListener