Dimension

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Tile.Listener, TileProvider

Direct Known Subclasses:

DimensionSnapshot, RODelegatingDimension
```
public class Dimension
extends InstanceKeeper
implements TileProvider, java.io.Serializable, Tile.Listener, java.lang.Cloneable
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Dimension.Anchor`
`static class`	`Dimension.Border`
`static class`	`Dimension.LayerAnchor`
`static interface`	`Dimension.Listener`
`static class`	`Dimension.Role` A role of a `Dimension` within a game dimension.
`class`	`Dimension.TileVisitationBuilder`
`static interface`	`Dimension.TileVisitor`
`static class`	`Dimension.WallType`

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

Field Summary

Fields
Modifier and Type Field and Description

static int[] POSSIBLE_AUTO_BIOMES

Fields
Modifier and Type	Field and Description
`static int[]`	`POSSIBLE_AUTO_BIOMES`

Constructor Summary

Constructors
Constructor and Description
`Dimension(World2 world, java.lang.String name, long minecraftSeed, TileFactory tileFactory, Dimension.Anchor anchor)`
`Dimension(World2 world, java.lang.String name, long minecraftSeed, TileFactory tileFactory, Dimension.Anchor anchor, boolean init)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDimensionListener(Dimension.Listener listener)`
`int`	`addOverlay(Overlay overlay)`
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)`
`void`	`addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)`
`void`	`addTile(Tile tile)`
`void`	`allBitLayerDataChanged(Tile tile)`
`void`	`allNonBitlayerDataChanged(Tile tile)`
`void`	`applyTheme(int x, int y)`
`void`	`applyTheme(java.awt.Point coords)`
`void`	`armSavePoint()`
`void`	`changed()` Update the change number; for use when some aspect of a dimension changes which the `Dimension` class itself does not track.
`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)`
`void`	`clearRedo()`
`void`	`clearUndo()`
`boolean`	`containsOneOf(Layer... layers)`
`protected float`	`doGetDistanceToEdge(Layer layer, int x, int y, float maxDistance)`
`protected int`	`doGetFloodedCount(int x, int y, int r, boolean lava)`
`protected float`	`doGetSlope(int x, int y)`
`java.util.Set<Layer>`	`getAllLayers(boolean applyCombinedLayers)` Returns the set of all layers currently in use on the world, optionally including layers that are included in combined layers.
`java.util.Map<Layer,ExporterSettings>`	`getAllLayerSettings()`
`java.util.Set<Terrain>`	`getAllTerrains()`
`Dimension.Anchor`	`getAnchor()`
`<T> T`	`getAttribute(org.pepsoft.util.AttributeKey<T> key)`
`int`	`getAutoBiome(int x, int y)`
`int`	`getAutoBiome(int x, int y, int defaultBiome)`
`int`	`getAutoBiome(Tile tile, int x, int y)`
`int`	`getAutoBiome(Tile tile, int x, int y, int defaultBiome)`
`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`	`getBitLayerValueAt(Layer layer, int x, int y)`
`Dimension.Border`	`getBorder()`
`int`	`getBorderLevel()`
`int`	`getBorderSize()`
`int`	`getCeilingHeight()`
`long`	`getChangeNo()` Get the change number.
`int`	`getContourSeparation()`
`java.util.List<CustomBiome>`	`getCustomBiomes()`
`java.util.List<CustomLayer>`	`getCustomLayers()`
`java.util.List<CustomLayer>`	`getCustomLayers(boolean applyCombinedLayers)`
`HeightMap`	`getDistancesToEdge(Layer layer, float maxDistance)` Bake the edge distances for an entire painted layer and return them as a `HeightMap`.
`float`	`getDistanceToEdge(Layer layer, int x, int y, float maxDistance)` Get the distance from the specified coordinate to the nearest pixel where the specified layer is not set.
`ExportSettings`	`getExportSettings()`
`java.awt.Rectangle`	`getExtent()`
`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
`Garden`	`getGarden()`
`MapGenerator`	`getGenerator()`
`int`	`getGridSize()`
`int`	`getHeight()`
`float`	`getHeightAt(int x, int y)` Get the terrain height at the specified coordinates, if a tile exists in the specified location.
`float`	`getHeightAt(java.awt.Point coords)` Get the terrain height at the specified coordinates, if a tile exists in the specified location.
`float[]`	`getHeightRange()`
`java.util.Set<java.lang.String>`	`getHiddenPalettes()`
`float`	`getHighestHeight()`
`int`	`getHighestIntHeight()`
`int`	`getHighestRawHeight()`
`int`	`getHighestX()`
`int`	`getHighestY()`
`java.util.UUID`	`getId()`
`int`	`getIntHeightAt(int x, int y)` Get the terrain height at the specified coordinates, rounded to the nearest integer, if a tile exists in the specified location.
`int`	`getIntHeightAt(int x, int y, int defaultHeight)` Get the terrain height at the specified coordinates, rounded to the nearest integer, if a tile exists in the specified location.
`int`	`getIntHeightAt(java.awt.Point coords)` Get the terrain height at the specified coordinates, rounded to the nearest integer, if a tile exists in the specified location.
`int[]`	`getIntHeightRange()`
`java.awt.Point`	`getLastViewPosition()`
`java.util.Map<Layer,java.lang.Integer>`	`getLayersAt(int x, int y)` Gets all layers that are set at the specified location, along with their intensities or values.
`ExporterSettings`	`getLayerSettings(Layer layer)`
`int`	`getLayerValueAt(Layer layer, int x, int y)`
`int`	`getLayerValueAt(Layer layer, java.awt.Point coords)`
`float`	`getLowestHeight()`
`int`	`getLowestIntHeight()`
`int`	`getLowestRawHeight()`
`int`	`getLowestX()`
`int`	`getLowestY()`
`int`	`getMaxHeight()`
`long`	`getMinecraftSeed()`
`int`	`getMinHeight()`
`java.util.Set<Layer>`	`getMinimumLayers()` Get the set of layers that has been configured to be applied everywhere.
`int`	`getMostPrevalentBiome(int x, int y, int defaultBiome)` Get the most prevalent biome in a 4x4 area.
`java.lang.String`	`getName()`
`java.util.List<Overlay>`	`getOverlays()`
`int`	`getRawHeightAt(int x, int y)` Get the raw height value.
`int`	`getRawHeightAt(java.awt.Point coords)` Get the raw height value.
`int[]`	`getRawHeightRange()`
`Dimension.WallType`	`getRoofType()`
`float`	`getScale()`
`long`	`getSeed()`
`float`	`getSlope(int x, int y)`
`Dimension`	`getSnapshot()` Get a snapshot of the current state of this dimension.
`java.lang.String`	`getSoloedPalette()`
`Dimension.LayerAnchor`	`getSubsurfaceLayerAnchor()`
`Terrain`	`getSubsurfaceMaterial()`
`Terrain`	`getTerrainAt(int x, int y)`
`Tile`	`getTile(int x, int y)` Get the tile for a particular set of world or absolute block coordinates.
`Tile`	`getTile(java.awt.Point coords)`
`java.util.Set<java.awt.Point>`	`getTileCoords()`
`int`	`getTileCount()`
`TileFactory`	`getTileFactory()`
`Tile`	`getTileForEditing(int x, int y)` Get the tile for a particular set of world or absolute block coordinates with the intention of modifying it.
`Tile`	`getTileForEditing(java.awt.Point coords)` Get the tile for a particular set of world or absolute block coordinates with the intention of modifying it.
`java.util.Collection<? extends Tile>`	`getTiles()` Get a collection of all extant tiles in the dimension.
`Dimension.LayerAnchor`	`getTopLayerAnchor()`
`int`	`getTopLayerDepth(int x, int y, int z)`
`int`	`getTopLayerMinDepth()`
`int`	`getTopLayerVariation()`
`java.lang.Integer`	`getUndergroundBiome()`
`Dimension.WallType`	`getWallType()`
`int`	`getWaterLevelAt(int x, int y)`
`int`	`getWaterLevelAt(java.awt.Point coords)`
`int`	`getWidth()`
`World2`	`getWorld()`
`void`	`heightMapChanged(Tile tile)`
`boolean`	`isBorderTile(int x, int y)` Indicates whether the specified tile is a border tile.
`boolean`	`isBottomless()`
`boolean`	`isContoursEnabled()`
`boolean`	`isCoverSteepTerrain()`
`boolean`	`isEventsInhibited()`
`boolean`	`isFixOverlayCoords()`
`boolean`	`isGridEnabled()`
`boolean`	`isOverlaysEnabled()`
`boolean`	`isPopulate()`
`boolean`	`isTilePresent(int x, int y)` Determines whether a tile is present in the dimension on specific coordinates.
`boolean`	`isUndoAvailable()`
`void`	`layerDataChanged(Tile tile, java.util.Set<Layer> changedLayers)`
`void`	`registerUndoManager(org.pepsoft.util.undo.UndoManager undoManager)`
`void`	`rememberChanges()`
`void`	`removeDimensionListener(Dimension.Listener listener)`
`void`	`removeOverlay(int index)`
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)`
`void`	`removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)`
`void`	`removeTile(int tileX, int tileY)`
`void`	`removeTile(java.awt.Point coords)`
`void`	`removeTile(Tile tile)`
`void`	`save(java.util.zip.ZipOutputStream out)`
`void`	`seedsChanged(Tile tile)`
`<T> void`	`setAttribute(org.pepsoft.util.AttributeKey<T> key, T value)`
`void`	`setBitLayerValueAt(Layer layer, int x, int y, boolean value)`
`void`	`setBorder(Dimension.Border border)`
`void`	`setBorderLevel(int borderLevel)`
`void`	`setBorderSize(int borderSize)`
`void`	`setBottomless(boolean bottomless)`
`void`	`setCeilingHeight(int ceilingHeight)`
`void`	`setContoursEnabled(boolean contoursEnabled)`
`void`	`setContourSeparation(int contourSeparation)`
`void`	`setCoverSteepTerrain(boolean coverSteepTerrain)`
`void`	`setCustomBiomes(java.util.List<CustomBiome> customBiomes)`
`void`	`setCustomLayers(java.util.List<CustomLayer> customLayers)`
`void`	`setEventsInhibited(boolean eventsInhibited)`
`void`	`setExportSettings(ExportSettings exportSettings)`
`void`	`setFixOverlayCoords(boolean fixOverlayCoords)`
`void`	`setGenerator(MapGenerator generator)`
`void`	`setGridEnabled(boolean gridEnabled)`
`void`	`setGridSize(int gridSize)`
`void`	`setHeightAt(int x, int y, float height)`
`void`	`setHeightAt(java.awt.Point coords, float height)`
`void`	`setHiddenPalettes(java.util.Set<java.lang.String> hiddenPalettes)`
`void`	`setLastViewPosition(java.awt.Point lastViewPosition)`
`void`	`setLayerSettings(Layer layer, ExporterSettings settings)`
`void`	`setLayerValueAt(Layer layer, int x, int y, int value)`
`void`	`setMaxHeight(int maxHeight)`
`void`	`setMinecraftSeed(long minecraftSeed)`
`void`	`setMinHeight(int minHeight)`
`void`	`setName(java.lang.String name)`
`void`	`setOverlaysEnabled(boolean overlaysEnabled)`
`void`	`setPopulate(boolean populate)`
`void`	`setRawHeightAt(int x, int y, int rawHeight)` Set the raw height value.
`void`	`setRawHeightAt(java.awt.Point coords, int rawHeight)` Set the raw height value.
`void`	`setRoofType(Dimension.WallType roofType)`
`void`	`setScale(float scale)`
`void`	`setSoloedPalette(java.lang.String soloedPalette)`
`void`	`setSubsurfaceLayerAnchor(Dimension.LayerAnchor subsurfaceLayerAnchor)`
`void`	`setSubsurfaceMaterial(Terrain subsurfaceMaterial)`
`void`	`setTerrainAt(int x, int y, Terrain terrain)`
`void`	`setTerrainAt(java.awt.Point coords, Terrain terrain)`
`void`	`setTopLayerAnchor(Dimension.LayerAnchor topLayerAnchor)`
`void`	`setTopLayerMinDepth(int topLayerMinDepth)`
`void`	`setTopLayerVariation(int topLayerVariation)`
`void`	`setUndergroundBiome(java.lang.Integer undergroundBiome)`
`void`	`setWallType(Dimension.WallType wallType)`
`void`	`setWaterLevelAt(int x, int y, int waterLevel)`
`void`	`setWorld(World2 world)`
`void`	`terrainChanged(Tile tile)`
`void`	`transform(CoordinateTransform transform, org.pepsoft.util.ProgressReceiver progressReceiver)` Transform the tiles of this dimension horizontally, for instance translating and/or rotating them.
`boolean`	`undoChanges()`
`void`	`unregisterUndoManager()`
`Dimension.TileVisitationBuilder`	`visitTiles()` Visit the tiles in this dimension, optionally constraining the visited tiles according to some basic constraints.
`Dimension.TileVisitationBuilder`	`visitTilesForEditing()` Visit the tiles in this dimension, optionally constraining the visited tiles according to some basic constraints.
`void`	`waterLevelChanged(Tile tile)`

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

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

Field Detail

POSSIBLE_AUTO_BIOMES

public static final int[] POSSIBLE_AUTO_BIOMES

Constructor Detail

Dimension

public Dimension(World2 world,
                 java.lang.String name,
                 long minecraftSeed,
                 TileFactory tileFactory,
                 Dimension.Anchor anchor)

Dimension

public Dimension(World2 world,
                 java.lang.String name,
                 long minecraftSeed,
                 TileFactory tileFactory,
                 Dimension.Anchor anchor,
                 boolean init)

Method Detail
- getWorld
```
public World2 getWorld()
```
- setWorld
```
public void setWorld(World2 world)
```
- getAnchor
```
public Dimension.Anchor getAnchor()
```
- getId
```
public java.util.UUID getId()
```
- getName
```
public java.lang.String getName()
```
- setName
```
public void setName(java.lang.String name)
```
- getChangeNo
```
public long getChangeNo()
```
  Get the change number. This number is updated every time the state of the dimension changes and can be used to determine whether the state needs to be saved.
  
  Returns:
  
  The current change number.
- changed
```
public void changed()
```
  Update the change number; for use when some aspect of a dimension changes which the Dimension class itself does not track.
- getSeed
```
public long getSeed()
```
- getSubsurfaceMaterial
```
public Terrain getSubsurfaceMaterial()
```
- setSubsurfaceMaterial
```
public void setSubsurfaceMaterial(Terrain subsurfaceMaterial)
```
- isPopulate
```
public boolean isPopulate()
```
- setPopulate
```
public void setPopulate(boolean populate)
```
- getBorder
```
public Dimension.Border getBorder()
```
- setBorder
```
public void setBorder(Dimension.Border border)
```
- getBorderLevel
```
public int getBorderLevel()
```
- setBorderLevel
```
public void setBorderLevel(int borderLevel)
```
- getBorderSize
```
public int getBorderSize()
```
- setBorderSize
```
public void setBorderSize(int borderSize)
```
- getTileFactory
```
public TileFactory getTileFactory()
```
- isTilePresent
```
public boolean isTilePresent(int x,
                             int y)
```
  Determines whether a tile is present in the dimension on specific coordinates.
  
  Specified by:
  
  isTilePresent in interface TileProvider
  
  Parameters:
  
  x - The tile X coordinate for which to determine whether a tile is present.
  
  y - The tile Y coordinate for which to determine whether a tile is present.
  
  Returns:
  
  true if the dimension contains a tile at the specified location.
- isBorderTile
```
public boolean isBorderTile(int x,
                            int y)
```
  Indicates whether the specified tile is a border tile.
  
  Parameters:
  
  x - The X coordinate of the tile for which to check whether it is a border tile.
  
  y - The Y coordinate of the tile for which to check whether it is a border tile.
  
  Returns:
  
  true if it is a border tile.
- getTile
```
public Tile getTile(int x,
                    int y)
```
  Get the tile for a particular set of world or absolute block coordinates.
  
  Specified by:
  
  getTile in interface TileProvider
  
  Parameters:
  
  x - The tile X coordinate for which to get the tile.
  
  y - The tile Y coordinate for which to get the tile.
  
  Returns:
  
  The tile with the specified coordinates, or null if there is no tile for those coordinates
- getTile
```
public Tile getTile(java.awt.Point coords)
```
- getTileForEditing
```
public Tile getTileForEditing(int x,
                              int y)
```
  Get the tile for a particular set of world or absolute block coordinates with the intention of modifying it. This is intended to be used in combination with setEventsInhibited(boolean). Whenever eventsInhibited is true, the dimension will automatically inhibit events on the tile, mark it as dirty and fire an event for it when eventsInhibited is set to false.
  
  Parameters:
  
  x - The tile X coordinate for which to get the tile.
  
  y - The tile Y coordinate for which to get the tile.
  
  Returns:
  
  The tile with the specified coordinates, or null if there is no tile for those coordinates
- getTileForEditing
```
public Tile getTileForEditing(java.awt.Point coords)
```
  Get the tile for a particular set of world or absolute block coordinates with the intention of modifying it. This is intended to be used in combination with setEventsInhibited(boolean). Whenever eventsInhibited is true, the dimension will automatically inhibit events on the tile, mark it as dirty and fire an event for it when eventsInhibited is set to false.
  
  Parameters:
  
  coords - The world coordinates for which to get the tile.
  
  Returns:
  
  The tile on which the specified coordinates lie, or null if there is no tile for those coordinates
- getExtent
```
public java.awt.Rectangle getExtent()
```
  Specified by:
  
  getExtent in interface TileProvider
- getTileCount
```
public int getTileCount()
```
- getTiles
```
public java.util.Collection<? extends Tile> getTiles()
```
  Get a collection of all extant tiles in the dimension. May not contain nulls.
- getTileCoords
```
public java.util.Set<java.awt.Point> getTileCoords()
```
- addTile
```
public void addTile(Tile tile)
```
- removeTile
```
public void removeTile(int tileX,
                       int tileY)
```
- removeTile
```
public void removeTile(Tile tile)
```
- removeTile
```
public void removeTile(java.awt.Point coords)
```
- getHighestX
```
public int getHighestX()
```
- getHighestY
```
public int getHighestY()
```
- getLowestX
```
public int getLowestX()
```
- getLowestY
```
public int getLowestY()
```
- getWidth
```
public int getWidth()
```
- getHeight
```
public int getHeight()
```
- getIntHeightAt
```
public int getIntHeightAt(int x,
                          int y)
```
  Get the terrain height at the specified coordinates, rounded to the nearest integer, if a tile exists in the specified location.
  
  Parameters:
  
  x - The X coordinate to query.
  
  y - The Y coordinate to query.
  
  Returns:
  
  The terrain height at the specified coordinates rounded to the nearest integer, or Integer.MIN_VALUE if there is no tile at the specified coordinates.
- getIntHeightAt
```
public int getIntHeightAt(int x,
                          int y,
                          int defaultHeight)
```
  Get the terrain height at the specified coordinates, rounded to the nearest integer, if a tile exists in the specified location.
  
  Parameters:
  
  x - The X coordinate to query.
  
  y - The Y coordinate to query.
  
  defaultHeight - The value to return if there is no tile at the specified coordinates.
  
  Returns:
  
  The terrain height at the specified coordinates rounded to the nearest integer, or defaultHeight if there is no tile at the specified coordinates.
- getIntHeightAt
```
public int getIntHeightAt(java.awt.Point coords)
```
  Get the terrain height at the specified coordinates, rounded to the nearest integer, if a tile exists in the specified location.
  
  Parameters:
  
  coords - The coordinates to query.
  
  Returns:
  
  The terrain height at the specified coordinates rounded to the nearest integer, or Integer.MIN_VALUE if there is no tile at the specified coordinates.
- getLowestIntHeight
```
public int getLowestIntHeight()
```
- getHighestIntHeight
```
public int getHighestIntHeight()
```
- getIntHeightRange
```
public int[] getIntHeightRange()
```
- getHeightAt
```
public float getHeightAt(int x,
                         int y)
```
  Get the terrain height at the specified coordinates, if a tile exists in the specified location.
  
  Parameters:
  
  x - The X coordinate to query.
  
  y - The Y coordinate to query.
  
  Returns:
  
  The terrain height at the specified coordinates, or -Float.MAX_VALUE if there is no tile at the specified coordinates.
- getHeightAt
```
public float getHeightAt(java.awt.Point coords)
```
  Get the terrain height at the specified coordinates, if a tile exists in the specified location.
  
  Parameters:
  
  coords - The coordinates to query.
  
  Returns:
  
  The terrain height at the specified coordinates, or -Float.MAX_VALUE if there is no tile at the specified coordinates.
- getLowestHeight
```
public float getLowestHeight()
```
- getHighestHeight
```
public float getHighestHeight()
```
- getHeightRange
```
public float[] getHeightRange()
```
- setHeightAt
```
public void setHeightAt(int x,
                        int y,
                        float height)
```
- setHeightAt
```
public void setHeightAt(java.awt.Point coords,
                        float height)
```
- getRawHeightAt
```
public int getRawHeightAt(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.
- getLowestRawHeight
```
public int getLowestRawHeight()
```
- getHighestRawHeight
```
public int getHighestRawHeight()
```
- getRawHeightRange
```
public int[] getRawHeightRange()
```
- getRawHeightAt
```
public int getRawHeightAt(java.awt.Point coords)
```
  Get the raw height value. This is the height times 256 (for added precision) and zero-based rather than adjusted for minHeight.
- setRawHeightAt
```
public void setRawHeightAt(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.
- setRawHeightAt
```
public void setRawHeightAt(java.awt.Point coords,
                           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)
```
- doGetSlope
```
protected final float doGetSlope(int x,
                                 int y)
```
- getTerrainAt
```
public Terrain getTerrainAt(int x,
                            int y)
```
- setTerrainAt
```
public void setTerrainAt(int x,
                         int y,
                         Terrain terrain)
```
- getAllTerrains
```
public java.util.Set<Terrain> getAllTerrains()
```
- setTerrainAt
```
public void setTerrainAt(java.awt.Point coords,
                         Terrain terrain)
```
- applyTheme
```
public void applyTheme(int x,
                       int y)
```
- getWaterLevelAt
```
public int getWaterLevelAt(int x,
                           int y)
```
- getWaterLevelAt
```
public int getWaterLevelAt(java.awt.Point coords)
```
- setWaterLevelAt
```
public void setWaterLevelAt(int x,
                            int y,
                            int waterLevel)
```
- getLayerValueAt
```
public int getLayerValueAt(Layer layer,
                           int x,
                           int y)
```
- getLayerValueAt
```
public int getLayerValueAt(Layer layer,
                           java.awt.Point coords)
```
- setLayerValueAt
```
public void setLayerValueAt(Layer layer,
                            int x,
                            int y,
                            int value)
```
- getBitLayerValueAt
```
public boolean getBitLayerValueAt(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 global X coordinate of the location around which to count the layer.
  
  y - The global Y coordinate of the location around which to count the layer.
  
  r - The radius of the square. The side of the square is 2·r+1
  
  Returns:
  
  The number of blocks in the specified square where the specified bit layer is set.
- getLayersAt
```
public java.util.Map<Layer,java.lang.Integer> getLayersAt(int x,
                                                          int y)
```
  Gets all layers that are set at the specified location, along with their intensities or values. 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 or values 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 global X coordinate of the location around which to count flooded blocks.
  
  y - The global Y coordinate 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.
- doGetFloodedCount
```
protected final int doGetFloodedCount(int x,
                                      int y,
                                      int r,
                                      boolean lava)
```
- getDistanceToEdge
```
public float getDistanceToEdge(Layer layer,
                               int x,
                               int y,
                               float maxDistance)
```
  Get the distance from the specified coordinate to the nearest pixel where the specified layer is not set.
  
  Parameters:
  
  layer - The layer for which to find the distance to the nearest edge.
  
  x - The X coordinate of the location towards which to determine the distance.
  
  y - The Y coordinate of the location towards which to determine the distance.
  
  maxDistance - The maximum distance to return. If the actual distance is further, this value will be returned.
  
  Returns:
  
  The distance from the specified location to the nearest pixel where the specified layer is not set, or maxDistance, whichever is smaller. If the layer is not set at the specified coordinates, 0 is returned.
- getDistancesToEdge
```
public HeightMap getDistancesToEdge(Layer layer,
                                    float maxDistance)
```
  Bake the edge distances for an entire painted layer and return them as a HeightMap. For high values of maxDistance this is much quicker than interrogating the edge distance of every pixel via getDistanceToEdge(Layer, int, int, float), but the information is static and does not update when the dimension is updated.
  Note that the information in the height map is only valid for pixels where the layer is set in the dimension! For other pixels the value is undefined.
  
  Parameters:
  
  layer - The layer for which to bake the edge distances. Must have data type BIT or BIT_PER_CHUNK.
  
  maxDistance - The maximum edge distance to calculate. Pixels where the layer is set and the distance to the nearest edge is higher will have this value set.
  
  Returns:
  
  A HeightMap returning the distance to the nearest edge for every pixel where the specified layer is set in this dimension.
- doGetDistanceToEdge
```
protected final float doGetDistanceToEdge(Layer layer,
                                          int x,
                                          int y,
                                          float maxDistance)
```
- setBitLayerValueAt
```
public void setBitLayerValueAt(Layer layer,
                               int x,
                               int y,
                               boolean value)
```
- clearLayerData
```
public void clearLayerData(Layer layer)
```
- clearLayerData
```
public 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.
  
  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.
- setEventsInhibited
```
public void setEventsInhibited(boolean eventsInhibited)
```
- isEventsInhibited
```
public boolean isEventsInhibited()
```
- getAllLayerSettings
```
public java.util.Map<Layer,ExporterSettings> getAllLayerSettings()
```
- getLayerSettings
```
public ExporterSettings getLayerSettings(Layer layer)
```
- setLayerSettings
```
public void setLayerSettings(Layer layer,
                             ExporterSettings settings)
```
- getMinecraftSeed
```
public long getMinecraftSeed()
```
- setMinecraftSeed
```
public void setMinecraftSeed(long minecraftSeed)
```
- getOverlays
```
public java.util.List<Overlay> getOverlays()
```
- addOverlay
```
public int addOverlay(Overlay overlay)
```
- removeOverlay
```
public void removeOverlay(int index)
```
- isGridEnabled
```
public boolean isGridEnabled()
```
- setGridEnabled
```
public void setGridEnabled(boolean gridEnabled)
```
- getGridSize
```
public int getGridSize()
```
- setGridSize
```
public void setGridSize(int gridSize)
```
- isOverlaysEnabled
```
public boolean isOverlaysEnabled()
```
- setOverlaysEnabled
```
public void setOverlaysEnabled(boolean overlaysEnabled)
```
- getMinHeight
```
public int getMinHeight()
```
- setMinHeight
```
public void setMinHeight(int minHeight)
```
- getMaxHeight
```
public int getMaxHeight()
```
- setMaxHeight
```
public void setMaxHeight(int maxHeight)
```
- getContourSeparation
```
public int getContourSeparation()
```
- setContourSeparation
```
public void setContourSeparation(int contourSeparation)
```
- isContoursEnabled
```
public boolean isContoursEnabled()
```
- setContoursEnabled
```
public void setContoursEnabled(boolean contoursEnabled)
```
- getTopLayerMinDepth
```
public int getTopLayerMinDepth()
```
- setTopLayerMinDepth
```
public void setTopLayerMinDepth(int topLayerMinDepth)
```
- getTopLayerVariation
```
public int getTopLayerVariation()
```
- setTopLayerVariation
```
public void setTopLayerVariation(int topLayerVariation)
```
- isBottomless
```
public boolean isBottomless()
```
- setBottomless
```
public void setBottomless(boolean bottomless)
```
- getLastViewPosition
```
public java.awt.Point getLastViewPosition()
```
- setLastViewPosition
```
public void setLastViewPosition(java.awt.Point lastViewPosition)
```
- getCustomBiomes
```
public java.util.List<CustomBiome> getCustomBiomes()
```
- setCustomBiomes
```
public void setCustomBiomes(java.util.List<CustomBiome> customBiomes)
```
- isCoverSteepTerrain
```
public boolean isCoverSteepTerrain()
```
- setCoverSteepTerrain
```
public void setCoverSteepTerrain(boolean coverSteepTerrain)
```
- isFixOverlayCoords
```
public boolean isFixOverlayCoords()
```
- setFixOverlayCoords
```
public void setFixOverlayCoords(boolean fixOverlayCoords)
```
- getUndergroundBiome
```
public java.lang.Integer getUndergroundBiome()
```
- setUndergroundBiome
```
public void setUndergroundBiome(java.lang.Integer undergroundBiome)
```
- getGarden
```
public Garden getGarden()
```
- getCustomLayers
```
public java.util.List<CustomLayer> getCustomLayers()
```
- getCustomLayers
```
public java.util.List<CustomLayer> getCustomLayers(boolean applyCombinedLayers)
```
- setCustomLayers
```
public void setCustomLayers(java.util.List<CustomLayer> customLayers)
```
- getAllLayers
```
public java.util.Set<Layer> getAllLayers(boolean applyCombinedLayers)
```
  Returns the set of all layers currently in use on the world, optionally including layers that are included in combined layers.
  
  Parameters:
  
  applyCombinedLayers - Whether to include layers from combined layers which are not used independently in the dimension.
  
  Returns:
  
  The set of all layers currently in use on the world.
- getMinimumLayers
```
public java.util.Set<Layer> getMinimumLayers()
```
  Get the set of layers that has been configured to be applied everywhere.
  
  Returns:
  
  The set of layers that has been configured to be applied everywhere.
- getCeilingHeight
```
public int getCeilingHeight()
```
- setCeilingHeight
```
public void setCeilingHeight(int ceilingHeight)
```
- getSubsurfaceLayerAnchor
```
public Dimension.LayerAnchor getSubsurfaceLayerAnchor()
```
- setSubsurfaceLayerAnchor
```
public void setSubsurfaceLayerAnchor(Dimension.LayerAnchor subsurfaceLayerAnchor)
```
- getTopLayerAnchor
```
public Dimension.LayerAnchor getTopLayerAnchor()
```
- setTopLayerAnchor
```
public void setTopLayerAnchor(Dimension.LayerAnchor topLayerAnchor)
```
- getExportSettings
```
public ExportSettings getExportSettings()
```
- setExportSettings
```
public void setExportSettings(ExportSettings exportSettings)
```
- getGenerator
```
public MapGenerator getGenerator()
```
- setGenerator
```
public void setGenerator(MapGenerator generator)
```
- getWallType
```
public Dimension.WallType getWallType()
```
- setWallType
```
public void setWallType(Dimension.WallType wallType)
```
- getRoofType
```
public Dimension.WallType getRoofType()
```
- setRoofType
```
public void setRoofType(Dimension.WallType roofType)
```
- getScale
```
public float getScale()
```
- setScale
```
public void setScale(float scale)
```
- getHiddenPalettes
```
public java.util.Set<java.lang.String> getHiddenPalettes()
```
- setHiddenPalettes
```
public void setHiddenPalettes(java.util.Set<java.lang.String> hiddenPalettes)
```
- getSoloedPalette
```
public java.lang.String getSoloedPalette()
```
- setSoloedPalette
```
public void setSoloedPalette(java.lang.String soloedPalette)
```
- applyTheme
```
public void applyTheme(java.awt.Point coords)
```
- isUndoAvailable
```
public boolean isUndoAvailable()
```
- registerUndoManager
```
public void registerUndoManager(org.pepsoft.util.undo.UndoManager undoManager)
```
- undoChanges
```
public boolean undoChanges()
```
- clearUndo
```
public void clearUndo()
```
- armSavePoint
```
public void armSavePoint()
```
- rememberChanges
```
public void rememberChanges()
```
- clearRedo
```
public void clearRedo()
```
- unregisterUndoManager
```
public void unregisterUndoManager()
```
- getAutoBiome
```
public final int getAutoBiome(int x,
                              int y)
```
- getAutoBiome
```
public final int getAutoBiome(int x,
                              int y,
                              int defaultBiome)
```
- getAutoBiome
```
public final int getAutoBiome(Tile tile,
                              int x,
                              int y)
```
- getAutoBiome
```
public final int getAutoBiome(Tile tile,
                              int x,
                              int y,
                              int defaultBiome)
```
- getSnapshot
```
public Dimension getSnapshot()
```
  Get a snapshot of the current state of this dimension. If you want this snapshot to be truly static, you must execute a savepoint on the undo manager after this.
  
  Returns:
  
  A snapshot of the current state of this dimension.
- getTopLayerDepth
```
public int getTopLayerDepth(int x,
                            int y,
                            int z)
```
- addDimensionListener
```
public void addDimensionListener(Dimension.Listener listener)
```
- removeDimensionListener
```
public void removeDimensionListener(Dimension.Listener listener)
```
- addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
- addPropertyChangeListener
```
public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
```
- removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
- removePropertyChangeListener
```
public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
```
- transform
```
public void transform(CoordinateTransform transform,
                      org.pepsoft.util.ProgressReceiver progressReceiver)
               throws org.pepsoft.util.ProgressReceiver.OperationCancelled
```
  Transform the tiles of this dimension horizontally, for instance translating and/or rotating them. If an undo manager is installed this operation will destroy all undo info.
  
  Parameters:
  
  transform - The transform to apply to the tiles and their contents.
  
  progressReceiver - An optional progress receiver to which progress of the operation will be reported.
  
  Throws:
  
  org.pepsoft.util.ProgressReceiver.OperationCancelled - If the progress receiver threw an OperationCancelled exception indicating that the user wished to cancel the operation.
- containsOneOf
```
public boolean containsOneOf(Layer... layers)
```
- visitTilesForEditing
```
public Dimension.TileVisitationBuilder visitTilesForEditing()
```
  Visit the tiles in this dimension, optionally constraining the visited tiles according to some basic constraints. Uses the builder pattern. To visit all tiles, do:
```
visitTiles().andDo(tile -> { /* process tile */ });
```
  To restrict to a filter:
```
visitTiles().forFilter(filter).andDo(tile -> { /* process tile */ });
```
  To restrict to a brush:
```
visitTiles().forBrush(brush, x, y).andDo(tile -> { /* process tile */ });
```
  To restrict to the selection:
```
visitTiles().forSelection().andDo(tile -> { /* process tile */ });
```
  You can combine constraints:
```
visitTiles().forFilter(filter).forBrush(brush, x, y).andDo(tile -> { /* process tile */ });
```
  Returns:
- visitTiles
```
public Dimension.TileVisitationBuilder visitTiles()
```
  Visit the tiles in this dimension, optionally constraining the visited tiles according to some basic constraints. Uses the builder pattern. To visit all tiles, do:
```
visitTiles().andDo(tile -> { /* process tile */ });
```
  To restrict to a filter:
```
visitTiles().forFilter(filter).andDo(tile -> { /* process tile */ });
```
  To restrict to a brush:
```
visitTiles().forBrush(brush, x, y).andDo(tile -> { /* process tile */ });
```
  To restrict to the selection:
```
visitTiles().forSelection().andDo(tile -> { /* process tile */ });
```
  You can combine constraints:
```
visitTiles().forFilter(filter).forBrush(brush, x, y).andDo(tile -> { /* process tile */ });
```
  Returns:
- getAttribute
```
public <T> T getAttribute(org.pepsoft.util.AttributeKey<T> key)
```
- setAttribute
```
public <T> void setAttribute(org.pepsoft.util.AttributeKey<T> key,
                             T value)
```
- getMostPrevalentBiome
```
public int getMostPrevalentBiome(int x,
                                 int y,
                                 int defaultBiome)
```
  Get the most prevalent biome in a 4x4 area.
  
  Parameters:
  
  x - X coordinate of the 4x4 area (in 4x4 areas).
  
  y - Y coordinate of the 4x4 area (in 4x4 areas).
  
  defaultBiome - The biome to return for areas where the biome is not defined.
- save
```
public void save(java.util.zip.ZipOutputStream out)
          throws java.io.IOException
```
  Throws:
  
  java.io.IOException
- heightMapChanged
```
public void heightMapChanged(Tile tile)
```
  Specified by:
  
  heightMapChanged in interface Tile.Listener
- terrainChanged
```
public void terrainChanged(Tile tile)
```
  Specified by:
  
  terrainChanged in interface Tile.Listener
- waterLevelChanged
```
public void waterLevelChanged(Tile tile)
```
  Specified by:
  
  waterLevelChanged in interface Tile.Listener
- seedsChanged
```
public void seedsChanged(Tile tile)
```
  Specified by:
  
  seedsChanged in interface Tile.Listener
- layerDataChanged
```
public void layerDataChanged(Tile tile,
                             java.util.Set<Layer> changedLayers)
```
  Specified by:
  
  layerDataChanged in interface Tile.Listener
- allBitLayerDataChanged
```
public void allBitLayerDataChanged(Tile tile)
```
  Specified by:
  
  allBitLayerDataChanged in interface Tile.Listener
- allNonBitlayerDataChanged
```
public void allNonBitlayerDataChanged(Tile tile)
```
  Specified by:
  
  allNonBitlayerDataChanged in interface Tile.Listener

Class Dimension

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

POSSIBLE_AUTO_BIOMES

Constructor Detail

Dimension

Dimension

Method Detail

getWorld

setWorld

getAnchor

getId

getName

setName

getChangeNo

changed

getSeed

getSubsurfaceMaterial

setSubsurfaceMaterial

isPopulate

setPopulate

getBorder

setBorder

getBorderLevel

setBorderLevel

getBorderSize

setBorderSize

getTileFactory

isTilePresent

isBorderTile

getTile

getTile

getTileForEditing

getTileForEditing

getExtent

getTileCount

getTiles

getTileCoords

addTile

removeTile

removeTile

removeTile

getHighestX

getHighestY

getLowestX

getLowestY

getWidth

getHeight

getIntHeightAt

getIntHeightAt

getIntHeightAt

getLowestIntHeight

getHighestIntHeight

getIntHeightRange

getHeightAt

getHeightAt

getLowestHeight

getHighestHeight

getHeightRange

setHeightAt

setHeightAt

getRawHeightAt

getLowestRawHeight

getHighestRawHeight

getRawHeightRange

getRawHeightAt

setRawHeightAt

setRawHeightAt

getSlope

doGetSlope

getTerrainAt

setTerrainAt

getAllTerrains

setTerrainAt