com.bonzaiengine.font

Class BmfFont

java.lang.Object

com.bonzaiengine.font.BmfFont

All Implemented Interfaces:

IFont

Direct Known Subclasses:

SdFont

public class BmfFont
extends java.lang.Object
implements IFont

BMF Font by AngelCode font generator.

Export options supported are:

• Font smoothing off
• Bit depth: 8/32 bits except "Pack chars in multiple channels"
• Chnl A: must be Glyph
• Font descriptor: Text only
• Textures: PNG, TGA or DDS
• Compression: all except DXT3 and DXT5

All the other options are generally left untouched.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SPRITE

Constructor Summary

Constructors

Constructor and Description
BmfFont(AssetManager assets, Stream fntStream)
BmfFont(UI ui, Stream fntStream)

Method Summary

Modifier and Type	Method and Description
int	getFontSize()
float	getHeightOverBaseLine(int fontSize)
float	getHeightUnderBaseLine(int fontSize)
float	getLineHeight(int fontSize)
TextSize	getTextSize(TextSize dst, FontPacket packet, boolean spaceAtEnd)
boolean	isBold()
boolean	isFailed()
boolean	isItalic()
boolean	isLoaded()
boolean	isLoadedOrLoad()
void	render(IGL gl, Array<FontPacket> fontPackets, boolean forceBlend)
void	render(IGL gl, FontPacket[] fontPackets, boolean forceBlend)
void	render(IGL gl, FontPacket fontPacket, boolean forceBlend)
void	setFontSize(int size)
static int	splitLines(Array<java.lang.String> lines, java.lang.String text, boolean spaceAtEnd)
float	trim(java.lang.String text, int fontSize, int maxWidth)

Methods inherited from class java.lang.Object

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

Field Detail

SPRITE

public static final java.lang.String SPRITE

See Also:

Constant Field Values

Constructor Detail

BmfFont

public BmfFont(AssetManager assets,
               Stream fntStream)

BmfFont

public BmfFont(UI ui,
               Stream fntStream)

Method Detail

isLoaded

public final boolean isLoaded()

Specified by:

isLoaded in interface IFont

Returns:

true if the asynchronous Task state is failure.

isLoadedOrLoad

public boolean isLoadedOrLoad()

Specified by:

isLoadedOrLoad in interface IFont

Returns:

true if the IFont is loaded

isFailed

public final boolean isFailed()

Specified by:

isFailed in interface IFont

Returns:

true if the asynchronous Task state is failure.

render

public final void render(IGL gl,
                         FontPacket fontPacket,
                         boolean forceBlend)

Specified by:

render in interface IFont

Parameters:

gl - OpenGL context

fontPacket - font packet to render

forceBlend - fore alpha blending (else alpha testing can be used)

render

public final void render(IGL gl,
                         FontPacket[] fontPackets,
                         boolean forceBlend)

Specified by:

render in interface IFont

Parameters:

gl - OpenGL context

fontPackets - array of FontPacket to render

render

public final void render(IGL gl,
                         Array<FontPacket> fontPackets,
                         boolean forceBlend)

Specified by:

render in interface IFont

Parameters:

gl - OpenGL context

fontPackets - list of FontPacket to render

getTextSize

public final TextSize getTextSize(TextSize dst,
                                  FontPacket packet,
                                  boolean spaceAtEnd)

Specified by:

getTextSize in interface IFont

Parameters:

dst - destination to store result

spaceAtEnd - true to take into account space at ends (default may vary from implementation, false for BMFont/SDFont)

See Also:

#getTextSize(TextSize, String, int)

splitLines

public static final int splitLines(Array<java.lang.String> lines,
                                   java.lang.String text,
                                   boolean spaceAtEnd)

Returns:

the number of characters

trim

public final float trim(java.lang.String text,
                        int fontSize,
                        int maxWidth)

Specified by:

trim in interface IFont

Returns:

the number of characters within maxWidth

getFontSize

public final int getFontSize()

Specified by:

getFontSize in interface IFont

Returns:

the font size in pixels

setFontSize

public final void setFontSize(int size)

Specified by:

setFontSize in interface IFont

Parameters:

size - new size in pixel, -1 to use default size

getLineHeight

public final float getLineHeight(int fontSize)

Specified by:

getLineHeight in interface IFont

Returns:

the line height in pixels, which is equals to #getHeightOverBaseLine() + #getHeightUnderBaseLine()

getHeightOverBaseLine

public final float getHeightOverBaseLine(int fontSize)

Specified by:

getHeightOverBaseLine in interface IFont

Returns:

the height in pixels over the baseline

getHeightUnderBaseLine

public final float getHeightUnderBaseLine(int fontSize)

Specified by:

getHeightUnderBaseLine in interface IFont

Returns:

the height in pixels under the base line

isBold

public final boolean isBold()

Specified by:

isBold in interface IFont

Returns:

true if font is bold

isItalic

public final boolean isItalic()

Specified by:

isItalic in interface IFont

Returns:

true if font is italic