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

//
// $Id: TileSet.java,v 1.11 2001/07/28 01:31:51 shaper Exp $

package com.threerings.miso.tile;

import java.awt.Image;
import java.awt.Point;
import java.awt.image.*;

import com.samskivert.util.StringUtil;
import com.threerings.miso.Log;
import com.threerings.media.ImageManager;

/**
 * A tileset stores information on a single logical set of tiles.  It
 * provides a clean interface for the TileManager to retrieve
 * individual tile images from a particular tile in the tileset.
 *
 * <p> Tiles are retrieved from the tile set by the TileManager, and
 * are referenced by their tile id (essentially the tile number,
 * assuming the tile at the top-left of the image is tile id 0 and
 * tiles are numbered left to right, top to bottom, in ascending
 * order.
 */
public class TileSet
{
    /**
     * Construct a new TileSet object with the given parameters.
     */
    public TileSet (String name, int tsid, String imgFile,
		    int[] rowWidth, int[] rowHeight, int[] tileCount,
                    Point offsetPos, Point gapDist)
    {
	_name = name;
	_tsid = tsid;
	_imgFile = imgFile;
        _rowWidth = rowWidth;
	_rowHeight = rowHeight;
	_tileCount = tileCount;
        _offsetPos = offsetPos;
        _gapDist = gapDist;

	// determine the total number of tiles in the set
	for (int ii = 0; ii < _tileCount.length; ii++)
	    _numTiles += _tileCount[ii];
    }

    /**
     * Return the tileset identifier.
     */
    public int getId ()
    {
	return _tsid;
    }

    /**
     * Return the tileset name.
     */
    public String getName ()
    {
	return _name;
    }

    /**
     * Return the number of tiles in the tileset.
     */
    public int getNumTiles ()
    {
	return _numTiles;
    }

    /**
     * Return the image corresponding to the specified tile id within
     * this tile set.
     */
    public Image getTileImage (ImageManager imgr, int tid)
    {
	// load the full tile image if we don't already have it
	if (_imgTiles == null) {
	    if ((_imgTiles = imgr.getImage(_imgFile)) == null) {
		Log.warning("Failed to retrieve full tileset image " +
			    "[file=" + _imgFile + "].");
		return null;
	    }
	}

	// find the row number containing the sought-after tile
	int ridx, tcount, ty, tx;
	ridx = tcount = 0;

        // start tile image position at image start offset
        tx = _offsetPos.x;
        ty = _offsetPos.y;

	while ((tcount += _tileCount[ridx]) < tid + 1) {
            // increment tile image position by row height and gap distance
	    ty += (_rowHeight[ridx++] + _gapDist.y);
	}

        // determine the horizontal index of this tile in the row
	int xidx = tid - (tcount - _tileCount[ridx]);

        // final image x-position is based on tile width and gap distance
        tx += (xidx * (_rowWidth[ridx] + _gapDist.x));

    	Log.info("Retrieving tile image [tid=" + tid + ", ridx=" +
    		 ridx + ", xidx=" + xidx + ", tx=" + tx +
    		 ", ty=" + ty + "].");

	// crop the tile-sized image chunk from the full image
	return imgr.getImageCropped(
            _imgTiles, tx, ty, _rowWidth[ridx], _rowHeight[ridx]);
    }

    /**
     * Return a string representation of the tileset information.
     */
    public String toString ()
    {
	StringBuffer buf = new StringBuffer();

	buf.append("[name=").append(_name);
	buf.append(", file=").append(_imgFile);
	buf.append(", tsid=").append(_tsid);
	buf.append(", numtiles=").append(_numTiles);

	buf.append(", rowwidth=");
	StringUtil.toString(buf, _rowWidth);

	buf.append(", rowheight=");
	StringUtil.toString(buf, _rowHeight);

	buf.append(", tilecount=");
	StringUtil.toString(buf, _tileCount);

        buf.append(", offsetpos=(").append(_offsetPos.x);
        buf.append(", ").append(_offsetPos.y).append(")");

        buf.append(", gapdist=(").append(_gapDist.x);
        buf.append(", ").append(_gapDist.y).append(")");

	return buf.append("]").toString();
    }

    /** The tileset name. */
    protected String _name;

    /** The file containing the tile images. */
    protected String _imgFile;

    /** The tileset unique identifier. */
    protected int _tsid;

    /** The width of the tiles in each row in pixels. */
    protected int _rowWidth[];

    /** The height of each row in pixels. */
    protected int _rowHeight[];

    /** The number of tiles in each row. */
    protected int _tileCount[];

    /**
     * The offset distance (x, y) in pixels from the top-left of the
     * image to the start of the first tile image.
     */
    protected Point _offsetPos;

    /**
     * The distance (x, y) in pixels between each tile in each row
     * horizontally, and between each row of tiles vertically.
     */
    protected Point _gapDist;

    /** The total number of tiles. */
    protected int _numTiles;

    /** The image containing all tile images for this set. */
    protected Image _imgTiles;
}