com.jme3.font

Class BitmapFont

java.lang.Object

com.jme3.font.BitmapFont

All Implemented Interfaces:

Savable

public class BitmapFont
extends java.lang.Object
implements Savable

Represents a font within jME that is generated with the AngelCode Bitmap Font Generator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BitmapFont.Align Specifies horizontal alignment for text.
static class	BitmapFont.VAlign Specifies vertical alignment for text.

Constructor Summary

Constructors

Constructor and Description
BitmapFont()

Method Summary

Modifier and Type	Method and Description
BitmapText	createLabel(java.lang.String content)
float	getCharacterAdvance(char curChar, char nextChar, float size)
BitmapCharacterSet	getCharSet()
GlyphParser	getGlyphParser()
float	getLineWidth(java.lang.CharSequence text)
Material	getPage(int index)
int	getPageSize()
float	getPreferredSize()
boolean	isRightToLeft()
void	merge(BitmapFont newFont) Merge two fonts.
void	read(JmeImporter im)
void	setCharSet(BitmapCharacterSet charSet)
void	setGlyphParser(GlyphParser glyphParser) For cursive fonts a GlyphParser needs to be specified which is used to determine glyph shape by the adjacent glyphs.
void	setPages(Material[] pages)
void	setRightToLeft(boolean rightToLeft) Specify if this is a right-to-left font.
void	setStyle(int style)
void	write(JmeExporter ex)

Methods inherited from class java.lang.Object

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

Constructor Detail

BitmapFont

public BitmapFont()

Method Detail

isRightToLeft

public boolean isRightToLeft()

Returns:

true, if this is a right-to-left font, otherwise it will return false.

setRightToLeft

public void setRightToLeft(boolean rightToLeft)

Specify if this is a right-to-left font. By default it is set to false. This can be "overwritten" in the BitmapText constructor.

Parameters:

rightToLeft - true → right-to-left, false → left-to-right (default=false)

createLabel

public BitmapText createLabel(java.lang.String content)

getPreferredSize

public float getPreferredSize()

setCharSet

public void setCharSet(BitmapCharacterSet charSet)

setPages

public void setPages(Material[] pages)

getPage

public Material getPage(int index)

getPageSize

public int getPageSize()

getCharSet

public BitmapCharacterSet getCharSet()

setGlyphParser

public void setGlyphParser(GlyphParser glyphParser)

For cursive fonts a GlyphParser needs to be specified which is used to determine glyph shape by the adjacent glyphs. If nothing is set, all glyphs will be rendered isolated.

Parameters:

glyphParser - the desired parser (alias created) or null for none (default=null)

getGlyphParser

public GlyphParser getGlyphParser()

Returns:

The GlyphParser set on the font, or null if it has no glyph parser.

getCharacterAdvance

public float getCharacterAdvance(char curChar,
                                 char nextChar,
                                 float size)

write

public void write(JmeExporter ex)
           throws java.io.IOException

Specified by:

write in interface Savable

Throws:

java.io.IOException

read

public void read(JmeImporter im)
          throws java.io.IOException

Specified by:

read in interface Savable

Throws:

java.io.IOException

getLineWidth

public float getLineWidth(java.lang.CharSequence text)

merge

public void merge(BitmapFont newFont)

Merge two fonts. If two font have the same style, merge will fail.

Parameters:

newFont - Style must be assigned to this. author: Yonghoon

setStyle

public void setStyle(int style)