Behold, Nenya, Ring of Water and repository for our media and animation related

goodies, both Java 2D and LWJGL/JME 3D. git-svn-id: svn+ssh://src.earth.threerings.net/nenya/trunk@1 ed5b42cb-e716-0410-a449-f6a68f950b19
2006-06-23 18:07:28 +00:00
commit c2117ee86d
570 changed files with 61913 additions and 0 deletions
@@ -0,0 +1,58 @@
+//
+// $Id: MultiFrameImage.java 4191 2006-06-13 22:42:20Z ray $
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
+// http://www.threerings.net/code/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.media.util;
+
+import java.awt.Graphics2D;
+
+/**
+ * The multi-frame image interface provides encapsulated access to a set
+ * of images that are used to create a multi-frame animation.
+ */
+public interface MultiFrameImage
+{
+    /**
+     * Returns the number of frames in this multi-frame image.
+     */
+    public int getFrameCount ();
+
+    /**
+     * Returns the width of the specified frame image.
+     */
+    public int getWidth (int index);
+
+    /**
+     * Returns the height of the specified frame image.
+     */
+    public int getHeight (int index);
+
+    /**
+     * Renders the specified frame into the specified graphics object at
+     * the specified coordinates.
+     */
+    public void paintFrame (Graphics2D g, int index, int x, int y);
+
+    /**
+     * Returns true if the specified frame contains a non-transparent
+     * pixel at the specified coordinates.
+     */
+    public boolean hitTest (int index, int x, int y);
+}