com.threerings.media.tile

Class TrimmedObjectTileSet

java.lang.Object

com.threerings.media.tile.TileSet

com.threerings.media.tile.TrimmedObjectTileSet

All Implemented Interfaces:

BaseSizableTileSet, RecolorableTileSet, Serializable, Cloneable

public class TrimmedObjectTileSet
extends TileSet
implements RecolorableTileSet, BaseSizableTileSet

An object tileset in which the objects have been trimmed to the smallest possible images that still contain all of their non-transparent pixels. The objects' origins are adjusted so that the objects otherwise behave exactly as the untrimmed objects and are thus interchangeable (and more memory efficient).

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
TrimmedObjectTileSet()

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	getBaseHeight(int tileIdx) Returns the base height for the specified object index.
int	getBaseWidth(int tileIdx) Returns the base width for the specified object index.
String[]	getColorizations() Returns the colorization classes that should be used to recolor objects in this tileset.
String[]	getConstraints(int tileIdx) Returns the constraints associated with the specified tile index, or null if the object has no associated constraints.
int	getSpotOrient(int tileIdx) Returns the orientation of the spot associated with the specified tile index, or -1 if the object has no associated spot.
int	getTileCount() Returns the number of tiles in the tileset.
int	getXSpot(int tileIdx) Returns the x coordinate of the spot associated with the specified tile index.
int	getYSpot(int tileIdx) Returns the y coordinate of the spot associated with the specified tile index.
boolean	hasConstraint(int tileIdx, String constraint) Checks whether the tile at the specified index has the given constraint.
static TrimmedObjectTileSet	trimObjectTileSet(ObjectTileSet source, OutputStream destImage) Convenience function to trim the tile set to a file using FastImageIO.
static TrimmedObjectTileSet	trimObjectTileSet(ObjectTileSet source, OutputStream destImage, String imgFormat) Creates a trimmed object tileset from the supplied source object 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

TrimmedObjectTileSet

public TrimmedObjectTileSet()

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.

getXSpot

public int getXSpot(int tileIdx)

Returns the x coordinate of the spot associated with the specified tile index.

getYSpot

public int getYSpot(int tileIdx)

Returns the y coordinate of the spot associated with the specified tile index.

getSpotOrient

public int getSpotOrient(int tileIdx)

Returns the orientation of the spot associated with the specified tile index, or -1 if the object has no associated spot.

getConstraints

public String[] getConstraints(int tileIdx)

Returns the constraints associated with the specified tile index, or null if the object has no associated constraints.

hasConstraint

public boolean hasConstraint(int tileIdx,
                             String constraint)

Checks whether the tile at the specified index has the given constraint.

getColorizations

public String[] getColorizations()

Description copied from interface: RecolorableTileSet

Returns the colorization classes that should be used to recolor objects in this tileset.

Specified by:

getColorizations in interface RecolorableTileSet

getBaseWidth

public int getBaseWidth(int tileIdx)

Returns the base width for the specified object index.

Specified by:

getBaseWidth in interface BaseSizableTileSet

getBaseHeight

public int getBaseHeight(int tileIdx)

Returns the base height for the specified object index.

Specified by:

getBaseHeight in interface BaseSizableTileSet

trimObjectTileSet

public static TrimmedObjectTileSet trimObjectTileSet(ObjectTileSet source,
                                                     OutputStream destImage)
                                              throws IOException

Convenience function to trim the tile set to a file using FastImageIO.

Throws:

IOException

trimObjectTileSet

public static TrimmedObjectTileSet trimObjectTileSet(ObjectTileSet source,
                                                     OutputStream destImage,
                                                     String imgFormat)
                                              throws IOException

Creates a trimmed object tileset from the supplied source object 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. If imgFormat is null, uses FastImageIO to save the file. See TileSetTrimmer.trimTileSet(com.threerings.media.tile.TileSet, java.io.OutputStream, com.threerings.media.tile.util.TileSetTrimmer.TrimMetricsReceiver) for further information.

Throws:

IOException