org.andengine.entity.text

Class Text

java.lang.Object

org.andengine.entity.Entity

org.andengine.entity.shape.Shape

org.andengine.entity.shape.RectangularShape

org.andengine.entity.text.Text

All Implemented Interfaces:

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

Direct Known Subclasses:

TextMenuItem, TickerText

public class Text
extends RectangularShape

TODO Try Degenerate Triangles? (c) 2010 Nicolas Gramlich (c) 2011 Zynga Inc.

Since:

10:54:59 - 03.04.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
static float	LEADING_DEFAULT
static int	LETTER_SIZE
protected int	mCharactersMaximum
protected int	mCharactersToDraw
protected IFont	mFont
protected float	mLineAlignmentWidth
protected java.util.ArrayList<java.lang.CharSequence>	mLines
protected float	mLineWidthMaximum
protected IFloatList	mLineWidths
protected java.lang.CharSequence	mText
protected TextOptions	mTextOptions
protected ITextVertexBufferObject	mTextVertexBufferObject
protected int	mVertexCount
protected int	mVertexCountToDraw
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 int	VERTEX_STRIDE
static VertexBufferObjectAttributes	VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT
static int	VERTICES_PER_LETTER

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
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, int pCharactersMaximum, TextOptions pTextOptions, ITextVertexBufferObject pTextVertexBufferObject)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, int pCharactersMaximum, TextOptions pTextOptions, ITextVertexBufferObject pTextVertexBufferObject, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, int pCharactersMaximum, TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, int pCharactersMaximum, TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, int pCharactersMaximum, TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, int pCharactersMaximum, VertexBufferObjectManager pVertexBufferObjectManager)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, int pCharactersMaximum, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, int pCharactersMaximum, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, int pCharactersMaximum, VertexBufferObjectManager pVertexBufferObjectManager, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, VertexBufferObjectManager pVertexBufferObjectManager)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, VertexBufferObjectManager pVertexBufferObjectManager, DrawType pDrawType, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, java.lang.CharSequence pText, VertexBufferObjectManager pVertexBufferObjectManager, ShaderProgram pShaderProgram)

Method Summary

Modifier and Type	Method and Description
protected void	draw(GLState pGLState, Camera pCamera)
AutoWrap	getAutoWrap()
float	getAutoWrapWidth()
int	getCharactersMaximum()
IFont	getFont()
HorizontalAlign	getHorizontalAlign()
float	getLeading()
float	getLineAlignmentWidth()
java.util.ArrayList<java.lang.CharSequence>	getLines()
float	getLineWidthMaximum()
IFloatList	getLineWidths()
java.lang.CharSequence	getText()
TextOptions	getTextOptions()
ITextVertexBufferObject	getVertexBufferObject()
void	invalidateText()
protected void	onUpdateColor()
protected void	onUpdateVertices()
protected void	postDraw(GLState pGLState, Camera pCamera)
protected void	preDraw(GLState pGLState, Camera pCamera)
void	setAutoWrap(AutoWrap pAutoWrap)
void	setAutoWrapWidth(float pAutoWrapWidth)
void	setCharactersToDraw(int pCharactersToDraw)
void	setHorizontalAlign(HorizontalAlign pHorizontalAlign)
void	setLeading(float pLeading)
void	setText(java.lang.CharSequence pText)
void	setTextOptions(TextOptions pTextOptions)

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

collidesWith, contains, getHeight, getHeightScaled, getSceneCenterCoordinates, getSceneCenterCoordinates, getWidth, getWidthScaled, isCulled, reset, 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

LEADING_DEFAULT

public static final float LEADING_DEFAULT

See Also:

Constant Field Values

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_LETTER

public static final int VERTICES_PER_LETTER

See Also:

Constant Field Values

LETTER_SIZE

public static final int LETTER_SIZE

See Also:

Constant Field Values

VERTEX_STRIDE

public static final int VERTEX_STRIDE

See Also:

Constant Field Values

VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT

public static final VertexBufferObjectAttributes VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT

mFont

protected final IFont mFont

mLineWidthMaximum

protected float mLineWidthMaximum

mLineAlignmentWidth

protected float mLineAlignmentWidth

mTextOptions

protected TextOptions mTextOptions

mCharactersMaximum

protected final int mCharactersMaximum

mCharactersToDraw

protected int mCharactersToDraw

mVertexCountToDraw

protected int mVertexCountToDraw

mVertexCount

protected final int mVertexCount

mTextVertexBufferObject

protected final ITextVertexBufferObject mTextVertexBufferObject

mText

protected java.lang.CharSequence mText

mLines

protected java.util.ArrayList<java.lang.CharSequence> mLines

mLineWidths

protected IFloatList mLineWidths

Constructor Detail

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            VertexBufferObjectManager pVertexBufferObjectManager)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            VertexBufferObjectManager pVertexBufferObjectManager,
            ShaderProgram pShaderProgram)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            VertexBufferObjectManager pVertexBufferObjectManager,
            DrawType pDrawType)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            VertexBufferObjectManager pVertexBufferObjectManager,
            DrawType pDrawType,
            ShaderProgram pShaderProgram)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            TextOptions pTextOptions,
            VertexBufferObjectManager pVertexBufferObjectManager)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            TextOptions pTextOptions,
            VertexBufferObjectManager pVertexBufferObjectManager,
            ShaderProgram pShaderProgram)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            TextOptions pTextOptions,
            VertexBufferObjectManager pVertexBufferObjectManager,
            DrawType pDrawType)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            TextOptions pTextOptions,
            VertexBufferObjectManager pVertexBufferObjectManager,
            DrawType pDrawType,
            ShaderProgram pShaderProgram)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            int pCharactersMaximum,
            VertexBufferObjectManager pVertexBufferObjectManager)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            int pCharactersMaximum,
            VertexBufferObjectManager pVertexBufferObjectManager,
            ShaderProgram pShaderProgram)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            int pCharactersMaximum,
            VertexBufferObjectManager pVertexBufferObjectManager,
            DrawType pDrawType)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            int pCharactersMaximum,
            VertexBufferObjectManager pVertexBufferObjectManager,
            DrawType pDrawType,
            ShaderProgram pShaderProgram)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            int pCharactersMaximum,
            TextOptions pTextOptions,
            VertexBufferObjectManager pVertexBufferObjectManager)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            int pCharactersMaximum,
            TextOptions pTextOptions,
            VertexBufferObjectManager pVertexBufferObjectManager,
            DrawType pDrawType)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            int pCharactersMaximum,
            TextOptions pTextOptions,
            VertexBufferObjectManager pVertexBufferObjectManager,
            DrawType pDrawType,
            ShaderProgram pShaderProgram)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            int pCharactersMaximum,
            TextOptions pTextOptions,
            ITextVertexBufferObject pTextVertexBufferObject)

Text

public Text(float pX,
            float pY,
            IFont pFont,
            java.lang.CharSequence pText,
            int pCharactersMaximum,
            TextOptions pTextOptions,
            ITextVertexBufferObject pTextVertexBufferObject,
            ShaderProgram pShaderProgram)

Method Detail

getFont

public IFont getFont()

getCharactersMaximum

public int getCharactersMaximum()

getText

public java.lang.CharSequence getText()

setText

public void setText(java.lang.CharSequence pText)
             throws OutOfCharactersException

Parameters:

pText -

Throws:

OutOfCharactersException - leaves this Text object in an undefined state, until setText(CharSequence) is called again and no OutOfCharactersException is thrown.

getLines

public java.util.ArrayList<java.lang.CharSequence> getLines()

getLineWidths

public IFloatList getLineWidths()

getLineAlignmentWidth

public float getLineAlignmentWidth()

getLineWidthMaximum

public float getLineWidthMaximum()

getLeading

public float getLeading()

setLeading

public void setLeading(float pLeading)

getHorizontalAlign

public HorizontalAlign getHorizontalAlign()

setHorizontalAlign

public void setHorizontalAlign(HorizontalAlign pHorizontalAlign)

getAutoWrap

public AutoWrap getAutoWrap()

setAutoWrap

public void setAutoWrap(AutoWrap pAutoWrap)

getAutoWrapWidth

public float getAutoWrapWidth()

setAutoWrapWidth

public void setAutoWrapWidth(float pAutoWrapWidth)

getTextOptions

public TextOptions getTextOptions()

setTextOptions

public void setTextOptions(TextOptions pTextOptions)

setCharactersToDraw

public void setCharactersToDraw(int pCharactersToDraw)

getVertexBufferObject

public ITextVertexBufferObject getVertexBufferObject()

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.

onUpdateColor

protected void onUpdateColor()

Overrides:

onUpdateColor in class Entity

onUpdateVertices

protected void onUpdateVertices()

Specified by:

onUpdateVertices in class Shape

invalidateText

public void invalidateText()