1 /*
2
3 dsh-piccolo-sprite Piccolo2D sprite nodes and supporting classes.
4 Copyright (c) 2006-2013 held jointly by the individual authors.
5
6 This library is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 3 of the License, or (at
9 your option) any later version.
10
11 This library is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
14 License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with this library; if not, write to the Free Software Foundation,
18 Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
19
20 > http://www.fsf.org/licensing/licenses/lgpl.html
21 > http://www.opensource.org/licenses/lgpl-license.php
22
23 */
24 package org.dishevelled.piccolo.sprite;
25
26 import java.awt.Image;
27
28 /**
29 * One or more images as frames in an animation.
30 *
31 * @author Michael Heuer
32 * @version $Revision$ $Date$
33 */
34 public interface Animation
35 {
36
37 /**
38 * Advance this animation one frame.
39 *
40 * @return true if consumers of this animation should schedule a repaint
41 */
42 boolean advance();
43
44 /**
45 * Return the current frame for this animation.
46 * The current frame will not be null.
47 *
48 * @return the current frame for this animation
49 */
50 Image getCurrentFrame();
51 }