Tile

java.lang.Object
- org.pepsoft.worldpainter.InstanceKeeper
- - org.pepsoft.worldpainter.Tile

All Implemented Interfaces:

Serializable, Cloneable, UndoListener

Direct Known Subclasses:

RODelegatingTile, TileSnapshot
```
public class Tile
extends InstanceKeeper
implements Serializable, UndoListener, Cloneable
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Tile.Listener

static class Tile.TileBuffer
- Nested classes/interfaces inherited from class org.pepsoft.worldpainter.InstanceKeeper
  InstanceKeeper.InstantiationListener<T>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Tile.Listener`
`static class`	`Tile.TileBuffer`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<Layer,BitSet>`	`bitLayerData`
`protected short[]`	`heightMap`
`protected Map<Layer,byte[]>`	`layerData`
`protected int[]`	`tallHeightMap`
`protected short[]`	`tallWaterLevel`
`protected byte[]`	`terrain`
`protected byte[]`	`waterLevel`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Tile(int x, int y, int minHeight, int maxHeight)`
`protected`	`Tile(int x, int y, int minHeight, int maxHeight, boolean init)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(Tile.Listener listener)`
`void`	`bufferChanged(BufferKey<?> key)` A buffer has changed due to an undo or redo operation.
`void`	`clearLayerData(int x, int y, Set<Layer> excludedLayers)` Clear all layer data at a particular location (by resetting to the layer's default value), possibly with the exception of certain layers.
`void`	`clearLayerData(Layer layer)`
`boolean`	`containsOneOf(Layer... layers)`
`protected void`	`ensureReadable(Tile.TileBuffer buffer)`
`boolean`	`equals(Object obj)`
`List<Layer>`	`getActiveLayers(int x, int y)`
`Set<Terrain>`	`getAllTerrains()`
`int`	`getBitLayerCount(Layer layer, int x, int y, int r)` Count the number of blocks where the specified bit layer is set in a square around a particular location
`boolean`	`getBitLayerValue(Layer layer, int x, int y)`
`float`	`getDistanceToEdge(Layer layer, int x, int y, float maxDistance)`
`int`	`getFloodedCount(int x, int y, int r, boolean lava)` Count the number of blocks that are flooded in a square around a particular location
`float`	`getHeight(int x, int y)`
`int`	`getHighestIntHeight()`
`int`	`getIntHeight(int x, int y)`
`List<Layer>`	`getLayers()`
`List<Layer>`	`getLayers(Set<Layer> additionalLayers)` Get a list of all layers in use in the tile, as well as the set of additional layers provided, the total sorted by layer priority.
`Map<Layer,Integer>`	`getLayersAt(int x, int y)` Gets all layers that are set at the specified location, along with their intensities.
`int`	`getLayerValue(Layer layer, int x, int y)`
`int`	`getLowestIntHeight()`
`int`	`getMaxHeight()`
`int`	`getMinHeight()`
`int`	`getRawHeight(int x, int y)` Get the raw height value.
`HashSet<Seed>`	`getSeeds()`
`float`	`getSlope(int x, int y)`
`Terrain`	`getTerrain(int x, int y)`
`int`	`getWaterLevel(int x, int y)`
`int`	`getX()`
`int`	`getY()`
`int`	`hashCode()`
`boolean`	`hasLayer(Layer layer)`
`void`	`inhibitEvents()` Stop firing events when the tile is modified, until `releaseEvents()` is invoked.
`boolean`	`isEventsInhibited()`
`boolean`	`plantSeed(Seed seed)`
`void`	`redoPerformed()` A redo has been performed.
`void`	`register(UndoManager undoManager)`
`void`	`releaseEvents()` Release an inhibition on firing events.
`void`	`removeListener(Tile.Listener listener)`
`void`	`removeSeed(Seed seed)`
`boolean`	`repair(int minHeight, int maxHeight, PrintStream out)`
`void`	`savePointArmed()` A save point has been scheduled.
`void`	`savePointCreated()` A save point has been performed.
`void`	`setBitLayerValue(Layer layer, int x, int y, boolean value)`
`void`	`setHeight(int x, int y, float height)`
`void`	`setLayerValue(Layer layer, int x, int y, int value)`
`void`	`setMinMaxHeight(int minHeight, int maxHeight, HeightTransform heightTransform)`
`void`	`setRawHeight(int x, int y, int rawHeight)` Set the raw height value.
`void`	`setTerrain(int x, int y, Terrain terrain)`
`void`	`setWaterLevel(int x, int y, int waterLevel)`
`String`	`toString()`
`Tile`	`transform(CoordinateTransform transform)` Create a new tile based on this one but horizontally transformed according to some transformation.
`void`	`undoPerformed()` An undo has been performed.
`void`	`unregister()`

Methods inherited from class org.pepsoft.worldpainter.InstanceKeeper
setInstantiationListener

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - heightMap
```
protected short[] heightMap
```
  - tallHeightMap
```
protected int[] tallHeightMap
```
  - terrain
```
protected byte[] terrain
```
  - waterLevel
```
protected byte[] waterLevel
```
  - tallWaterLevel
```
protected short[] tallWaterLevel
```
  - layerData
```
protected Map<Layer,byte[]> layerData
```
  - bitLayerData
```
protected Map<Layer,BitSet> bitLayerData
```
- Constructor Detail
  - Tile
```
public Tile(int x,
            int y,
            int minHeight,
            int maxHeight)
```
  - Tile
```
protected Tile(int x,
               int y,
               int minHeight,
               int maxHeight,
               boolean init)
```
- Method Detail
  - getX
```
public int getX()
```
  - getY
```
public int getY()
```
  - getMinHeight
```
public int getMinHeight()
```
  - getMaxHeight
```
public int getMaxHeight()
```
  - setMinMaxHeight
```
public void setMinMaxHeight(int minHeight,
                            int maxHeight,
                            HeightTransform heightTransform)
```
  - getIntHeight
```
public int getIntHeight(int x,
                        int y)
```
  - getLowestIntHeight
```
public int getLowestIntHeight()
```
  - getHighestIntHeight
```
public int getHighestIntHeight()
```
  - getHeight
```
public float getHeight(int x,
                       int y)
```
  - setHeight
```
public void setHeight(int x,
                      int y,
                      float height)
```
  - getRawHeight
```
public int getRawHeight(int x,
                        int y)
```
    Get the raw height value. This is the height times 256 (for added precision) and zero-based rather than adjusted for minHeight.
  - setRawHeight
```
public void setRawHeight(int x,
                         int y,
                         int rawHeight)
```
    Set the raw height value. This is the height times 256 (for added precision) and zero-based rather than adjusted for minHeight.
  - getSlope
```
public float getSlope(int x,
                      int y)
```
  - getTerrain
```
public Terrain getTerrain(int x,
                          int y)
```
  - setTerrain
```
public void setTerrain(int x,
                       int y,
                       Terrain terrain)
```
  - getAllTerrains
```
public Set<Terrain> getAllTerrains()
```
  - getWaterLevel
```
public int getWaterLevel(int x,
                         int y)
```
  - setWaterLevel
```
public void setWaterLevel(int x,
                          int y,
                          int waterLevel)
```
  - getLayers
```
public List<Layer> getLayers()
```
  - hasLayer
```
public boolean hasLayer(Layer layer)
```
  - getActiveLayers
```
public List<Layer> getActiveLayers(int x,
                                   int y)
```
  - getLayers
```
public List<Layer> getLayers(Set<Layer> additionalLayers)
```
    Get a list of all layers in use in the tile, as well as the set of additional layers provided, the total sorted by layer priority.
    
    Parameters:
    
    additionalLayers - The additional layers to include in the list.
    
    Returns:
    
    The list of all layers provided or in use on the tile, sorted by layer priority.
  - getBitLayerValue
```
public boolean getBitLayerValue(Layer layer,
                                int x,
                                int y)
```
  - getBitLayerCount
```
public int getBitLayerCount(Layer layer,
                            int x,
                            int y,
                            int r)
```
    Count the number of blocks where the specified bit layer is set in a square around a particular location
    
    Parameters:
    
    layer - The bit layer to count.
    
    x - The X coordinate (local to the tile) of the location around which to count the layer.
    
    y - The Y coordinate (local to the tile) of the location around which to count the layer.
    
    r - The radius of the square.
    
    Returns:
    
    The number of blocks in the specified square where the specified bit layer is set.
  - getLayersAt
```
public Map<Layer,Integer> getLayersAt(int x,
                                      int y)
```
    Gets all layers that are set at the specified location, along with their intensities. For bit valued layers the intensity is zero for off, one for on.
    
    Parameters:
    
    x - The X location for which to retrieve all layers.
    
    y - The Y location for which to retrieve all layers.
    
    Returns:
    
    A map with all layers set at the specified location, mapped to their intensities at that location. May either be null or an empty map if no layers are present.
  - getFloodedCount
```
public int getFloodedCount(int x,
                           int y,
                           int r,
                           boolean lava)
```
    Count the number of blocks that are flooded in a square around a particular location
    
    Parameters:
    
    x - The X coordinate (local to the tile) of the location around which to count flooded blocks.
    
    y - The Y coordinate (local to the tile) of the location around which to count flooded blocks.
    
    r - The radius of the square.
    
    lava - Whether to check for lava (when true) or water (when false).
    
    Returns:
    
    The number of blocks in the specified square that are flooded.
  - getDistanceToEdge
```
public float getDistanceToEdge(Layer layer,
                               int x,
                               int y,
                               float maxDistance)
```
  - setBitLayerValue
```
public void setBitLayerValue(Layer layer,
                             int x,
                             int y,
                             boolean value)
```
  - getLayerValue
```
public int getLayerValue(Layer layer,
                         int x,
                         int y)
```
  - setLayerValue
```
public void setLayerValue(Layer layer,
                          int x,
                          int y,
                          int value)
```
  - clearLayerData
```
public void clearLayerData(Layer layer)
```
  - clearLayerData
```
public void clearLayerData(int x,
                           int y,
                           Set<Layer> excludedLayers)
```
    Clear all layer data at a particular location (by resetting to the layer's default value), possibly with the exception of certain layers.
    
    Parameters:
    
    x - The X coordinate of the location to clear of layer data.
    
    y - The Y coordinate of the location to clear of layer data.
    
    excludedLayers - The layers to exclude, if any. May be null.
  - getSeeds
```
public HashSet<Seed> getSeeds()
```
  - plantSeed
```
public boolean plantSeed(Seed seed)
```
  - removeSeed
```
public void removeSeed(Seed seed)
```
  - addListener
```
public void addListener(Tile.Listener listener)
```
  - removeListener
```
public void removeListener(Tile.Listener listener)
```
  - isEventsInhibited
```
public boolean isEventsInhibited()
```
  - inhibitEvents
```
public void inhibitEvents()
```
    Stop firing events when the tile is modified, until releaseEvents() is invoked. Make sure that releaseEvents() is always invoked, even if an exception is thrown, by using a try-finally statement:
    tile.inhibitEvents(); try { // modify the tile } finally { tile.releaseEvents(); }
    Note that calls to these methods may be nested, and if so, events will only be released after the final invocation of releaseEvents().
  - releaseEvents
```
public void releaseEvents()
```
    Release an inhibition on firing events. Will fire all appropriate events at this time, if the tile was modified since the first invocation of inhibitEvents(), but only if this is the last invocation of releaseEvents() in a nested set.
  - register
```
public void register(UndoManager undoManager)
```
  - unregister
```
public void unregister()
```
  - transform
```
public Tile transform(CoordinateTransform transform)
```
    Create a new tile based on this one but horizontally transformed according to some transformation.
    
    Parameters:
    
    transform - The transform to apply.
    
    Returns:
    
    A new tile with the same contents, except transformed according to the specified transform (including the X and Y coordinates).
  - repair
```
public boolean repair(int minHeight,
                      int maxHeight,
                      PrintStream out)
```
  - containsOneOf
```
public boolean containsOneOf(Layer... layers)
```
  - savePointArmed
```
public void savePointArmed()
```
    Description copied from interface: UndoListener
    
    A save point has been scheduled. The listener should re-get all its buffers when it wants to edit them.
    
    Specified by:
    
    savePointArmed in interface UndoListener
  - savePointCreated
```
public void savePointCreated()
```
    Description copied from interface: UndoListener
    
    A save point has been performed. The listener should re-get all its buffers when it wants to edit them.
    
    Specified by:
    
    savePointCreated in interface UndoListener
  - undoPerformed
```
public void undoPerformed()
```
    Description copied from interface: UndoListener
    
    An undo has been performed.
    
    Specified by:
    
    undoPerformed in interface UndoListener
  - redoPerformed
```
public void redoPerformed()
```
    Description copied from interface: UndoListener
    
    A redo has been performed.
    
    Specified by:
    
    redoPerformed in interface UndoListener
  - bufferChanged
```
public void bufferChanged(BufferKey<?> key)
```
    Description copied from interface: UndoListener
    
    A buffer has changed due to an undo or redo operation. The listener should re-get it.
    
    Specified by:
    
    bufferChanged in interface UndoListener
    
    Parameters:
    
    key - The key of the buffer that has changed.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - ensureReadable
```
protected void ensureReadable(Tile.TileBuffer buffer)
```

Class Tile

Nested Class Summary

Nested classes/interfaces inherited from class org.pepsoft.worldpainter.InstanceKeeper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.pepsoft.worldpainter.InstanceKeeper

Methods inherited from class java.lang.Object

Field Detail

heightMap

tallHeightMap

terrain

waterLevel

tallWaterLevel

layerData

bitLayerData

Constructor Detail

Tile

Tile

Method Detail

getX

getY

getMinHeight

getMaxHeight

setMinMaxHeight

getIntHeight

getLowestIntHeight

getHighestIntHeight

getHeight

setHeight

getRawHeight

setRawHeight

getSlope

getTerrain

setTerrain

getAllTerrains

getWaterLevel

setWaterLevel

getLayers

hasLayer

getActiveLayers

getLayers

getBitLayerValue

getBitLayerCount

getLayersAt

getFloodedCount

getDistanceToEdge

setBitLayerValue

getLayerValue

setLayerValue

clearLayerData

clearLayerData

getSeeds

plantSeed

removeSeed

addListener

removeListener

isEventsInhibited

inhibitEvents

releaseEvents

register

unregister

transform

repair

containsOneOf

savePointArmed

savePointCreated

undoPerformed

redoPerformed

bufferChanged

equals

hashCode

toString

ensureReadable