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,64 @@
+//
+// $Id: ImageProvider.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.tile;
+
+import java.awt.Rectangle;
+import java.awt.image.BufferedImage;
+
+import com.threerings.media.image.Colorization;
+import com.threerings.media.image.ImageManager;
+import com.threerings.media.image.Mirage;
+
+/**
+ * Provides a generic interface via which tileset images may be loaded. In
+ * most cases, a running application will want to obtain images via the
+ * {@link ImageManager}, but in some circumstances a simpler image
+ * provider may be desirable to avoid the overhead of the image manager
+ * infrastructure when simple image loading is all that is desired.
+ */
+public interface ImageProvider
+{
+    /**
+     * Returns the raw tileset image with the specified path.
+     *
+     * @param path the path that identifies the desired image (corresponds
+     * to the image path from the tileset).
+     * @param zations if non-null, colorizations to apply to the source
+     * image before returning it.
+     */
+    public BufferedImage getTileSetImage (String path, Colorization[] zations);
+
+    /**
+     * Obtains the tile image with the specified path in the form of a
+     * {@link Mirage}. It should be cropped from the tileset image
+     * identified by the supplied path.
+     *
+     * @param path the path that identifies the desired image (corresponds
+     * to the image path from the tileset).
+     * @param bounds if non-null, the region of the image to be returned
+     * as a mirage. If null, the entire image should be returned.
+     * @param zations if non-null, colorizations to apply to the image
+     * before converting it into a mirage.
+     */
+    public Mirage getTileImage (String path, Rectangle bounds,
+                                Colorization[] zations);
+}