TileSet (Nenya Core 1.6.1 API)

java.lang.Object
- com.threerings.media.tile.TileSet

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

SwissArmyTileSet, TrimmedObjectTileSet, TrimmedTileSet, UniformTileSet
```
public abstract class TileSet
extends Object
implements Cloneable, Serializable
```
A tileset stores information on a single logical set of tiles. It provides a clean interface for the TileManager or other entities to retrieve individual tiles from the tile set and encapsulates the potentially sophisticated process of extracting the tile image from a composite tileset image.
Tiles are referenced by their tile id. The tile id is essentially the tile number, assuming the tile at the top-left of the image is tile id zero and tiles are numbered, in ascending order, left to right, top to bottom.
This class is serializable and will be serialized, so derived classes should be sure to mark non-persistent fields as transient.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TileSet.Colorizer
Used to assign colorizations to tiles that require them.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TileSet.Colorizer` Used to assign colorizations to tiles that require them.

Constructor Summary

Constructors
Constructor and Description

TileSet()

Constructors
Constructor and Description
`TileSet()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`TileSet`	`clone(Colorization[] zations)` Creates a copy of this tileset which will apply the supplied colorizations to its tileset image when creating tiles.
`TileSet`	`clone(String imagePath)` Returns a new tileset that is a clone of this tileset with the image path updated to reference the given path.
`abstract 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.
`String`	`getImagePath()` Returns the path to the composite image used by this tileset.
`String`	`getName()` Returns the tileset name.
`BufferedImage`	`getRawTileImage(int tileIndex)` Returns the raw (unprepared) image that would be used by the tile at the specified index.
`BufferedImage`	`getRawTileSetImage()` Returns the entire, raw, uncut, unprepared tileset source image.
`Tile`	`getTile(int tileIndex)` Equivalent to `getTile(int,Colorizer)` with a null `Colorizer` argument.
`Tile`	`getTile(int tileIndex, Colorization[] zations)` Creates a `Tile` object from this tileset corresponding to the specified tile id and returns that tile.
`Tile`	`getTile(int tileIndex, TileSet.Colorizer rizer)` Creates a `Tile` object from this tileset corresponding to the specified tile id and returns that tile.
`abstract int`	`getTileCount()` Returns the number of tiles in the tileset.
`Mirage`	`getTileMirage(int tileIndex)` Returns a prepared version of the image that would be used by the tile at the specified index.
`Mirage`	`getTileMirage(int tileIndex, Colorization[] zations)` Returns a prepared version of the image that would be used by the tile at the specified index.
`Mirage[]`	`getTileMirages()` Returns prepared versions of the images that would be used for each of the tiles.
`void`	`setImagePath(String imagePath)` Sets the path to the image that will be used by this tileset.
`void`	`setImageProvider(ImageProvider improv)` Configures this tileset with an image provider that it can use to load its tileset image.
`void`	`setName(String name)` Specifies the tileset name.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TileSet
```
public TileSet()
```
- Method Detail
  - setImageProvider
```
public void setImageProvider(ImageProvider improv)
```
    Configures this tileset with an image provider that it can use to load its tileset image. This will be called automatically when the tileset is fetched via the TileManager.
  - getName
```
public String getName()
```
    Returns the tileset name.
  - setName
```
public void setName(String name)
```
    Specifies the tileset name.
  - setImagePath
```
public void setImagePath(String imagePath)
```
    Sets the path to the image that will be used by this tileset. This must be called before the first call to getTile(int).
  - getImagePath
```
public String getImagePath()
```
    Returns the path to the composite image used by this tileset.
  - getTileCount
```
public abstract int getTileCount()
```
    Returns the number of tiles in the tileset.
  - clone
```
public TileSet clone(Colorization[] zations)
```
    Creates a copy of this tileset which will apply the supplied colorizations to its tileset image when creating tiles.
  - clone
```
public TileSet clone(String imagePath)
              throws CloneNotSupportedException
```
    Returns a new tileset that is a clone of this tileset with the image path updated to reference the given path. Useful for configuring a single tileset and then generating additional tilesets with new images with the same configuration.
    
    Throws:
    
    CloneNotSupportedException
  - computeTileBounds
```
public abstract 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. 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.
    
    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.
  - getTile
```
public Tile getTile(int tileIndex)
```
    Equivalent to getTile(int,Colorizer) with a null Colorizer argument.
  - getTile
```
public Tile getTile(int tileIndex,
                    TileSet.Colorizer rizer)
```
    Creates a Tile object from this tileset corresponding to the specified tile id and returns that tile. A null tile will never be returned, but one with an error image may be returned if a problem occurs loading the underlying tileset image.
    
    Parameters:
    
    tileIndex - the index of the tile in the tileset. Tile indexes start with zero as the upper left tile and increase by one as the tiles move left to right and top to bottom over the source image.
    
    rizer - an entity that will be used to obtain colorizations for tilesets that are recolorizable. Passing null if the tileset is known not to be recolorizable is valid.
    
    Returns:
    
    the tile object.
  - getTile
```
public Tile getTile(int tileIndex,
                    Colorization[] zations)
```
    Creates a Tile object from this tileset corresponding to the specified tile id and returns that tile. A null tile will never be returned, but one with an error image may be returned if a problem occurs loading the underlying tileset image.
    
    Parameters:
    
    tileIndex - the index of the tile in the tileset. Tile indexes start with zero as the upper left tile and increase by one as the tiles move left to right and top to bottom over the source image.
    
    zations - colorizations to be applied to the tile image prior to returning it. These may be null for uncolorized images.
    
    Returns:
    
    the tile object.
  - getTileMirage
```
public Mirage getTileMirage(int tileIndex)
```
    Returns a prepared version of the image that would be used by the tile at the specified index. Because tilesets are often used simply to provide access to a collection of uniform images, this method is provided to bypass the creation of a Tile object when all that is desired is access to the underlying image.
  - getTileMirages
```
public Mirage[] getTileMirages()
```
    Returns prepared versions of the images that would be used for each of the tiles. Because tilesets are often used simply to provide access to a collection of uniform images, this method is provided to bypass the creation of a Tile objects when all that is desired is access to the underlying images.
  - getTileMirage
```
public Mirage getTileMirage(int tileIndex,
                            Colorization[] zations)
```
    Returns a prepared version of the image that would be used by the tile at the specified index. Because tilesets are often used simply to provide access to a collection of uniform images, this method is provided to bypass the creation of a Tile object when all that is desired is access to the underlying image.
  - getRawTileSetImage
```
public BufferedImage getRawTileSetImage()
```
    Returns the entire, raw, uncut, unprepared tileset source image. Don't use this method unless you know what you're doing! This image should not be rendered directly to the screen, you should obtain a tile (getTile(int)), or a tile mirage (getTileMirage(int)).
  - getRawTileImage
```
public BufferedImage getRawTileImage(int tileIndex)
```
    Returns the raw (unprepared) image that would be used by the tile at the specified index. Don't use this method unless you know what you're doing! If you're going to be painting this image onto the screen directly, use getTileMirage(int) because that prepares the image for display. Only use this if you're going to do further processing and prepare the subsequent image for display onscreen.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TileSet

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TileSet

Method Detail

setImageProvider

getName

setName

setImagePath

getImagePath

getTileCount

clone

clone

computeTileBounds

getTile

getTile

getTile

getTileMirage

getTileMirages

getTileMirage

getRawTileSetImage

getRawTileImage

toString