com.threerings.media.tile

Class TrimmedTileSet

java.lang.Object

com.threerings.media.tile.TileSet

com.threerings.media.tile.TrimmedTileSet

All Implemented Interfaces:

Serializable, Cloneable

public class TrimmedTileSet
extends TileSet

Contains the necessary information to create a set of trimmed tiles from a base image and the associated trim metrics.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.threerings.media.tile.TileSet

TileSet.Colorizer

Constructor Summary

Constructors

Constructor and Description
TrimmedTileSet()

Method Summary

Modifier and Type	Method and Description
Rectangle	computeTileBounds(int tileIndex, Rectangle bounds) Computes and fills in the bounds for the specified tile based on the mechanism used by the derived class to do such things.
int	getTileCount() Returns the number of tiles in the tileset.
static TrimmedTileSet	trimTileSet(TileSet source, OutputStream destImage) Convenience function to trim the tile set and save it using FastImageIO.
static TrimmedTileSet	trimTileSet(TileSet source, OutputStream destImage, String imgFormat) Creates a trimmed tileset from the supplied source tileset.

Methods inherited from class com.threerings.media.tile.TileSet

clone, clone, getImagePath, getName, getRawTileImage, getRawTileSetImage, getTile, getTile, getTile, getTileMirage, getTileMirage, getTileMirages, setImagePath, setImageProvider, setName, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TrimmedTileSet

public TrimmedTileSet()

Method Detail

getTileCount

public int getTileCount()

Description copied from class: TileSet

Returns the number of tiles in the tileset.

Specified by:

getTileCount in class TileSet

computeTileBounds

public Rectangle computeTileBounds(int tileIndex,
                                   Rectangle bounds)

Description copied from class: TileSet

Computes and fills in the bounds for the specified tile based on the mechanism used by the derived class to do such things. The width and height of the bounds should be the size of the tile image and the x and y offset should be the offset in the tileset image for the image data of the specified tile.

Specified by:

computeTileBounds in class TileSet

Parameters:

tileIndex - the index of the tile whose bounds are to be computed.

bounds - the rectangle object into which to fill the bounds.

Returns:

the rectangle passed into the bounds parameter.

trimTileSet

public static TrimmedTileSet trimTileSet(TileSet source,
                                         OutputStream destImage)
                                  throws IOException

Convenience function to trim the tile set and save it using FastImageIO.

Throws:

IOException

trimTileSet

public static TrimmedTileSet trimTileSet(TileSet source,
                                         OutputStream destImage,
                                         String imgFormat)
                                  throws IOException

Creates a trimmed tileset from the supplied source tileset. The image path must be set by hand to the appropriate path based on where the image data that is written to the destImage parameter is actually stored on the file system. The image format indicateds how the resulting image should be saved. If null, we save using FastImageIO See TileSetTrimmer.trimTileSet(com.threerings.media.tile.TileSet, java.io.OutputStream, com.threerings.media.tile.util.TileSetTrimmer.TrimMetricsReceiver) for further information.

Throws:

IOException