org.andengine.opengl.font

Class Font

java.lang.Object

org.andengine.opengl.font.Font

All Implemented Interfaces:

IFont

Direct Known Subclasses:

StrokeFont

public class Font
extends java.lang.Object
implements IFont

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

Since:

10:39:33 - 03.04.2010

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	LETTER_TEXTURE_PADDING
protected android.graphics.Canvas	mCanvas
protected android.graphics.Paint.FontMetrics	mFontMetrics
protected android.graphics.Paint	mPaint
protected android.graphics.Rect	mTextBounds
protected float[]	mTextWidthContainer

Constructor Summary

Constructors

Constructor and Description
Font(FontManager pFontManager, ITexture pTexture, android.graphics.Typeface pTypeface, float pSize, boolean pAntiAlias, Color pColor)
Font(FontManager pFontManager, ITexture pTexture, android.graphics.Typeface pTypeface, float pSize, boolean pAntiAlias, int pColorARGBPackedInt)

Method Summary

Modifier and Type	Method and Description
protected void	drawLetter(java.lang.String pCharacterAsString, float pLeft, float pTop)
float	getAscent()
float	getDescent()
float	getLeading()
Letter	getLetter(char pCharacter)
protected android.graphics.Bitmap	getLetterBitmap(Letter pLetter)
float	getLineHeight()
ITexture	getTexture()
void	invalidateLetters()
void	load()
void	prepareLetters(char... pCharacters)
void	unload()
void	update(GLState pGLState)
protected void	updateTextBounds(java.lang.String pCharacterAsString)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LETTER_TEXTURE_PADDING

protected static final int LETTER_TEXTURE_PADDING

See Also:

Constant Field Values

mPaint

protected final android.graphics.Paint mPaint

mFontMetrics

protected final android.graphics.Paint.FontMetrics mFontMetrics

mCanvas

protected final android.graphics.Canvas mCanvas

mTextBounds

protected final android.graphics.Rect mTextBounds

mTextWidthContainer

protected final float[] mTextWidthContainer

Constructor Detail

Font

public Font(FontManager pFontManager,
            ITexture pTexture,
            android.graphics.Typeface pTypeface,
            float pSize,
            boolean pAntiAlias,
            Color pColor)

Font

public Font(FontManager pFontManager,
            ITexture pTexture,
            android.graphics.Typeface pTypeface,
            float pSize,
            boolean pAntiAlias,
            int pColorARGBPackedInt)

Method Detail

getLeading

public float getLeading()

Returns:

the gap between the lines.

getAscent

public float getAscent()

Returns:

the distance from the baseline to the top, which is usually negative.

getDescent

public float getDescent()

Returns:

the distance from the baseline to the bottom, which is usually positive.

getTexture

public ITexture getTexture()

Specified by:

getTexture in interface IFont

load

public void load()

Specified by:

load in interface IFont

unload

public void unload()

Specified by:

unload in interface IFont

getLineHeight

public float getLineHeight()

Specified by:

getLineHeight in interface IFont

getLetter

public Letter getLetter(char pCharacter)
                 throws FontException

Specified by:

getLetter in interface IFont

Throws:

FontException

invalidateLetters

public void invalidateLetters()

getLetterBitmap

protected android.graphics.Bitmap getLetterBitmap(Letter pLetter)
                                           throws FontException

Throws:

FontException

drawLetter

protected void drawLetter(java.lang.String pCharacterAsString,
                          float pLeft,
                          float pTop)

prepareLetters

public void prepareLetters(char... pCharacters)
                    throws FontException

Throws:

FontException

updateTextBounds

protected void updateTextBounds(java.lang.String pCharacterAsString)

update

public void update(GLState pGLState)