org.pepsoft.worldpainter

Class ReadOnlyTile

java.lang.Object

org.pepsoft.worldpainter.InstanceKeeper

org.pepsoft.worldpainter.Tile

org.pepsoft.worldpainter.ReadOnlyTile

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.pepsoft.util.undo.UndoListener

Direct Known Subclasses:

RODelegatingTile

public abstract class ReadOnlyTile
extends Tile

Abstract base class for a read-only tile. All methods that would make changes throw an UnsupportedOperationException. All methods concerning listeners, undo support, etc. do nothing.

See Also:

Serialized Form

Nested Class Summary

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

Tile.Listener, Tile.TileBuffer

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

InstanceKeeper.InstantiationListener<T>

Field Summary

Fields inherited from class org.pepsoft.worldpainter.Tile

bitLayerData, heightMap, layerData, tallHeightMap, tallWaterLevel, terrain, waterLevel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReadOnlyTile(int x, int y, int minHeight, int maxHeight, boolean init)

Method Summary

Modifier and Type	Method and Description
void	addListener(Tile.Listener listener)
void	bufferChanged(org.pepsoft.util.undo.BufferKey<?> key)
void	clearLayerData(int x, int y, java.util.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)
protected void	ensureReadable(Tile.TileBuffer buffer)
void	inhibitEvents() Stop firing events when the tile is modified, until Tile.releaseEvents() is invoked.
boolean	isEventsInhibited()
boolean	plantSeed(Seed seed)
void	redoPerformed()
void	register(org.pepsoft.util.undo.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, java.io.PrintStream out)
void	savePointArmed()
void	savePointCreated()
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)
java.lang.String	toString()
Tile	transform(CoordinateTransform transform) Create a new tile based on this one but horizontally transformed according to some transformation.
void	undoPerformed()
void	unregister()

Methods inherited from class org.pepsoft.worldpainter.Tile

containsOneOf, doGetLayers, doGetSlope, equals, getActiveLayers, getAllTerrains, getBitLayerCount, getBitLayerValue, getDistanceToEdge, getFloodedCount, getHeight, getHighestHeight, getHighestIntHeight, getHighestRawHeight, getHighestWaterLevel, getIntHeight, getLayers, getLayers, getLayersAt, getLayerValue, getLowestHeight, getLowestIntHeight, getLowestRawHeight, getMaxHeight, getMinHeight, getRawHeight, getRawHeightRange, getSeeds, getSlope, getTerrain, getWaterLevel, getX, getY, hashCode, hasLayer

Methods inherited from class org.pepsoft.worldpainter.InstanceKeeper

setInstantiationListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReadOnlyTile

protected ReadOnlyTile(int x,
                       int y,
                       int minHeight,
                       int maxHeight,
                       boolean init)

Method Detail

addListener

public final void addListener(Tile.Listener listener)

Overrides:

addListener in class Tile

unregister

public final void unregister()

Overrides:

unregister in class Tile

setMinMaxHeight

public final void setMinMaxHeight(int minHeight,
                                  int maxHeight,
                                  HeightTransform heightTransform)

Overrides:

setMinMaxHeight in class Tile

setRawHeight

public final void setRawHeight(int x,
                               int y,
                               int rawHeight)

Description copied from class: Tile

Set the raw height value. This is the height times 256 (for added precision) and zero-based rather than adjusted for minHeight.

Overrides:

setRawHeight in class Tile

clearLayerData

public final void clearLayerData(Layer layer)

Overrides:

clearLayerData in class Tile

clearLayerData

public final void clearLayerData(int x,
                                 int y,
                                 java.util.Set<Layer> excludedLayers)

Description copied from class: Tile

Clear all layer data at a particular location (by resetting to the layer's default value), possibly with the exception of certain layers.

Overrides:

clearLayerData in class Tile

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.

plantSeed

public final boolean plantSeed(Seed seed)

Overrides:

plantSeed in class Tile

removeSeed

public final void removeSeed(Seed seed)

Overrides:

removeSeed in class Tile

removeListener

public final void removeListener(Tile.Listener listener)

Overrides:

removeListener in class Tile

transform

public final Tile transform(CoordinateTransform transform)

Description copied from class: Tile

Create a new tile based on this one but horizontally transformed according to some transformation.

Overrides:

transform in class Tile

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,
                      java.io.PrintStream out)

Overrides:

repair in class Tile

savePointArmed

public final void savePointArmed()

Specified by:

savePointArmed in interface org.pepsoft.util.undo.UndoListener

Overrides:

savePointArmed in class Tile

savePointCreated

public final void savePointCreated()

Specified by:

savePointCreated in interface org.pepsoft.util.undo.UndoListener

Overrides:

savePointCreated in class Tile

undoPerformed

public final void undoPerformed()

Specified by:

undoPerformed in interface org.pepsoft.util.undo.UndoListener

Overrides:

undoPerformed in class Tile

redoPerformed

public final void redoPerformed()

Specified by:

redoPerformed in interface org.pepsoft.util.undo.UndoListener

Overrides:

redoPerformed in class Tile

bufferChanged

public final void bufferChanged(org.pepsoft.util.undo.BufferKey<?> key)

Specified by:

bufferChanged in interface org.pepsoft.util.undo.UndoListener

Overrides:

bufferChanged in class Tile

ensureReadable

protected final void ensureReadable(Tile.TileBuffer buffer)

Overrides:

ensureReadable in class Tile

isEventsInhibited

public final boolean isEventsInhibited()

Overrides:

isEventsInhibited in class Tile

register

public final void register(org.pepsoft.util.undo.UndoManager undoManager)

Overrides:

register in class Tile

setBitLayerValue

public final void setBitLayerValue(Layer layer,
                                   int x,
                                   int y,
                                   boolean value)

Overrides:

setBitLayerValue in class Tile

inhibitEvents

public final void inhibitEvents()

Description copied from class: Tile

Stop firing events when the tile is modified, until Tile.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().

Overrides:

inhibitEvents in class Tile

releaseEvents

public final void releaseEvents()

Description copied from class: Tile

Release an inhibition on firing events. Will fire all appropriate events at this time, if the tile was modified since the first invocation of Tile.inhibitEvents(), but only if this is the last invocation of releaseEvents() in a nested set.

Overrides:

releaseEvents in class Tile

setHeight

public final void setHeight(int x,
                            int y,
                            float height)

Overrides:

setHeight in class Tile

setLayerValue

public final void setLayerValue(Layer layer,
                                int x,
                                int y,
                                int value)

Overrides:

setLayerValue in class Tile

setTerrain

public final void setTerrain(int x,
                             int y,
                             Terrain terrain)

Overrides:

setTerrain in class Tile

setWaterLevel

public final void setWaterLevel(int x,
                                int y,
                                int waterLevel)

Overrides:

setWaterLevel in class Tile

toString

public java.lang.String toString()

Overrides:

toString in class Tile