public class

ButtonSprite

extends TiledSprite
java.lang.Object
   ↳ org.andengine.entity.Entity
     ↳ org.andengine.entity.shape.Shape
       ↳ org.andengine.entity.shape.RectangularShape
         ↳ org.andengine.entity.sprite.Sprite
           ↳ org.andengine.entity.sprite.TiledSprite
             ↳ org.andengine.entity.sprite.ButtonSprite

Class Overview

Note: ButtonSprite needs to be registered as a Scene.ITouchArea to the Scene via registerTouchArea(ITouchArea), otherwise it won't be clickable. To make ButtonSprite function properly, you should consider setting setTouchAreaBindingOnActionDownEnabled(boolean) to true. (c) Zynga 2012

Summary

Nested Classes
interface ButtonSprite.OnClickListener  
enum ButtonSprite.State  
[Expand]
Inherited Constants
From class org.andengine.entity.sprite.TiledSprite
From class org.andengine.entity.sprite.Sprite
From interface org.andengine.entity.shape.IShape
[Expand]
Inherited Fields
From class org.andengine.entity.sprite.Sprite
From class org.andengine.entity.shape.RectangularShape
From class org.andengine.entity.shape.Shape
From class org.andengine.entity.Entity
Public Constructors
ButtonSprite(float pX, float pY, ITextureRegion pNormalTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager)
ButtonSprite(float pX, float pY, ITextureRegion pNormalTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, ButtonSprite.OnClickListener pOnClickListener)
ButtonSprite(float pX, float pY, ITextureRegion pNormalTextureRegion, ITextureRegion pPressedTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager)
ButtonSprite(float pX, float pY, ITextureRegion pNormalTextureRegion, ITextureRegion pPressedTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, ButtonSprite.OnClickListener pOnClickListener)
ButtonSprite(float pX, float pY, ITextureRegion pNormalTextureRegion, ITextureRegion pPressedTextureRegion, ITextureRegion pDisabledTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager)
ButtonSprite(float pX, float pY, ITextureRegion pNormalTextureRegion, ITextureRegion pPressedTextureRegion, ITextureRegion pDisabledTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, ButtonSprite.OnClickListener pOnClickListener)
ButtonSprite(float pX, float pY, ITiledTextureRegion pTiledTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager)
ButtonSprite(float pX, float pY, ITiledTextureRegion pTiledTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, ButtonSprite.OnClickListener pOnClickListener)
Public Methods
boolean contains(float pX, float pY)
ButtonSprite.State getState()
boolean isEnabled()
boolean isPressed()
boolean onAreaTouched(TouchEvent pSceneTouchEvent, float pTouchAreaLocalX, float pTouchAreaLocalY)
This method only fires if this Scene.ITouchArea is registered to the Scene via registerTouchArea(ITouchArea).
void setEnabled(boolean pEnabled)
void setOnClickListener(ButtonSprite.OnClickListener pOnClickListener)
[Expand]
Inherited Methods
From class org.andengine.entity.sprite.TiledSprite
From class org.andengine.entity.sprite.Sprite
From class org.andengine.entity.shape.RectangularShape
From class org.andengine.entity.shape.Shape
From class org.andengine.entity.Entity
From class java.lang.Object
From interface org.andengine.engine.handler.IDrawHandler
From interface org.andengine.engine.handler.IUpdateHandler
From interface org.andengine.entity.IEntity
From interface org.andengine.entity.scene.Scene.ITouchArea
From interface org.andengine.entity.shape.IAreaShape
From interface org.andengine.entity.shape.IShape
From interface org.andengine.util.IDisposable

Public Constructors

public ButtonSprite (float pX, float pY, ITextureRegion pNormalTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager)

public ButtonSprite (float pX, float pY, ITextureRegion pNormalTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, ButtonSprite.OnClickListener pOnClickListener)

public ButtonSprite (float pX, float pY, ITextureRegion pNormalTextureRegion, ITextureRegion pPressedTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager)

public ButtonSprite (float pX, float pY, ITextureRegion pNormalTextureRegion, ITextureRegion pPressedTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, ButtonSprite.OnClickListener pOnClickListener)

public ButtonSprite (float pX, float pY, ITextureRegion pNormalTextureRegion, ITextureRegion pPressedTextureRegion, ITextureRegion pDisabledTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager)

public ButtonSprite (float pX, float pY, ITextureRegion pNormalTextureRegion, ITextureRegion pPressedTextureRegion, ITextureRegion pDisabledTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, ButtonSprite.OnClickListener pOnClickListener)

public ButtonSprite (float pX, float pY, ITiledTextureRegion pTiledTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager)

public ButtonSprite (float pX, float pY, ITiledTextureRegion pTiledTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, ButtonSprite.OnClickListener pOnClickListener)

Public Methods

public boolean contains (float pX, float pY)

public ButtonSprite.State getState ()

public boolean isEnabled ()

public boolean isPressed ()

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

This method only fires if this Scene.ITouchArea is registered to the Scene via registerTouchArea(ITouchArea).

Returns

public void setEnabled (boolean pEnabled)

public void setOnClickListener (ButtonSprite.OnClickListener pOnClickListener)