narya/src/java/com/threerings/media/tile/UniformTileSet.java

//
// $Id: UniformTileSet.java,v 1.9 2002/06/19 08:27:35 mdb Exp $

package com.threerings.media.tile;

import java.awt.Image;
import java.awt.Rectangle;

import com.threerings.media.Log;
import com.threerings.media.util.ImageUtil;

/**
 * A uniform tileset is one that is composed of tiles that are all the
 * same width and height and are arranged into rows, with each row having
 * the same number of tiles except possibly the final row which can
 * contain the same as or less than the number of tiles contained by the
 * previous rows.
 */
public class UniformTileSet extends TileSet
{
    // documentation inherited
    public int getTileCount ()
    {
        return _count;
    }

    /**
     * Specifies the number of tiles that will be found in the tileset
     * image managed by this tileset.
     */
    public void setTileCount (int tileCount)
    {
        _count = tileCount;
    }

    /**
     * Specifies the width of the tiles in this tileset.
     */
    public void setWidth (int width)
    {
        _width = width;
    }

    /**
     * Returns the width of the tiles in this tileset.
     */
    public int getWidth ()
    {
        return _width;
    }

    /**
     * Specifies the height of the tiles in this tileset.
     */
    public void setHeight (int height)
    {
        _height = height;
    }

    /**
     * Returns the height of the tiles in this tileset.
     */
    public int getHeight ()
    {
        return _height;
    }

    /**
     * Returns the image that would be used by the tile at the specified
     * index. Because the uniform tileset is often used simply to provide
     * access to a collection of uniform images, this method is provided
     * to bypass the creation of a {@link Tile} object when all that is
     * desired is access to the underlying image.
     */
    public Image getTileImage (int tileIndex)
    {
        Image tsimg = getTileSetImage();
        if (tsimg == null) {
            return null;
        }
        Rectangle tb = computeTileBounds(tileIndex, tsimg);
        return ImageUtil.getSubimage(tsimg, tb.x, tb.y, tb.width, tb.height);
    }

    // documentation inherited
    protected Rectangle computeTileBounds (int tileIndex, Image tilesetImage)
    {
        // figure out from whence to crop the tile
        int tilesPerRow = tilesetImage.getWidth(null) / _width;
        int row = tileIndex / tilesPerRow;
        int col = tileIndex % tilesPerRow;

	// crop the tile-sized image chunk from the full image
        return new Rectangle(_width*col, _height*row, _width, _height);
    }

    // documentation inherited
    protected void toString (StringBuffer buf)
    {
        super.toString(buf);
	buf.append(", width=").append(_width);
	buf.append(", height=").append(_height);
    }

    /** The total number of tiles in this tileset. */
    protected int _count;

    /** The width (in pixels) of the tiles in this tileset. */
    protected int _width;

    /** The height (in pixels) of the tiles in this tileset. */
    protected int _height;
}