public abstract class

BaseOnScreenControl

extends HUD
implements Scene.IOnSceneTouchListener
java.lang.Object
   ↳ org.anddev.andengine.entity.Entity
     ↳ org.anddev.andengine.entity.scene.Scene
       ↳ org.anddev.andengine.entity.scene.CameraScene
         ↳ org.anddev.andengine.engine.camera.hud.HUD
           ↳ org.anddev.andengine.engine.camera.hud.controls.BaseOnScreenControl
Known Direct Subclasses

Class Overview

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

Summary

Nested Classes
interface BaseOnScreenControl.IOnScreenControlListener  
[Expand]
Inherited Fields
From class org.anddev.andengine.entity.scene.CameraScene
From class org.anddev.andengine.entity.scene.Scene
From class org.anddev.andengine.entity.Entity
Public Constructors
BaseOnScreenControl(float pX, float pY, Camera pCamera, TextureRegion pControlBaseTextureRegion, TextureRegion pControlKnobTextureRegion, float pTimeBetweenUpdates, BaseOnScreenControl.IOnScreenControlListener pOnScreenControlListener)
Public Methods
Sprite getControlBase()
Sprite getControlKnob()
BaseOnScreenControl.IOnScreenControlListener getOnScreenControlListener()
boolean onSceneTouchEvent(Scene pScene, TouchEvent pSceneTouchEvent)
Called when a TouchEvent is dispatched to a Scene.
void refreshControlKnobPosition()
Protected Methods
void onHandleControlBaseLeft()
When the touch happened outside of the bounds of this OnScreenControl.
boolean onHandleControlBaseTouched(TouchEvent pSceneTouchEvent, float pTouchAreaLocalX, float pTouchAreaLocalY)
void onHandleControlKnobReleased()
When the OnScreenControl was released.
void onUpdateControlKnob(float pRelativeX, float pRelativeY)
[Expand]
Inherited Methods
From class org.anddev.andengine.entity.scene.CameraScene
From class org.anddev.andengine.entity.scene.Scene
From class org.anddev.andengine.entity.Entity
From class java.lang.Object
From interface org.anddev.andengine.engine.handler.IUpdateHandler
From interface org.anddev.andengine.entity.IEntity
From interface org.anddev.andengine.entity.scene.Scene.IOnSceneTouchListener
From interface org.anddev.andengine.opengl.IDrawable

Public Constructors

public BaseOnScreenControl (float pX, float pY, Camera pCamera, TextureRegion pControlBaseTextureRegion, TextureRegion pControlKnobTextureRegion, float pTimeBetweenUpdates, BaseOnScreenControl.IOnScreenControlListener pOnScreenControlListener)

Public Methods

public Sprite getControlBase ()

public Sprite getControlKnob ()

public BaseOnScreenControl.IOnScreenControlListener getOnScreenControlListener ()

public boolean onSceneTouchEvent (Scene pScene, TouchEvent pSceneTouchEvent)

Called when a TouchEvent is dispatched to a Scene.

Parameters
pScene The Scene that the TouchEvent has been dispatched to.
pSceneTouchEvent The TouchEvent object containing full information about the event.
Returns

public void refreshControlKnobPosition ()

Protected Methods

protected void onHandleControlBaseLeft ()

When the touch happened outside of the bounds of this OnScreenControl.

protected boolean onHandleControlBaseTouched (TouchEvent pSceneTouchEvent, float pTouchAreaLocalX, float pTouchAreaLocalY)

protected void onHandleControlKnobReleased ()

When the OnScreenControl was released.

protected void onUpdateControlKnob (float pRelativeX, float pRelativeY)

Parameters
pRelativeX from -0.5 (left) to 0.5 (right).
pRelativeY from -0.5 (top) to 0.5 (bottom).