org.andengine.entity.scene.menu

Class MenuScene

java.lang.Object

org.andengine.entity.Entity

org.andengine.entity.scene.Scene

org.andengine.entity.scene.CameraScene

org.andengine.entity.scene.menu.MenuScene

All Implemented Interfaces:

IDrawHandler, IUpdateHandler, IEntity, IOnAreaTouchListener, IOnSceneTouchListener, IDisposable

public class MenuScene
extends CameraScene
implements IOnAreaTouchListener, IOnSceneTouchListener

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

Since:

20:06:51 - 01.04.2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MenuScene.IOnMenuItemClickListener

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 java.util.ArrayList<IMenuItem>	mMenuItems

Fields inherited from class org.andengine.entity.scene.CameraScene

mCamera

Fields inherited from class org.andengine.entity.scene.Scene

mChildScene, mParentScene, 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
MenuScene()
MenuScene(Camera pCamera)
MenuScene(Camera pCamera, MenuScene.IOnMenuItemClickListener pOnMenuItemClickListener)
MenuScene(MenuScene.IOnMenuItemClickListener pOnMenuItemClickListener)

Method Summary

Modifier and Type	Method and Description
void	addMenuItem(IMenuItem pMenuItem)
void	back()
void	buildAnimations()
void	clearChildScene()
void	clearMenuItems()
void	closeMenuScene()
MenuScene	getChildScene()
int	getMenuItemCount()
MenuScene.IOnMenuItemClickListener	getOnMenuItemClickListener()
boolean	onAreaTouched(TouchEvent pSceneTouchEvent, ITouchArea pTouchArea, float pTouchAreaLocalX, float pTouchAreaLocalY) Called when a TouchEvent is dispatched to an ITouchArea.
boolean	onSceneTouchEvent(Scene pScene, TouchEvent pSceneTouchEvent) Called when a TouchEvent is dispatched to a Scene.
void	prepareAnimations()
void	reset()
void	setChildScene(Scene pChildScene, boolean pModalDraw, boolean pModalUpdate, boolean pModalTouch)
void	setMenuAnimator(IMenuAnimator pMenuAnimator)
void	setOnMenuItemClickListener(MenuScene.IOnMenuItemClickListener pOnMenuItemClickListener)

Methods inherited from class org.andengine.entity.scene.CameraScene

centerShapeInCamera, centerShapeInCameraHorizontally, centerShapeInCameraVertically, getCamera, onApplyMatrix, onChildSceneTouchEvent, onSceneTouchEvent, setCamera

Methods inherited from class org.andengine.entity.scene.Scene

clearTouchAreas, getBackground, getOnAreaTouchListener, getOnSceneTouchListener, getSecondsElapsedTotal, getTouchAreas, hasChildScene, hasOnAreaTouchListener, hasOnSceneTouchListener, isBackgroundEnabled, isOnSceneTouchListenerBindingOnActionDownEnabled, isTouchAreaBindingOnActionDownEnabled, isTouchAreaBindingOnActionMoveEnabled, onManagedDraw, onManagedUpdate, postRunnable, registerTouchArea, setBackground, setBackgroundEnabled, setChildScene, setChildSceneModal, setOnAreaTouchListener, setOnAreaTouchTraversalBackToFront, setOnAreaTouchTraversalFrontToBack, setOnSceneTouchListener, setOnSceneTouchListenerBindingOnActionDownEnabled, setParent, setTouchAreaBindingOnActionDownEnabled, setTouchAreaBindingOnActionMoveEnabled, unregisterTouchArea, unregisterTouchAreas

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

mMenuItems

protected final java.util.ArrayList<IMenuItem> mMenuItems

Constructor Detail

MenuScene

public MenuScene()

MenuScene

public MenuScene(MenuScene.IOnMenuItemClickListener pOnMenuItemClickListener)

MenuScene

public MenuScene(Camera pCamera)

MenuScene

public MenuScene(Camera pCamera,
                 MenuScene.IOnMenuItemClickListener pOnMenuItemClickListener)

Method Detail

getOnMenuItemClickListener

public MenuScene.IOnMenuItemClickListener getOnMenuItemClickListener()

setOnMenuItemClickListener

public void setOnMenuItemClickListener(MenuScene.IOnMenuItemClickListener pOnMenuItemClickListener)

getMenuItemCount

public int getMenuItemCount()

addMenuItem

public void addMenuItem(IMenuItem pMenuItem)

clearMenuItems

public void clearMenuItems()

getChildScene

public MenuScene getChildScene()

Overrides:

getChildScene in class Scene

setChildScene

public void setChildScene(Scene pChildScene,
                          boolean pModalDraw,
                          boolean pModalUpdate,
                          boolean pModalTouch)
                   throws java.lang.IllegalArgumentException

Overrides:

setChildScene in class Scene

Throws:

java.lang.IllegalArgumentException

clearChildScene

public void clearChildScene()

Overrides:

clearChildScene in class Scene

setMenuAnimator

public void setMenuAnimator(IMenuAnimator pMenuAnimator)

onAreaTouched

public boolean onAreaTouched(TouchEvent pSceneTouchEvent,
                             ITouchArea pTouchArea,
                             float pTouchAreaLocalX,
                             float pTouchAreaLocalY)

Description copied from interface: IOnAreaTouchListener

Called when a TouchEvent is dispatched to an ITouchArea. This allows listeners to get a chance to respond before the target ITouchArea.onAreaTouched(TouchEvent, float, float) is called.

Specified by:

onAreaTouched in interface IOnAreaTouchListener

Parameters:

pSceneTouchEvent - The TouchEvent object containing full information about the event.

pTouchArea - The ITouchArea that the TouchEvent has been dispatched to.

pTouchAreaLocalX - the x coordinate within the area touched.

pTouchAreaLocalY - the y coordinate within the area touched.

Returns:

true if this IOnAreaTouchListener has consumed the TouchEvent, false otherwise.

onSceneTouchEvent

public boolean onSceneTouchEvent(Scene pScene,
                                 TouchEvent pSceneTouchEvent)

Description copied from interface: IOnSceneTouchListener

Called when a TouchEvent is dispatched to a Scene.

Specified by:

onSceneTouchEvent in interface IOnSceneTouchListener

Parameters:

pScene - The Scene that the TouchEvent has been dispatched to.

pSceneTouchEvent - The TouchEvent object containing full information about the event.

Returns:

true if this IOnSceneTouchListener has consumed the TouchEvent, false otherwise.

back

public void back()

Overrides:

back in class Scene

reset

public void reset()

Specified by:

reset in interface IUpdateHandler

Overrides:

reset in class Scene

closeMenuScene

public void closeMenuScene()

buildAnimations

public void buildAnimations()

prepareAnimations

public void prepareAnimations()