org.mini2Dx.core.font

Class MonospaceGameFont

java.lang.Object

org.mini2Dx.core.font.MonospaceGameFont

All Implemented Interfaces:

GameFont

public class MonospaceGameFont
extends java.lang.Object
implements GameFont

A GameFont where every character is a fixed-width which simplifies rendering calculations

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MonospaceGameFont.FontParameters
static interface	MonospaceGameFont.FontRenderListener

Constructor Summary

Constructors

Constructor and Description
MonospaceGameFont(MonospaceGameFont.FontParameters fontParameters)

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes of this font instance and its resources
void	draw(Graphics g, org.mini2Dx.gdx.utils.Array<MonospaceGlyph> glyphs, float x, float y, MonospaceGameFont.FontRenderListener listener)
void	draw(Graphics g, java.lang.String str, float x, float y) Draws text to the Graphics context using this font
void	draw(Graphics g, java.lang.String str, float x, float y, float renderWidth) Draws text to the Graphics context using this font
void	draw(Graphics g, java.lang.String str, float x, float y, float renderWidth, int horizontalAlignment, boolean wrap) Draws text to the Graphics context using this font
void	draw(Graphics g, java.lang.String str, float x, float y, float renderWidth, int horizontalAlignment, boolean wrap, MonospaceGameFont.FontRenderListener listener)
void	draw(Graphics g, java.lang.String str, float x, float y, float renderWidth, MonospaceGameFont.FontRenderListener listener)
float	getCapHeight() Returns the height of a capital letter above the baseline
Color	getColor() Returns the Color the font will be rendered with
MonospaceGameFont.FontParameters	getFontParameters()
float	getLineHeight() Returns the line height of the font
FontGlyphLayout	getSharedGlyphLayout() Returns a FontGlyphLayout instance associated with this GameFont instance
TextureRegion	getTextureRegion(char c)
boolean	load(AssetManager assetManager) Loads the GameFont via the AssetManager
boolean	load(FileHandle textureHandle) Loads the GameFont using the
boolean	loadExternal() Loads the GameFont using Files.external(String).
boolean	loadInternal() Loads the GameFont using Files.internal(String).
GameFontCache	newCache() Creates a GameFontCache for this font
FontGlyphLayout	newGlyphLayout() Creates a FontGlyphLayout for this font
void	setColor(Color color) Sets the Color to render the font with
boolean	useIntegerPositions() Returns if characters use integer positions

Methods inherited from class java.lang.Object

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

Constructor Detail

MonospaceGameFont

public MonospaceGameFont(MonospaceGameFont.FontParameters fontParameters)

Method Detail

loadInternal

public boolean loadInternal()

Loads the GameFont using Files.internal(String). The texture path must be set in the MonospaceGameFont.FontParameters.

Specified by:

loadInternal in interface GameFont

Returns:

True on success

loadExternal

public boolean loadExternal()

Loads the GameFont using Files.external(String). The texture path must be set in the MonospaceGameFont.FontParameters.

Specified by:

loadExternal in interface GameFont

Returns:

True on success

load

public boolean load(FileHandle textureHandle)

Loads the GameFont using the

Parameters:

textureHandle -

Returns:

True on success

load

public boolean load(AssetManager assetManager)

Description copied from interface: GameFont

Loads the GameFont via the AssetManager

Specified by:

load in interface GameFont

Parameters:

assetManager - The AssetManager to use

Returns:

True on success

draw

public void draw(Graphics g,
                 java.lang.String str,
                 float x,
                 float y)

Description copied from interface: GameFont

Draws text to the Graphics context using this font

Specified by:

draw in interface GameFont

Parameters:

g - The Graphics context

str - The text to render

x - The x coordinate to draw at

y - The y coordinate to draw at

draw

public void draw(Graphics g,
                 java.lang.String str,
                 float x,
                 float y,
                 float renderWidth)

Description copied from interface: GameFont

Draws text to the Graphics context using this font

Specified by:

draw in interface GameFont

Parameters:

g - The Graphics context

str - The text to render

x - The x coordinate to draw at

y - The y coordinate to draw at

renderWidth - The target width to render with (Note: text will wrap if exceeding this width)

draw

public void draw(Graphics g,
                 java.lang.String str,
                 float x,
                 float y,
                 float renderWidth,
                 int horizontalAlignment,
                 boolean wrap)

Description copied from interface: GameFont

Draws text to the Graphics context using this font

Specified by:

draw in interface GameFont

Parameters:

g - The Graphics context

str - The text to render

x - The x coordinate to draw at

y - The y coordinate to draw at

renderWidth - The target width to render with

horizontalAlignment - The horizontal alignment within the targetWidth. See Align

wrap - True if text should wrap if exceeding targetWidth, false if it should clip

draw

public void draw(Graphics g,
                 java.lang.String str,
                 float x,
                 float y,
                 float renderWidth,
                 MonospaceGameFont.FontRenderListener listener)

draw

public void draw(Graphics g,
                 java.lang.String str,
                 float x,
                 float y,
                 float renderWidth,
                 int horizontalAlignment,
                 boolean wrap,
                 MonospaceGameFont.FontRenderListener listener)

draw

public void draw(Graphics g,
                 org.mini2Dx.gdx.utils.Array<MonospaceGlyph> glyphs,
                 float x,
                 float y,
                 MonospaceGameFont.FontRenderListener listener)

newGlyphLayout

public FontGlyphLayout newGlyphLayout()

Description copied from interface: GameFont

Creates a FontGlyphLayout for this font

Specified by:

newGlyphLayout in interface GameFont

Returns:

A new FontGlyphLayout instance

getSharedGlyphLayout

public FontGlyphLayout getSharedGlyphLayout()

Description copied from interface: GameFont

Returns a FontGlyphLayout instance associated with this GameFont instance

Specified by:

getSharedGlyphLayout in interface GameFont

Returns:

A FontGlyphLayout instance attached to this font

newCache

public GameFontCache newCache()

Description copied from interface: GameFont

Creates a GameFontCache for this font

Specified by:

newCache in interface GameFont

Returns:

A new GameFontCache instance

getColor

public Color getColor()

Description copied from interface: GameFont

Returns the Color the font will be rendered with

Specified by:

getColor in interface GameFont

Returns:

Black by default

setColor

public void setColor(Color color)

Description copied from interface: GameFont

Sets the Color to render the font with

Specified by:

setColor in interface GameFont

getLineHeight

public float getLineHeight()

Description copied from interface: GameFont

Returns the line height of the font

Specified by:

getLineHeight in interface GameFont

Returns:

getCapHeight

public float getCapHeight()

Description copied from interface: GameFont

Returns the height of a capital letter above the baseline

Specified by:

getCapHeight in interface GameFont

Returns:

getTextureRegion

public TextureRegion getTextureRegion(char c)

useIntegerPositions

public boolean useIntegerPositions()

Description copied from interface: GameFont

Returns if characters use integer positions

Specified by:

useIntegerPositions in interface GameFont

Returns:

False if characters can be placed on half-pixels

dispose

public void dispose()

Description copied from interface: GameFont

Disposes of this font instance and its resources

Specified by:

dispose in interface GameFont

getFontParameters

public MonospaceGameFont.FontParameters getFontParameters()