org.andengine.engine

Class Engine

java.lang.Object

org.andengine.engine.Engine

All Implemented Interfaces:

android.hardware.SensorEventListener, android.location.LocationListener, android.view.View.OnTouchListener, ITouchEventCallback

Direct Known Subclasses:

DoubleSceneSplitScreenEngine, FixedStepEngine, LimitedFPSEngine, SingleSceneSplitScreenEngine

public class Engine
extends java.lang.Object
implements android.hardware.SensorEventListener, android.view.View.OnTouchListener, ITouchEventCallback, android.location.LocationListener

(c) 2010 Nicolas Gramlich (c) 2011 Zynga Inc.

Since:

12:21:31 - 08.03.2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Engine.EngineDestroyedException
static class	Engine.EngineLock
static class	Engine.UpdateThread

Field Summary

Fields

Modifier and Type	Field and Description
protected Camera	mCamera
protected Scene	mScene
protected int	mSurfaceHeight
protected int	mSurfaceWidth

Constructor Summary

Constructors

Constructor and Description
Engine(EngineOptions pEngineOptions)

Method Summary

Modifier and Type	Method and Description
void	clearDrawHandlers()
void	clearUpdateHandlers()
protected void	convertSceneToSurfaceTouchEvent(Camera pCamera, TouchEvent pSurfaceTouchEvent)
protected void	convertSurfaceToSceneTouchEvent(Camera pCamera, TouchEvent pSurfaceTouchEvent)
boolean	disableAccelerationSensor(android.content.Context pContext)
void	disableLocationSensor(android.content.Context pContext)
boolean	disableOrientationSensor(android.content.Context pContext)
boolean	enableAccelerationSensor(android.content.Context pContext, IAccelerationListener pAccelerationListener)
boolean	enableAccelerationSensor(android.content.Context pContext, IAccelerationListener pAccelerationListener, AccelerationSensorOptions pAccelerationSensorOptions)
void	enableLocationSensor(android.content.Context pContext, ILocationListener pLocationListener, LocationSensorOptions pLocationSensorOptions)
boolean	enableOrientationSensor(android.content.Context pContext, IOrientationListener pOrientationListener)
boolean	enableOrientationSensor(android.content.Context pContext, IOrientationListener pOrientationListener, OrientationSensorOptions pOrientationSensorOptions)
boolean	enableVibrator(android.content.Context pContext)
AccelerationData	getAccelerationData()
Camera	getCamera()
protected Camera	getCameraFromSurfaceTouchEvent(TouchEvent pTouchEvent)
Engine.EngineLock	getEngineLock() The Engine.EngineLock can be used to ReentrantLock.lock()/ReentrantLock.unlock() on, to ensure the code in between runs mutually exclusive to the Engine.UpdateThread and the GLThread.
EngineOptions	getEngineOptions()
FontManager	getFontManager()
MusicManager	getMusicManager()
OrientationData	getOrientationData()
Scene	getScene()
protected Scene	getSceneFromSurfaceTouchEvent(TouchEvent pTouchEvent)
float	getSecondsElapsedTotal()
ShaderProgramManager	getShaderProgramManager()
SoundManager	getSoundManager()
int	getSurfaceHeight()
int	getSurfaceWidth()
TextureManager	getTextureManager()
ITouchController	getTouchController()
VertexBufferObjectManager	getVertexBufferObjectManager()
boolean	isRunning()
void	onAccuracyChanged(android.hardware.Sensor pSensor, int pAccuracy)
void	onDestroy()
void	onDrawFrame(GLState pGLState)
protected void	onDrawScene(GLState pGLState, Camera pCamera)
void	onLocationChanged(android.location.Location pLocation)
void	onProviderDisabled(java.lang.String pProvider)
void	onProviderEnabled(java.lang.String pProvider)
void	onReloadResources()
void	onSensorChanged(android.hardware.SensorEvent pEvent)
void	onStatusChanged(java.lang.String pProvider, int pStatus, android.os.Bundle pExtras)
boolean	onTouch(android.view.View pView, android.view.MotionEvent pSurfaceMotionEvent)
boolean	onTouchEvent(TouchEvent pSurfaceTouchEvent)
protected boolean	onTouchHUD(Camera pCamera, TouchEvent pSceneTouchEvent)
protected boolean	onTouchScene(Scene pScene, TouchEvent pSceneTouchEvent)
void	onUpdate(long pNanosecondsElapsed)
protected void	onUpdateCameraSurface()
protected void	onUpdateDrawHandlers(GLState pGLState, Camera pCamera)
protected void	onUpdateScene(float pSecondsElapsed)
protected void	onUpdateUpdateHandlers(float pSecondsElapsed)
void	registerDrawHandler(IDrawHandler pDrawHandler)
void	registerUpdateHandler(IUpdateHandler pUpdateHandler)
void	runOnUpdateThread(java.lang.Runnable pRunnable)
void	runOnUpdateThread(java.lang.Runnable pRunnable, boolean pOnlyWhenEngineRunning) This method is useful when you want to execute code on the Engine.UpdateThread, even though the Engine is paused.
void	runSafely(java.lang.Runnable pRunnable)
void	setScene(Scene pScene)
void	setSurfaceSize(int pSurfaceWidth, int pSurfaceHeight)
void	setTouchController(ITouchController pTouchController)
void	start()
void	startUpdateThread()
void	stop()
void	unregisterDrawHandler(IDrawHandler pDrawHandler)
void	unregisterUpdateHandler(IUpdateHandler pUpdateHandler)
void	vibrate(long pMilliseconds)
void	vibrate(long[] pPattern, int pRepeat)

Methods inherited from class java.lang.Object

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

Field Detail

mCamera

protected final Camera mCamera

mScene

protected Scene mScene

mSurfaceWidth

protected int mSurfaceWidth

mSurfaceHeight

protected int mSurfaceHeight

Constructor Detail

Engine

public Engine(EngineOptions pEngineOptions)

Method Detail

startUpdateThread

public void startUpdateThread()
                       throws java.lang.IllegalThreadStateException

Throws:

java.lang.IllegalThreadStateException

isRunning

public boolean isRunning()

start

public void start()

stop

public void stop()

getEngineLock

public Engine.EngineLock getEngineLock()

The Engine.EngineLock can be used to ReentrantLock.lock()/ReentrantLock.unlock() on, to ensure the code in between runs mutually exclusive to the Engine.UpdateThread and the GLThread. When the caller already is on the Engine.UpdateThread or the GL-Thread, that code is executed immediately.

Returns:

the Engine.EngineLock the Engine locks on to ensure mutually exclusivity to the Engine.UpdateThread and the GLThread.

getScene

public Scene getScene()

setScene

public void setScene(Scene pScene)

getEngineOptions

public EngineOptions getEngineOptions()

getCamera

public Camera getCamera()

getSecondsElapsedTotal

public float getSecondsElapsedTotal()

setSurfaceSize

public void setSurfaceSize(int pSurfaceWidth,
                           int pSurfaceHeight)

onUpdateCameraSurface

protected void onUpdateCameraSurface()

getSurfaceWidth

public int getSurfaceWidth()

getSurfaceHeight

public int getSurfaceHeight()

getTouchController

public ITouchController getTouchController()

setTouchController

public void setTouchController(ITouchController pTouchController)

getAccelerationData

public AccelerationData getAccelerationData()

getOrientationData

public OrientationData getOrientationData()

getVertexBufferObjectManager

public VertexBufferObjectManager getVertexBufferObjectManager()

getTextureManager

public TextureManager getTextureManager()

getFontManager

public FontManager getFontManager()

getShaderProgramManager

public ShaderProgramManager getShaderProgramManager()

getSoundManager

public SoundManager getSoundManager()
                             throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

getMusicManager

public MusicManager getMusicManager()
                             throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

registerUpdateHandler

public void registerUpdateHandler(IUpdateHandler pUpdateHandler)

unregisterUpdateHandler

public void unregisterUpdateHandler(IUpdateHandler pUpdateHandler)

clearUpdateHandlers

public void clearUpdateHandlers()

registerDrawHandler

public void registerDrawHandler(IDrawHandler pDrawHandler)

unregisterDrawHandler

public void unregisterDrawHandler(IDrawHandler pDrawHandler)

clearDrawHandlers

public void clearDrawHandlers()

onAccuracyChanged

public void onAccuracyChanged(android.hardware.Sensor pSensor,
                              int pAccuracy)

Specified by:

onAccuracyChanged in interface android.hardware.SensorEventListener

onSensorChanged

public void onSensorChanged(android.hardware.SensorEvent pEvent)

Specified by:

onSensorChanged in interface android.hardware.SensorEventListener

onLocationChanged

public void onLocationChanged(android.location.Location pLocation)

Specified by:

onLocationChanged in interface android.location.LocationListener

onProviderDisabled

public void onProviderDisabled(java.lang.String pProvider)

Specified by:

onProviderDisabled in interface android.location.LocationListener

onProviderEnabled

public void onProviderEnabled(java.lang.String pProvider)

Specified by:

onProviderEnabled in interface android.location.LocationListener

onStatusChanged

public void onStatusChanged(java.lang.String pProvider,
                            int pStatus,
                            android.os.Bundle pExtras)

Specified by:

onStatusChanged in interface android.location.LocationListener

onTouch

public boolean onTouch(android.view.View pView,
                       android.view.MotionEvent pSurfaceMotionEvent)

Specified by:

onTouch in interface android.view.View.OnTouchListener

onTouchEvent

public boolean onTouchEvent(TouchEvent pSurfaceTouchEvent)

Specified by:

onTouchEvent in interface ITouchEventCallback

onTouchHUD

protected boolean onTouchHUD(Camera pCamera,
                             TouchEvent pSceneTouchEvent)

onTouchScene

protected boolean onTouchScene(Scene pScene,
                               TouchEvent pSceneTouchEvent)

runOnUpdateThread

public void runOnUpdateThread(java.lang.Runnable pRunnable)

runOnUpdateThread

public void runOnUpdateThread(java.lang.Runnable pRunnable,
                              boolean pOnlyWhenEngineRunning)

This method is useful when you want to execute code on the Engine.UpdateThread, even though the Engine is paused.

Parameters:

pRunnable - the Runnable to be run on the Engine.UpdateThread.

pOnlyWhenEngineRunning - if true, the execution of the Runnable will be delayed until the next time onUpdateUpdateHandlers(float) is picked up, which is when isRunning() is true. if false, the execution of the Runnable will happen as soon as possible on the Engine.UpdateThread, no matter what isRunning() is.

runSafely

public void runSafely(java.lang.Runnable pRunnable)

Parameters:

pRunnable - the Runnable to run mutually exclusive to the Engine.UpdateThread and the GL-Thread. When the caller already is on the Engine.UpdateThread or the GL-Thread, the Runnable is executed immediately.

See Also:

Engine#getEngineLock()} to manually {@link EngineLock#lock()}/{@link EngineLock#unlock()} on, while avoiding creating a {@link Runnable}.

onDestroy

public void onDestroy()

onReloadResources

public void onReloadResources()

getCameraFromSurfaceTouchEvent

protected Camera getCameraFromSurfaceTouchEvent(TouchEvent pTouchEvent)

getSceneFromSurfaceTouchEvent

protected Scene getSceneFromSurfaceTouchEvent(TouchEvent pTouchEvent)

convertSurfaceToSceneTouchEvent

protected void convertSurfaceToSceneTouchEvent(Camera pCamera,
                                               TouchEvent pSurfaceTouchEvent)

convertSceneToSurfaceTouchEvent

protected void convertSceneToSurfaceTouchEvent(Camera pCamera,
                                               TouchEvent pSurfaceTouchEvent)

onUpdate

public void onUpdate(long pNanosecondsElapsed)
              throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

onUpdateScene

protected void onUpdateScene(float pSecondsElapsed)

onUpdateUpdateHandlers

protected void onUpdateUpdateHandlers(float pSecondsElapsed)

onUpdateDrawHandlers

protected void onUpdateDrawHandlers(GLState pGLState,
                                    Camera pCamera)

onDrawFrame

public void onDrawFrame(GLState pGLState)
                 throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

onDrawScene

protected void onDrawScene(GLState pGLState,
                           Camera pCamera)

enableVibrator

public boolean enableVibrator(android.content.Context pContext)

vibrate

public void vibrate(long pMilliseconds)
             throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

vibrate

public void vibrate(long[] pPattern,
                    int pRepeat)
             throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

enableLocationSensor

public void enableLocationSensor(android.content.Context pContext,
                                 ILocationListener pLocationListener,
                                 LocationSensorOptions pLocationSensorOptions)

disableLocationSensor

public void disableLocationSensor(android.content.Context pContext)

enableAccelerationSensor

public boolean enableAccelerationSensor(android.content.Context pContext,
                                        IAccelerationListener pAccelerationListener)

See Also:

Engine#enableAccelerationSensor(Context, IAccelerationListener, AccelerationSensorOptions)}

enableAccelerationSensor

public boolean enableAccelerationSensor(android.content.Context pContext,
                                        IAccelerationListener pAccelerationListener,
                                        AccelerationSensorOptions pAccelerationSensorOptions)

Returns:

true when the sensor was successfully enabled, false otherwise.

disableAccelerationSensor

public boolean disableAccelerationSensor(android.content.Context pContext)

Returns:

true when the sensor was successfully disabled, false otherwise.

enableOrientationSensor

public boolean enableOrientationSensor(android.content.Context pContext,
                                       IOrientationListener pOrientationListener)

See Also:

Engine#enableOrientationSensor(Context, IOrientationListener, OrientationSensorOptions)}

enableOrientationSensor

public boolean enableOrientationSensor(android.content.Context pContext,
                                       IOrientationListener pOrientationListener,
                                       OrientationSensorOptions pOrientationSensorOptions)

Returns:

true when the sensor was successfully enabled, false otherwise.

disableOrientationSensor

public boolean disableOrientationSensor(android.content.Context pContext)

Returns:

true when the sensor was successfully disabled, false otherwise.