Michael Bayne
a70efc3ffb
return a tile with an error image so that the caller doesn't freak out and we achieve maximal "continue to work as much as possible." git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3177 542714f4-19e9-0310-aa3c-eee0fc999fb1
65 lines
2.6 KiB
Java
65 lines
2.6 KiB
Java
//
|
|
// $Id: ImageProvider.java,v 1.5 2004/10/28 17:49:02 mdb Exp $
|
|
//
|
|
// 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);
|
|
}
|