org.mini2Dx.ui.animation.TextAnimation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mini2Dx-ui Show documentation
null
There is a newer version: 2.0.0-alpha.32
/**
 * Copyright (c) 2016 See AUTHORS file
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 * Neither the name of the mini2Dx nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.mini2Dx.ui.animation;

import org.mini2Dx.core.graphics.Graphics;
import org.mini2Dx.core.serialization.annotation.NonConcrete;
import org.mini2Dx.ui.listener.TextAnimationListener;

/**
 * Common interface for text animation implementations
 */
@NonConcrete
public interface TextAnimation {

	/**
	 * Update the animation
	 * @param text The target text to display
	 * @param delta The time since the last frame (in seconds)
	 */
	public void update(String text, float delta);
	
	/**
	 * Interpolate the animation
	 * @param text The target text to display
	 * @param alpha The interpolation alpha value
	 */
	public void interpolate(String text, float alpha);
	
	/**
	 * Renders the animation
	 * @param text The target text to display
	 * @param g The {@link Graphics} context
	 * @param renderX The render X coordinate
	 * @param renderY The render Y coordinate
	 * @param renderWidth The text render width
	 * @param hAlign The horizontal alignment of the text
	 */
	public void render(String text, Graphics g, float renderX, float renderY, float renderWidth, int hAlign);
	
	/**
	 * Sets the {@link TextAnimation} to be skipped
	 */
	public void skip();
	
	/**
	 * Returns if the {@link TextAnimation} has finished
	 * @return True if the animation has finished
	 */
	public boolean isFinished();
	
	/**
	 * Adds a {@link TextAnimationListener} to this {@link TextAnimation}
	 * @param listener The {@link TextAnimationListener} to be added
	 */
	public void addTextAnimationListener(TextAnimationListener listener);
	
	/**
	 * Removes a {@link TextAnimationListener} from this {@link TextAnimation}
	 * @param listener The {@link TextAnimationListener} to be removed
	 */
	public void removeTextAnimationListener(TextAnimationListener listener);
}