org.mini2Dx.ui.animation

Interface TextAnimation

All Known Implementing Classes:

BaseTextAnimation, NullTextAnimation, TypingTextAnimation

public interface TextAnimation

Common interface for text animation implementations

Method Summary

Modifier and Type	Method and Description
void	addTextAnimationListener(TextAnimationListener listener) Adds a TextAnimationListener to this TextAnimation
void	interpolate(GameFontCache cache, java.lang.String text, float alpha) Interpolate the animation
boolean	isFinished() Returns if the TextAnimation has finished
void	onResize(GameFontCache cache, java.lang.String text, float renderWidth, int hAlign) Handles label resizing
void	removeTextAnimationListener(TextAnimationListener listener) Removes a TextAnimationListener from this TextAnimation
void	render(GameFontCache cache, Graphics g, int renderX, int renderY) Renders the animation
void	reset() Resets the animation
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

Method Detail

update

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

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)

interpolate

void interpolate(GameFontCache cache,
                 java.lang.String text,
                 float alpha)

Interpolate the animation

Parameters:

cache - The GameFontCache to use to render the text

text - The target text to display

alpha - The interpolation alpha value

render

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

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

void skip()

Sets the TextAnimation to be skipped

isFinished

boolean isFinished()

Returns if the TextAnimation has finished

Returns:

True if the animation has finished

reset

void reset()

Resets the animation

onResize

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

Handles label resizing

addTextAnimationListener

void addTextAnimationListener(TextAnimationListener listener)

Adds a TextAnimationListener to this TextAnimation

Parameters:

listener - The TextAnimationListener to be added

removeTextAnimationListener

void removeTextAnimationListener(TextAnimationListener listener)

Removes a TextAnimationListener from this TextAnimation

Parameters:

listener - The TextAnimationListener to be removed