View Javadoc

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   * Single frame animation.
30   *
31   * @author  Michael Heuer
32   * @version $Revision$ $Date$
33   */
34  public final class SingleFrameAnimation
35      implements Animation
36  {
37      /** Current frame. */
38      private final Image currentFrame;
39  
40  
41      /**
42       * Create a new single frame animation with the
43       * specified current frame.
44       *
45       * @param currentFrame current frame, must not be null
46       */
47      public SingleFrameAnimation(final Image currentFrame)
48      {
49          if (currentFrame == null)
50          {
51              throw new IllegalArgumentException("currentFrame must not be null");
52          }
53          this.currentFrame = currentFrame;
54      }
55  
56  
57      @Override
58      public boolean advance()
59      {
60          return false;
61      }
62  
63      @Override
64      public Image getCurrentFrame()
65      {
66          return currentFrame;
67      }
68  }