org.andengine.entity.scene

Class Scene

java.lang.Object

org.andengine.entity.Entity

org.andengine.entity.scene.Scene

All Implemented Interfaces:

IDrawHandler, IUpdateHandler, IEntity, IDisposable

Direct Known Subclasses:

CameraScene

public class Scene
extends Entity

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

Since:

12:47:39 - 08.03.2010

Nested Class Summary

Nested classes/interfaces inherited from interface org.andengine.engine.handler.IUpdateHandler

IUpdateHandler.IUpdateHandlerMatcher

Nested classes/interfaces inherited from interface org.andengine.util.IDisposable

IDisposable.AlreadyDisposedException

Field Summary

Fields

Modifier and Type	Field and Description
protected Scene	mChildScene
protected Scene	mParentScene
protected SmartList<ITouchArea>	mTouchAreas

Fields inherited from class org.andengine.entity.Entity

mChildren, mChildrenIgnoreUpdate, mChildrenSortPending, mChildrenVisible, mColor, mCullingEnabled, mDisposed, mIgnoreUpdate, mRotation, mRotationCenterX, mRotationCenterY, mScaleCenterX, mScaleCenterY, mScaleX, mScaleY, mSkewCenterX, mSkewCenterY, mSkewX, mSkewY, mTag, mVisible, mX, mY, mZIndex

Fields inherited from interface org.andengine.entity.IEntity

TAG_INVALID

Constructor Summary

Constructors

Constructor and Description
Scene()
Scene(int pChildCount) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	back()
void	clearChildScene()
void	clearTouchAreas()
IBackground	getBackground()
Scene	getChildScene()
IOnAreaTouchListener	getOnAreaTouchListener()
IOnSceneTouchListener	getOnSceneTouchListener()
float	getSecondsElapsedTotal()
SmartList<ITouchArea>	getTouchAreas()
boolean	hasChildScene()
boolean	hasOnAreaTouchListener()
boolean	hasOnSceneTouchListener()
boolean	isBackgroundEnabled()
boolean	isOnSceneTouchListenerBindingOnActionDownEnabled()
boolean	isTouchAreaBindingOnActionDownEnabled()
boolean	isTouchAreaBindingOnActionMoveEnabled()
protected void	onApplyMatrix(GLState pGLState, Camera pCamera)
protected boolean	onChildSceneTouchEvent(TouchEvent pSceneTouchEvent)
protected void	onManagedDraw(GLState pGLState, Camera pCamera)
protected void	onManagedUpdate(float pSecondsElapsed)
boolean	onSceneTouchEvent(TouchEvent pSceneTouchEvent)
void	postRunnable(java.lang.Runnable pRunnable)
void	registerTouchArea(ITouchArea pTouchArea)
void	reset()
void	setBackground(IBackground pBackground)
void	setBackgroundEnabled(boolean pEnabled)
void	setChildScene(Scene pChildScene)
void	setChildScene(Scene pChildScene, boolean pModalDraw, boolean pModalUpdate, boolean pModalTouch)
void	setChildSceneModal(Scene pChildScene)
void	setOnAreaTouchListener(IOnAreaTouchListener pOnAreaTouchListener)
void	setOnAreaTouchTraversalBackToFront()
void	setOnAreaTouchTraversalFrontToBack()
void	setOnSceneTouchListener(IOnSceneTouchListener pOnSceneTouchListener)
void	setOnSceneTouchListenerBindingOnActionDownEnabled(boolean pOnSceneTouchListenerBindingOnActionDownEnabled) Enable or disable the binding of TouchAreas to PointerIDs (fingers).
void	setParent(IEntity pEntity)
void	setTouchAreaBindingOnActionDownEnabled(boolean pTouchAreaBindingOnActionDownEnabled) Enable or disable the binding of TouchAreas to PointerIDs (fingers).
void	setTouchAreaBindingOnActionMoveEnabled(boolean pTouchAreaBindingOnActionMoveEnabled) Enable or disable the binding of TouchAreas to PointerIDs (fingers).
boolean	unregisterTouchArea(ITouchArea pTouchArea)
boolean	unregisterTouchAreas(ITouchArea.ITouchAreaMatcher pTouchAreaMatcher)

Methods inherited from class org.andengine.entity.Entity

applyRotation, applyScale, applySkew, applyTranslation, attachChild, callOnChildren, callOnChildren, clearEntityModifiers, clearUpdateHandlers, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, detachChild, detachChild, detachChild, detachChildren, detachChildren, detachSelf, dispose, draw, finalize, getAlpha, getBlue, getChildByIndex, getChildByMatcher, getChildByTag, getChildCount, getColor, getEntityModifierCount, getFirstChild, getGreen, getLastChild, getLocalToParentTransformation, getLocalToSceneTransformation, getParent, getParentToLocalTransformation, getRed, getRotation, getRotationCenterX, getRotationCenterY, getScaleCenterX, getScaleCenterY, getScaleX, getScaleY, getSceneCenterCoordinates, getSceneCenterCoordinates, getSceneToLocalTransformation, getSkewCenterX, getSkewCenterY, getSkewX, getSkewY, getTag, getUpdateHandlerCount, getUserData, getX, getY, getZIndex, hasParent, isChildrenIgnoreUpdate, isChildrenVisible, isCulled, isCullingEnabled, isDisposed, isIgnoreUpdate, isRotated, isRotatedOrScaledOrSkewed, isScaled, isSkewed, isVisible, onApplyTransformations, onAttached, onDetached, onDraw, onUpdate, onUpdateColor, postDraw, preDraw, query, query, queryFirst, queryFirstForSubclass, queryForSubclass, queryForSubclass, registerEntityModifier, registerUpdateHandler, setAlpha, setBlue, setChildrenIgnoreUpdate, setChildrenVisible, setColor, setColor, setColor, setCullingEnabled, setGreen, setIgnoreUpdate, setPosition, setPosition, setRed, setRotation, setRotationCenter, setRotationCenterX, setRotationCenterY, setScale, setScale, setScaleCenter, setScaleCenterX, setScaleCenterY, setScaleX, setScaleY, setSkew, setSkew, setSkewCenter, setSkewCenterX, setSkewCenterY, setSkewX, setSkewY, setTag, setUserData, setVisible, setX, setY, setZIndex, sortChildren, sortChildren, sortChildren, toString, toString, unregisterEntityModifier, unregisterEntityModifiers, unregisterUpdateHandler, unregisterUpdateHandlers

Methods inherited from class java.lang.Object

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

Field Detail

mParentScene

protected Scene mParentScene

mChildScene

protected Scene mChildScene

mTouchAreas

protected SmartList<ITouchArea> mTouchAreas

Constructor Detail

Scene

public Scene()

Scene

@Deprecated
public Scene(int pChildCount)

Deprecated.

Method Detail

getSecondsElapsedTotal

public float getSecondsElapsedTotal()

getBackground

public IBackground getBackground()

setBackground

public void setBackground(IBackground pBackground)

isBackgroundEnabled

public boolean isBackgroundEnabled()

setBackgroundEnabled

public void setBackgroundEnabled(boolean pEnabled)

setOnSceneTouchListener

public void setOnSceneTouchListener(IOnSceneTouchListener pOnSceneTouchListener)

getOnSceneTouchListener

public IOnSceneTouchListener getOnSceneTouchListener()

hasOnSceneTouchListener

public boolean hasOnSceneTouchListener()

setOnAreaTouchListener

public void setOnAreaTouchListener(IOnAreaTouchListener pOnAreaTouchListener)

getOnAreaTouchListener

public IOnAreaTouchListener getOnAreaTouchListener()

hasOnAreaTouchListener

public boolean hasOnAreaTouchListener()

hasChildScene

public boolean hasChildScene()

getChildScene

public Scene getChildScene()

setChildSceneModal

public void setChildSceneModal(Scene pChildScene)

setChildScene

public void setChildScene(Scene pChildScene)

setChildScene

public void setChildScene(Scene pChildScene,
                          boolean pModalDraw,
                          boolean pModalUpdate,
                          boolean pModalTouch)

clearChildScene

public void clearChildScene()

setOnAreaTouchTraversalBackToFront

public void setOnAreaTouchTraversalBackToFront()

setOnAreaTouchTraversalFrontToBack

public void setOnAreaTouchTraversalFrontToBack()

isTouchAreaBindingOnActionDownEnabled

public boolean isTouchAreaBindingOnActionDownEnabled()

isTouchAreaBindingOnActionMoveEnabled

public boolean isTouchAreaBindingOnActionMoveEnabled()

setTouchAreaBindingOnActionDownEnabled

public void setTouchAreaBindingOnActionDownEnabled(boolean pTouchAreaBindingOnActionDownEnabled)

Enable or disable the binding of TouchAreas to PointerIDs (fingers). When enabled: TouchAreas get bound to a PointerID (finger) when returning true in ITouchArea.onAreaTouched(TouchEvent, float, float) or IOnAreaTouchListener.onAreaTouched(TouchEvent, ITouchArea, float, float) with TouchEvent.ACTION_DOWN, they will receive all subsequent TouchEvents that are made with the same PointerID (finger) even if the TouchEvent is outside of the actual ITouchArea!

Parameters:

pTouchAreaBindingOnActionDownEnabled -

setTouchAreaBindingOnActionMoveEnabled

public void setTouchAreaBindingOnActionMoveEnabled(boolean pTouchAreaBindingOnActionMoveEnabled)

Enable or disable the binding of TouchAreas to PointerIDs (fingers). When enabled: TouchAreas get bound to a PointerID (finger) when returning true in ITouchArea.onAreaTouched(TouchEvent, float, float) or IOnAreaTouchListener.onAreaTouched(TouchEvent, ITouchArea, float, float) with TouchEvent.ACTION_MOVE, they will receive all subsequent TouchEvents that are made with the same PointerID (finger) even if the TouchEvent is outside of the actual ITouchArea!

Parameters:

pTouchAreaBindingOnActionMoveEnabled -

isOnSceneTouchListenerBindingOnActionDownEnabled

public boolean isOnSceneTouchListenerBindingOnActionDownEnabled()

setOnSceneTouchListenerBindingOnActionDownEnabled

public void setOnSceneTouchListenerBindingOnActionDownEnabled(boolean pOnSceneTouchListenerBindingOnActionDownEnabled)

Enable or disable the binding of TouchAreas to PointerIDs (fingers). When enabled: The OnSceneTouchListener gets bound to a PointerID (finger) when returning true in Shape.onAreaTouched(TouchEvent, float, float) or IOnAreaTouchListener.onAreaTouched(TouchEvent, ITouchArea, float, float) with TouchEvent.ACTION_DOWN, it will receive all subsequent TouchEvents that are made with the same PointerID (finger) even if the TouchEvent is would belong to an overlaying ITouchArea!

Parameters:

pOnSceneTouchListenerBindingOnActionDownEnabled -

onManagedDraw

protected void onManagedDraw(GLState pGLState,
                             Camera pCamera)

Overrides:

onManagedDraw in class Entity

onApplyMatrix

protected void onApplyMatrix(GLState pGLState,
                             Camera pCamera)

onManagedUpdate

protected void onManagedUpdate(float pSecondsElapsed)

Overrides:

onManagedUpdate in class Entity

onSceneTouchEvent

public boolean onSceneTouchEvent(TouchEvent pSceneTouchEvent)

onChildSceneTouchEvent

protected boolean onChildSceneTouchEvent(TouchEvent pSceneTouchEvent)

reset

public void reset()

Specified by:

reset in interface IUpdateHandler

Overrides:

reset in class Entity

setParent

public void setParent(IEntity pEntity)

Specified by:

setParent in interface IEntity

Overrides:

setParent in class Entity

postRunnable

public void postRunnable(java.lang.Runnable pRunnable)

registerTouchArea

public void registerTouchArea(ITouchArea pTouchArea)

unregisterTouchArea

public boolean unregisterTouchArea(ITouchArea pTouchArea)

unregisterTouchAreas

public boolean unregisterTouchAreas(ITouchArea.ITouchAreaMatcher pTouchAreaMatcher)

clearTouchAreas

public void clearTouchAreas()

getTouchAreas

public SmartList<ITouchArea> getTouchAreas()

back

public void back()