org.mini2Dx.core.font

Interface GameFontCache

All Known Implementing Classes:

LibgdxBitmapFontCache, MonospaceGameFontCache

public interface GameFontCache

Caches glyph geometry for fast rendering of static text

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
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(Color color) Sets the Color for previous text operations
void	setColor(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

Method Detail

addText

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

Adds text to the cache

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

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

Adds text to the cache

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 based on Align

clear

void clear()

Clears all text from the cache

draw

void draw(Graphics g)

Draws the cache to the Graphics context

Parameters:

g - The Graphics context to draw to

getColor

Color getColor()

Returns the Color used for subsequent text operations

Returns:

The Color to draw with

setColor

void setColor(Color color)

Sets the Color for subsequent text operations

Parameters:

color - The Color to draw with

setAllColors

void setAllColors(Color color)

Sets the Color for previous text operations

Parameters:

color - The Color to draw with

setAllAlphas

void setAllAlphas(float alpha)

Sets the Color alpha for previous text operations

Parameters:

alpha - The alpha to draw with

setText

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

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

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

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

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

void translate(float x,
               float y)

Sets the position of the text relative to its current position

Parameters:

x - The amount to move by on the x axis

y - The amount to move by on the y axis

setPosition

void setPosition(float x,
                 float y)

Sets the position of the cache

Parameters:

x - The amount to move by on the x axis

y - The amount to move by on the y axis

getFont

GameFont getFont()

Returns the underlying GameFont for this cache

Returns:

The GameFont this cache was created for