public class

Text

extends RectangularShape
java.lang.Object
   ↳ org.andengine.entity.Entity
     ↳ org.andengine.entity.shape.Shape
       ↳ org.andengine.entity.shape.RectangularShape
         ↳ org.andengine.entity.text.Text
Known Direct Subclasses

Class Overview

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

Summary

Nested Classes
class Text.HighPerformanceTextVertexBufferObject  
interface Text.ITextVertexBufferObject  
class Text.LowMemoryTextVertexBufferObject  
class Text.TextOptions  
Constants
int COLOR_INDEX
float LEADING_DEFAULT
int LETTER_SIZE
int TEXTURECOORDINATES_INDEX_U
int TEXTURECOORDINATES_INDEX_V
int VERTEX_INDEX_X
int VERTEX_INDEX_Y
int VERTEX_SIZE
int VERTEX_STRIDE
int VERTICES_PER_LETTER
[Expand]
Inherited Constants
From interface org.andengine.entity.shape.IShape
Fields
public static final VertexBufferObjectAttributes VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT
protected final int mCharactersMaximum
protected int mCharactersToDraw
protected final IFont mFont
protected float mLineAlignmentWidth
protected float mLineWidthMaximum
protected IFloatList mLineWidths
protected ArrayList<CharSequence> mLines
protected CharSequence mText
protected Text.TextOptions mTextOptions
protected final Text.ITextVertexBufferObject mTextVertexBufferObject
protected final int mVertexCount
protected int mVertexCountToDraw
[Expand]
Inherited Fields
From class org.andengine.entity.shape.RectangularShape
From class org.andengine.entity.shape.Shape
From class org.andengine.entity.Entity
Public Constructors
Text(float pX, float pY, IFont pFont, CharSequence pText, VertexBufferObjectManager pVertexBufferObjectManager)
Text(float pX, float pY, IFont pFont, CharSequence pText, VertexBufferObjectManager pVertexBufferObjectManager, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, CharSequence pText, VertexBufferObjectManager pVertexBufferObjectManager, VertexBufferObject.DrawType pDrawType)
Text(float pX, float pY, IFont pFont, CharSequence pText, VertexBufferObjectManager pVertexBufferObjectManager, VertexBufferObject.DrawType pDrawType, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, CharSequence pText, Text.TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager)
Text(float pX, float pY, IFont pFont, CharSequence pText, Text.TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, CharSequence pText, Text.TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager, VertexBufferObject.DrawType pDrawType)
Text(float pX, float pY, IFont pFont, CharSequence pText, Text.TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager, VertexBufferObject.DrawType pDrawType, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, CharSequence pText, int pCharactersMaximum, VertexBufferObjectManager pVertexBufferObjectManager)
Text(float pX, float pY, IFont pFont, CharSequence pText, int pCharactersMaximum, VertexBufferObjectManager pVertexBufferObjectManager, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, CharSequence pText, int pCharactersMaximum, VertexBufferObjectManager pVertexBufferObjectManager, VertexBufferObject.DrawType pDrawType)
Text(float pX, float pY, IFont pFont, CharSequence pText, int pCharactersMaximum, VertexBufferObjectManager pVertexBufferObjectManager, VertexBufferObject.DrawType pDrawType, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, CharSequence pText, int pCharactersMaximum, Text.TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager)
Text(float pX, float pY, IFont pFont, CharSequence pText, int pCharactersMaximum, Text.TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager, VertexBufferObject.DrawType pDrawType)
Text(float pX, float pY, IFont pFont, CharSequence pText, int pCharactersMaximum, Text.TextOptions pTextOptions, VertexBufferObjectManager pVertexBufferObjectManager, VertexBufferObject.DrawType pDrawType, ShaderProgram pShaderProgram)
Text(float pX, float pY, IFont pFont, CharSequence pText, int pCharactersMaximum, Text.TextOptions pTextOptions, Text.ITextVertexBufferObject pTextVertexBufferObject)
Text(float pX, float pY, IFont pFont, CharSequence pText, int pCharactersMaximum, Text.TextOptions pTextOptions, Text.ITextVertexBufferObject pTextVertexBufferObject, ShaderProgram pShaderProgram)
Public Methods
Text.TextOptions.AutoWrap getAutoWrap()
float getAutoWrapWidth()
int getCharactersMaximum()
IFont getFont()
HorizontalAlign getHorizontalAlign()
float getLeading()
float getLineAlignmentWidth()
float getLineWidthMaximum()
IFloatList getLineWidths()
ArrayList<CharSequence> getLines()
CharSequence getText()
Text.TextOptions getTextOptions()
Text.ITextVertexBufferObject getVertexBufferObject()
void invalidateText()
void setAutoWrap(Text.TextOptions.AutoWrap pAutoWrap)
void setAutoWrapWidth(float pAutoWrapWidth)
void setHorizontalAlign(HorizontalAlign pHorizontalAlign)
void setLeading(float pLeading)
void setText(CharSequence pText)
void setTextOptions(Text.TextOptions pTextOptions)
Protected Methods
void draw(GLState pGLState, Camera pCamera)
void onUpdateColor()
void onUpdateVertices()
void postDraw(GLState pGLState, Camera pCamera)
void preDraw(GLState pGLState, Camera pCamera)
[Expand]
Inherited Methods
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

Constants

public static final int COLOR_INDEX

Constant Value: 2 (0x00000002)

public static final float LEADING_DEFAULT

Constant Value: 0.0

public static final int LETTER_SIZE

Constant Value: 30 (0x0000001e)

public static final int TEXTURECOORDINATES_INDEX_U

Constant Value: 3 (0x00000003)

public static final int TEXTURECOORDINATES_INDEX_V

Constant Value: 4 (0x00000004)

public static final int VERTEX_INDEX_X

Constant Value: 0 (0x00000000)

public static final int VERTEX_INDEX_Y

Constant Value: 1 (0x00000001)

public static final int VERTEX_SIZE

Constant Value: 5 (0x00000005)

public static final int VERTEX_STRIDE

Constant Value: 20 (0x00000014)

public static final int VERTICES_PER_LETTER

Constant Value: 6 (0x00000006)

Fields

public static final VertexBufferObjectAttributes VERTEXBUFFEROBJECTATTRIBUTES_DEFAULT

protected final int mCharactersMaximum

protected int mCharactersToDraw

protected final IFont mFont

protected float mLineAlignmentWidth

protected float mLineWidthMaximum

protected IFloatList mLineWidths

protected ArrayList<CharSequence> mLines

protected CharSequence mText

protected Text.TextOptions mTextOptions

protected final Text.ITextVertexBufferObject mTextVertexBufferObject

protected final int mVertexCount

protected int mVertexCountToDraw

Public Constructors

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Methods

public Text.TextOptions.AutoWrap getAutoWrap ()

public float getAutoWrapWidth ()

public int getCharactersMaximum ()

public IFont getFont ()

public HorizontalAlign getHorizontalAlign ()

public float getLeading ()

public float getLineAlignmentWidth ()

public float getLineWidthMaximum ()

public IFloatList getLineWidths ()

public ArrayList<CharSequence> getLines ()

public CharSequence getText ()

public Text.TextOptions getTextOptions ()

public Text.ITextVertexBufferObject getVertexBufferObject ()

public void invalidateText ()

public void setAutoWrap (Text.TextOptions.AutoWrap pAutoWrap)

public void setAutoWrapWidth (float pAutoWrapWidth)

public void setHorizontalAlign (HorizontalAlign pHorizontalAlign)

public void setLeading (float pLeading)

public void setText (CharSequence pText)

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

public void setTextOptions (Text.TextOptions pTextOptions)

Protected Methods

protected void draw (GLState pGLState, Camera pCamera)

Parameters
pGLState the currently active GLState i.e. to apply transformations to.
pCamera the currently active Camera i.e. to be used for culling.

protected void onUpdateColor ()

protected void onUpdateVertices ()

protected void postDraw (GLState pGLState, Camera pCamera)

Parameters
pGLState the currently active GLState i.e. to apply transformations to.
pCamera the currently active Camera i.e. to be used for culling.

protected void preDraw (GLState pGLState, Camera pCamera)

Parameters
pGLState the currently active GLState i.e. to apply transformations to.
pCamera the currently active Camera i.e. to be used for culling.