org.andengine.entity.sprite

Class Sprite

java.lang.Object

org.andengine.entity.Entity

org.andengine.entity.shape.Shape

org.andengine.entity.shape.RectangularShape

org.andengine.entity.sprite.Sprite

All Implemented Interfaces:

IDrawHandler, IUpdateHandler, IEntity, ITouchArea, IAreaShape, IShape, IDisposable

Direct Known Subclasses:

DiamondSprite, SpriteMenuItem, TiledSprite, UncoloredSprite, UniformColorSprite

public class Sprite
extends RectangularShape

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

Since:

19:22:38 - 09.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

Nested classes/interfaces inherited from interface org.andengine.entity.scene.ITouchArea

ITouchArea.ITouchAreaMatcher

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLOR_INDEX
protected boolean	mFlippedHorizontal
protected boolean	mFlippedVertical
protected ISpriteVertexBufferObject	mSpriteVertexBufferObject
protected ITextureRegion	mTextureRegion
static int	SPRITE_SIZE
static int	TEXTURECOORDINATES_INDEX_U
static int	TEXTURECOORDINATES_INDEX_V
static int	VERTEX_INDEX_X
static int	VERTEX_INDEX_Y
static int	VERTEX_SIZE
static VertexBufferObjectAttributes	VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT
static int	VERTICES_PER_SPRITE

Fields inherited from class org.andengine.entity.shape.RectangularShape

mHeight, mWidth

Fields inherited from class org.andengine.entity.shape.Shape

mBlendFunctionDestination, mBlendFunctionSource, mBlendingEnabled, mShaderProgram

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.shape.IShape

BLENDFUNCTION_DESTINATION_DEFAULT, BLENDFUNCTION_DESTINATION_PREMULTIPLYALPHA_DEFAULT, BLENDFUNCTION_SOURCE_DEFAULT, BLENDFUNCTION_SOURCE_PREMULTIPLYALPHA_DEFAULT

Fields inherited from interface org.andengine.entity.IEntity

TAG_INVALID

Constructor Summary

Constructors

Constructor and Description
Sprite(float pX, float pY, float pWidth, float pHeight, ITextureRegion pTextureRegion, ISpriteVertexBufferObject pSpriteVertexBufferObject)
Sprite(float pX, float pY, float pWidth, float pHeight, ITextureRegion pTextureRegion, ISpriteVertexBufferObject pSpriteVertexBufferObject, ShaderProgram pShaderProgram)
Sprite(float pX, float pY, float pWidth, float pHeight, ITextureRegion pTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager)
Sprite(float pX, float pY, float pWidth, float pHeight, ITextureRegion pTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType)
Sprite(float pX, float pY, float pWidth, float pHeight, ITextureRegion pTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType, ShaderProgram pShaderProgram)
Sprite(float pX, float pY, float pWidth, float pHeight, ITextureRegion pTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, ShaderProgram pShaderProgram)
Sprite(float pX, float pY, ITextureRegion pTextureRegion, ISpriteVertexBufferObject pVertexBufferObject)
Sprite(float pX, float pY, ITextureRegion pTextureRegion, ISpriteVertexBufferObject pVertexBufferObject, ShaderProgram pShaderProgram)
Sprite(float pX, float pY, ITextureRegion pTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager)
Sprite(float pX, float pY, ITextureRegion pTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType)
Sprite(float pX, float pY, ITextureRegion pTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType, ShaderProgram pShaderProgram)
Sprite(float pX, float pY, ITextureRegion pTextureRegion, VertexBufferObjectManager pVertexBufferObjectManager, ShaderProgram pShaderProgram)

Method Summary

Modifier and Type	Method and Description
protected void	draw(GLState pGLState, Camera pCamera)
ITextureRegion	getTextureRegion()
ISpriteVertexBufferObject	getVertexBufferObject()
boolean	isFlippedHorizontal()
boolean	isFlippedVertical()
protected void	onUpdateColor()
protected void	onUpdateTextureCoordinates()
protected void	onUpdateVertices()
protected void	postDraw(GLState pGLState, Camera pCamera)
protected void	preDraw(GLState pGLState, Camera pCamera)
void	reset()
void	setFlipped(boolean pFlippedHorizontal, boolean pFlippedVertical)
void	setFlippedHorizontal(boolean pFlippedHorizontal)
void	setFlippedVertical(boolean pFlippedVertical)

Methods inherited from class org.andengine.entity.shape.RectangularShape

collidesWith, contains, getHeight, getHeightScaled, getSceneCenterCoordinates, getSceneCenterCoordinates, getWidth, getWidthScaled, isCulled, resetRotationCenter, resetScaleCenter, resetSkewCenter, setHeight, setSize, setWidth

Methods inherited from class org.andengine.entity.shape.Shape

dispose, getBlendFunctionDestination, getBlendFunctionSource, getShaderProgram, getVertexBufferObjectManager, initBlendFunction, initBlendFunction, initBlendFunction, isBlendingEnabled, onAreaTouched, setBlendFunction, setBlendFunctionDestination, setBlendFunctionSource, setBlendingEnabled, setShaderProgram

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, finalize, getAlpha, getBlue, getChildByIndex, getChildByMatcher, getChildByTag, getChildCount, getColor, getEntityModifierCount, getFirstChild, getGreen, getLastChild, getLocalToParentTransformation, getLocalToSceneTransformation, getParent, getParentToLocalTransformation, getRed, getRotation, getRotationCenterX, getRotationCenterY, getScaleCenterX, getScaleCenterY, getScaleX, getScaleY, getSceneToLocalTransformation, getSkewCenterX, getSkewCenterY, getSkewX, getSkewY, getTag, getUpdateHandlerCount, getUserData, getX, getY, getZIndex, hasParent, isChildrenIgnoreUpdate, isChildrenVisible, isCullingEnabled, isDisposed, isIgnoreUpdate, isRotated, isRotatedOrScaledOrSkewed, isScaled, isSkewed, isVisible, onApplyTransformations, onAttached, onDetached, onDraw, onManagedDraw, onManagedUpdate, onUpdate, query, query, queryFirst, queryFirstForSubclass, queryForSubclass, queryForSubclass, registerEntityModifier, registerUpdateHandler, setAlpha, setBlue, setChildrenIgnoreUpdate, setChildrenVisible, setColor, setColor, setColor, setCullingEnabled, setGreen, setIgnoreUpdate, setParent, 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

Methods inherited from interface org.andengine.entity.shape.IShape

getBlendFunctionDestination, getBlendFunctionSource, getShaderProgram, getVertexBufferObjectManager, isBlendingEnabled, setBlendFunction, setBlendFunctionDestination, setBlendFunctionSource, setBlendingEnabled, setShaderProgram

Methods inherited from interface org.andengine.entity.IEntity

attachChild, callOnChildren, callOnChildren, clearEntityModifiers, clearUpdateHandlers, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertLocalToSceneCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, convertSceneToLocalCoordinates, detachChild, detachChild, detachChild, detachChildren, detachChildren, detachSelf, getAlpha, getBlue, getChildByIndex, getChildByMatcher, getChildByTag, getChildCount, getColor, getEntityModifierCount, getFirstChild, getGreen, getLastChild, getLocalToParentTransformation, getLocalToSceneTransformation, getParent, getParentToLocalTransformation, getRed, getRotation, getRotationCenterX, getRotationCenterY, getScaleCenterX, getScaleCenterY, getScaleX, getScaleY, getSceneToLocalTransformation, getSkewCenterX, getSkewCenterY, getSkewX, getSkewY, getTag, getUpdateHandlerCount, getUserData, getX, getY, getZIndex, hasParent, isChildrenIgnoreUpdate, isChildrenVisible, isCullingEnabled, isIgnoreUpdate, isRotated, isRotatedOrScaledOrSkewed, isScaled, isSkewed, isVisible, onAttached, onDetached, query, query, queryFirst, queryFirstForSubclass, queryForSubclass, queryForSubclass, registerEntityModifier, registerUpdateHandler, setAlpha, setBlue, setChildrenIgnoreUpdate, setChildrenVisible, setColor, setColor, setColor, setCullingEnabled, setGreen, setIgnoreUpdate, setParent, 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, unregisterEntityModifier, unregisterEntityModifiers, unregisterUpdateHandler, unregisterUpdateHandlers

Methods inherited from interface org.andengine.engine.handler.IDrawHandler

onDraw

Methods inherited from interface org.andengine.engine.handler.IUpdateHandler

onUpdate

Methods inherited from interface org.andengine.util.IDisposable

dispose, isDisposed

Methods inherited from interface org.andengine.entity.scene.ITouchArea

convertLocalToSceneCoordinates, convertSceneToLocalCoordinates, onAreaTouched

Field Detail

VERTEX_INDEX_X

public static final int VERTEX_INDEX_X

See Also:

Constant Field Values

VERTEX_INDEX_Y

public static final int VERTEX_INDEX_Y

See Also:

Constant Field Values

COLOR_INDEX

public static final int COLOR_INDEX

See Also:

Constant Field Values

TEXTURECOORDINATES_INDEX_U

public static final int TEXTURECOORDINATES_INDEX_U

See Also:

Constant Field Values

TEXTURECOORDINATES_INDEX_V

public static final int TEXTURECOORDINATES_INDEX_V

See Also:

Constant Field Values

VERTEX_SIZE

public static final int VERTEX_SIZE

See Also:

Constant Field Values

VERTICES_PER_SPRITE

public static final int VERTICES_PER_SPRITE

See Also:

Constant Field Values

SPRITE_SIZE

public static final int SPRITE_SIZE

See Also:

Constant Field Values

VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT

public static final VertexBufferObjectAttributes VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT

mTextureRegion

protected final ITextureRegion mTextureRegion

mSpriteVertexBufferObject

protected final ISpriteVertexBufferObject mSpriteVertexBufferObject

mFlippedVertical

protected boolean mFlippedVertical

mFlippedHorizontal

protected boolean mFlippedHorizontal

Constructor Detail

Sprite

public Sprite(float pX,
              float pY,
              ITextureRegion pTextureRegion,
              VertexBufferObjectManager pVertexBufferObjectManager)

Sprite

public Sprite(float pX,
              float pY,
              ITextureRegion pTextureRegion,
              VertexBufferObjectManager pVertexBufferObjectManager,
              ShaderProgram pShaderProgram)

Sprite

public Sprite(float pX,
              float pY,
              ITextureRegion pTextureRegion,
              VertexBufferObjectManager pVertexBufferObjectManager,
              DrawType pDrawType)

Sprite

public Sprite(float pX,
              float pY,
              ITextureRegion pTextureRegion,
              VertexBufferObjectManager pVertexBufferObjectManager,
              DrawType pDrawType,
              ShaderProgram pShaderProgram)

Sprite

public Sprite(float pX,
              float pY,
              ITextureRegion pTextureRegion,
              ISpriteVertexBufferObject pVertexBufferObject)

Sprite

public Sprite(float pX,
              float pY,
              ITextureRegion pTextureRegion,
              ISpriteVertexBufferObject pVertexBufferObject,
              ShaderProgram pShaderProgram)

Sprite

public Sprite(float pX,
              float pY,
              float pWidth,
              float pHeight,
              ITextureRegion pTextureRegion,
              VertexBufferObjectManager pVertexBufferObjectManager)

Sprite

public Sprite(float pX,
              float pY,
              float pWidth,
              float pHeight,
              ITextureRegion pTextureRegion,
              VertexBufferObjectManager pVertexBufferObjectManager,
              ShaderProgram pShaderProgram)

Sprite

public Sprite(float pX,
              float pY,
              float pWidth,
              float pHeight,
              ITextureRegion pTextureRegion,
              VertexBufferObjectManager pVertexBufferObjectManager,
              DrawType pDrawType)

Sprite

public Sprite(float pX,
              float pY,
              float pWidth,
              float pHeight,
              ITextureRegion pTextureRegion,
              VertexBufferObjectManager pVertexBufferObjectManager,
              DrawType pDrawType,
              ShaderProgram pShaderProgram)

Sprite

public Sprite(float pX,
              float pY,
              float pWidth,
              float pHeight,
              ITextureRegion pTextureRegion,
              ISpriteVertexBufferObject pSpriteVertexBufferObject)

Sprite

public Sprite(float pX,
              float pY,
              float pWidth,
              float pHeight,
              ITextureRegion pTextureRegion,
              ISpriteVertexBufferObject pSpriteVertexBufferObject,
              ShaderProgram pShaderProgram)

Method Detail

getTextureRegion

public ITextureRegion getTextureRegion()

isFlippedHorizontal

public boolean isFlippedHorizontal()

setFlippedHorizontal

public void setFlippedHorizontal(boolean pFlippedHorizontal)

isFlippedVertical

public boolean isFlippedVertical()

setFlippedVertical

public void setFlippedVertical(boolean pFlippedVertical)

setFlipped

public void setFlipped(boolean pFlippedHorizontal,
                       boolean pFlippedVertical)

getVertexBufferObject

public ISpriteVertexBufferObject getVertexBufferObject()

reset

public void reset()

Specified by:

reset in interface IUpdateHandler

Overrides:

reset in class RectangularShape

preDraw

protected void preDraw(GLState pGLState,
                       Camera pCamera)

Overrides:

preDraw in class Shape

Parameters:

pGLState - the currently active GLState i.e. to apply transformations to.

pCamera - the currently active Camera i.e. to be used for culling.

draw

protected void draw(GLState pGLState,
                    Camera pCamera)

Overrides:

draw in class Entity

Parameters:

pGLState - the currently active GLState i.e. to apply transformations to.

pCamera - the currently active Camera i.e. to be used for culling.

postDraw

protected void postDraw(GLState pGLState,
                        Camera pCamera)

Overrides:

postDraw in class Shape

Parameters:

pGLState - the currently active GLState i.e. to apply transformations to.

pCamera - the currently active Camera i.e. to be used for culling.

onUpdateVertices

protected void onUpdateVertices()

Specified by:

onUpdateVertices in class Shape

onUpdateColor

protected void onUpdateColor()

Overrides:

onUpdateColor in class Entity

onUpdateTextureCoordinates

protected void onUpdateTextureCoordinates()