org.mini2Dx.core.font

Class BitmapFontCache

java.lang.Object

org.mini2Dx.core.font.BitmapFontCache

All Implemented Interfaces:

GameFontCache

public class BitmapFontCache
extends java.lang.Object
implements GameFontCache

Constructor Summary

Constructors

Constructor and Description
BitmapFontCache(BitmapFont font)
BitmapFontCache(BitmapFont font, boolean integer)

Method Summary

Modifier and Type	Method and Description
void	addText(java.lang.CharSequence str, float x, float y) Adds text to the cache
void	addText(java.lang.CharSequence str, float x, float y, float targetWidth, int halign, boolean wrap) Adds text to the cache
void	clear() Clears all text from the cache
void	draw(Graphics g) Draws the cache to the Graphics context
com.badlogic.gdx.graphics.Color	getColor() Returns the Color used for subsequent text operations
GameFont	getFont() Returns the underlying GameFont for this cache
void	setAllAlphas(float alpha) Sets the Color alpha for previous text operations
void	setAllColors(com.badlogic.gdx.graphics.Color colors) Sets the Color for previous text operations
void	setColor(com.badlogic.gdx.graphics.Color color) Sets the Color for subsequent text operations
void	setPosition(float x, float y) Sets the position of the cache
void	setText(java.lang.CharSequence str, float x, float y) Clears all text from the cache and adds a new text sequence
void	setText(java.lang.CharSequence str, float x, float y, float targetWidth, int halign, boolean wrap) Clears all text from the cache and adds a new text sequence
void	translate(float x, float y) Sets the position of the text relative to its current position

Methods inherited from class java.lang.Object

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

Constructor Detail

BitmapFontCache

public BitmapFontCache(BitmapFont font)

BitmapFontCache

public BitmapFontCache(BitmapFont font,
                       boolean integer)

Method Detail

addText

public void addText(java.lang.CharSequence str,
                    float x,
                    float y)

Description copied from interface: GameFontCache

Adds text to the cache

Specified by:

addText in interface GameFontCache

Parameters:

str - The text to be added

x - The x coordinate to add the text to

y - The y coordinate to add the text to

addText

public void addText(java.lang.CharSequence str,
                    float x,
                    float y,
                    float targetWidth,
                    int halign,
                    boolean wrap)

Description copied from interface: GameFontCache

Adds text to the cache

Specified by:

addText in interface GameFontCache

Parameters:

str - The text to be added

x - The x coordinate to add the text to

y - The y coordinate to add the text to

targetWidth - The target width of the text (text will wrap if exceeded)

halign - The horizontal alignment of the text based on Align

clear

public void clear()

Description copied from interface: GameFontCache

Clears all text from the cache

Specified by:

clear in interface GameFontCache

draw

public void draw(Graphics g)

Description copied from interface: GameFontCache

Draws the cache to the Graphics context

Specified by:

draw in interface GameFontCache

Parameters:

g - The Graphics context to draw to

getColor

public com.badlogic.gdx.graphics.Color getColor()

Description copied from interface: GameFontCache

Returns the Color used for subsequent text operations

Specified by:

getColor in interface GameFontCache

Returns:

The Color to draw with

setColor

public void setColor(com.badlogic.gdx.graphics.Color color)

Description copied from interface: GameFontCache

Sets the Color for subsequent text operations

Specified by:

setColor in interface GameFontCache

Parameters:

color - The Color to draw with

setAllColors

public void setAllColors(com.badlogic.gdx.graphics.Color colors)

Description copied from interface: GameFontCache

Sets the Color for previous text operations

Specified by:

setAllColors in interface GameFontCache

Parameters:

colors - The Color to draw with

setAllAlphas

public void setAllAlphas(float alpha)

Description copied from interface: GameFontCache

Sets the Color alpha for previous text operations

Specified by:

setAllAlphas in interface GameFontCache

Parameters:

alpha - The alpha to draw with

setText

public void setText(java.lang.CharSequence str,
                    float x,
                    float y)

Description copied from interface: GameFontCache

Clears all text from the cache and adds a new text sequence

Specified by:

setText in interface GameFontCache

Parameters:

str - The text to be added

x - The x coordinate to add the text to

y - The y coordinate to add the text to

setText

public void setText(java.lang.CharSequence str,
                    float x,
                    float y,
                    float targetWidth,
                    int halign,
                    boolean wrap)

Description copied from interface: GameFontCache

Clears all text from the cache and adds a new text sequence

Specified by:

setText in interface GameFontCache

Parameters:

str - The text to be added

x - The x coordinate to add the text to

y - The y coordinate to add the text to

targetWidth - The target width of the text (text will wrap if exceeded)

halign - The horizontal alignment of the text based on Align

wrap - True if the text should wrap when exceeding the targetWidth, false if the text should clip

translate

public void translate(float x,
                      float y)

Description copied from interface: GameFontCache

Sets the position of the text relative to its current position

Specified by:

translate in interface GameFontCache

Parameters:

x - The amount to move by on the x axis

y - The amount to move by on the y axis

setPosition

public void setPosition(float x,
                        float y)

Description copied from interface: GameFontCache

Sets the position of the cache

Specified by:

setPosition in interface GameFontCache

Parameters:

x - The amount to move by on the x axis

y - The amount to move by on the y axis

getFont

public GameFont getFont()

Description copied from interface: GameFontCache

Returns the underlying GameFont for this cache

Specified by:

getFont in interface GameFontCache

Returns:

The GameFont this cache was created for