org.mini2Dx.ui.animation

Class TypingTextAnimation

java.lang.Object

org.mini2Dx.ui.animation.BaseTextAnimation

org.mini2Dx.ui.animation.TypingTextAnimation

All Implemented Interfaces:

TextAnimation

public class TypingTextAnimation
extends BaseTextAnimation

A TextAnimation that reveals the text as if it were being typed

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_CHARACTERS_PER_SECOND

Fields inherited from class org.mini2Dx.ui.animation.BaseTextAnimation

finished

Constructor Summary

Constructors

Constructor and Description
TypingTextAnimation() Constructor.
TypingTextAnimation(float charactersPerSecond) Constructor

Method Summary

Modifier and Type	Method and Description
float	getCharactersPerSecond()
int	getCurrentCharacterIndex() Returns the current index of the animation
void	onResize(GameFontCache cache, java.lang.String text, float renderWidth, int hAlign) Handles label resizing
void	render(GameFontCache cache, Graphics g, int renderX, int renderY) Renders the animation
protected void	resetState()
void	skip() Sets the TextAnimation to be skipped
void	update(GameFontCache cache, java.lang.String text, float renderWidth, int hAlign, float delta) Update the animation

Methods inherited from class org.mini2Dx.ui.animation.BaseTextAnimation

addTextAnimationListener, isFinished, removeTextAnimationListener, reset, setFinished

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARACTERS_PER_SECOND

public static final float DEFAULT_CHARACTERS_PER_SECOND

See Also:

Constant Field Values

Constructor Detail

TypingTextAnimation

public TypingTextAnimation()

Constructor. Defaults to DEFAULT_CHARACTERS_PER_SECOND characters revealed per second.

TypingTextAnimation

public TypingTextAnimation(float charactersPerSecond)

Constructor

Parameters:

charactersPerSecond - The amount of characters to reveal per second

Method Detail

update

public void update(GameFontCache cache,
                   java.lang.String text,
                   float renderWidth,
                   int hAlign,
                   float delta)

Description copied from interface: TextAnimation

Update the animation

Parameters:

cache - The GameFontCache to use to render the text

text - The target text to display

renderWidth - The text render width

hAlign - The horizontal alignment of the text

delta - The time since the last frame (in seconds)

render

public void render(GameFontCache cache,
                   Graphics g,
                   int renderX,
                   int renderY)

Description copied from interface: TextAnimation

Renders the animation

Parameters:

cache - The GameFontCache to use to render the text

g - The Graphics context

renderX - The render X coordinate

renderY - The render Y coordinate

skip

public void skip()

Description copied from interface: TextAnimation

Sets the TextAnimation to be skipped

onResize

public void onResize(GameFontCache cache,
                     java.lang.String text,
                     float renderWidth,
                     int hAlign)

Description copied from interface: TextAnimation

Handles label resizing

getCharactersPerSecond

public float getCharactersPerSecond()

resetState

protected void resetState()

Specified by:

resetState in class BaseTextAnimation

getCurrentCharacterIndex

public int getCurrentCharacterIndex()

Returns the current index of the animation

Returns:

The index of the most recently displayed character