Application: gvSIG desktop » gvSIG 3D

package org.gvsig.animation3d.swing.api;

/**

 * 

 * @author <a href="mailto:lmarques@disid.com">Lluis Marques</a>

 *

 */

public interface Animator {

    /**

     * Iterates to the next value. The implementation is expected to apply that

     * next value to the property

     * it is attached to.

     */

    void next();

    /**

     * Starts the <code>Animator</code>. The implementation should return

     * <code>true</code> from <code>hasNext</code>

     */

    void start();

    /**

     * Stops the <code>Animator</code>. The implementation should return

     * <code>false</code> from <code>hasNext</code>

     */

    void stop();

    /**

     * Returns <code>true</code> if the <code>Animator</code> has more elements.

     *

     * @return <code>true</code> if the <code>Animator</code> has more elements.

     */

    boolean hasNext();

    /**

     * Set the value of the attached property to the value associated with this

     * interpolant value.

     * 

     * @param interpolant

     *            A value between 0 and 1.

     */

    void set(double interpolant);

}