org.pepsoft.worldpainter.exporting

Class FlatteningDimension

java.lang.Object

org.pepsoft.worldpainter.InstanceKeeper

org.pepsoft.worldpainter.Dimension

org.pepsoft.worldpainter.RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

org.pepsoft.worldpainter.exporting.FlatteningDimension

All Implemented Interfaces:

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

public class FlatteningDimension
extends RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

A Dimension which combines multiple layered Dimensionss into one, returning data from the first dimension in which the chunk is present (it exists and is not marked NotPresent or ReadOnly).

Global settings and settings for singleton layers such as caves, resources, etc. are copied from the first dimension; those settings are ignored from the other dimensions.

Note that not all operations are implemented. Only those needed for exporting are guaranteed to be implemented. Others may throw an UnsupportedOperationException.

See Also:

Serialized Form

Nested Class Summary

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

Dimension.Anchor, Dimension.Border, Dimension.LayerAnchor, Dimension.Listener, Dimension.Role, Dimension.TileVisitationBuilder, Dimension.TileVisitor, Dimension.WallType

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

InstanceKeeper.InstantiationListener<T>

Field Summary

Fields inherited from class org.pepsoft.worldpainter.RODelegatingDimension

dimension, tileCache

Fields inherited from class org.pepsoft.worldpainter.Dimension

POSSIBLE_AUTO_BIOMES

Constructor Summary

Constructors

Constructor and Description
FlatteningDimension(Dimension... dimensions)

Method Summary

Modifier and Type	Method and Description
boolean	containsOneOf(Layer... layers)
protected Tile	doGetTile(java.awt.Point coords)
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.Set<Terrain>	getAllTerrains()
boolean	getBitLayerValueAt(Layer layer, int x, int y)
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.
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
int	getHeight()
float	getHeightAt(int x, int y) Get the terrain height at the specified coordinates, if a tile exists in the specified location.
int	getHighestX()
int	getHighestY()
int	getIntHeightAt(int x, int y, int defaultValue) Get the terrain height at the specified coordinates, rounded to the nearest integer, if a tile exists in the specified location.
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.
int	getLayerValueAt(Layer layer, int x, int y)
int	getLowestX()
int	getLowestY()
int	getRawHeightAt(int x, int y) Get the raw height value.
float	getSlope(int x, int y)
java.util.Set<java.awt.Point>	getTileCoords()
int	getTileCount()
int	getWaterLevelAt(int x, int y)
int	getWidth()
boolean	isBorderTile(int x, int y) Indicates whether the specified tile is a border tile.
Dimension.TileVisitationBuilder	visitTilesForEditing() Visit the tiles in this dimension, optionally constraining the visited tiles according to some basic constraints.

Methods inherited from class org.pepsoft.worldpainter.RODelegatingDimension

addDimensionListener, addOverlay, addPropertyChangeListener, addPropertyChangeListener, addTile, allBitLayerDataChanged, allNonBitlayerDataChanged, applyTheme, applyTheme, armSavePoint, changed, clearLayerData, clearRedo, clearUndo, getAllLayerSettings, getAnchor, getBorder, getBorderLevel, getBorderSize, getChangeNo, getContourSeparation, getCustomBiomes, getGarden, getGridSize, getHeightAt, getIntHeightAt, getIntHeightAt, getLastViewPosition, getLayerSettings, getLayerValueAt, getMaxHeight, getMinecraftSeed, getMinimumLayers, getName, getOverlays, getRawHeightAt, getRoofType, getSeed, getSnapshot, getSubsurfaceMaterial, getTerrainAt, getTile, getTile, getTileFactory, getTiles, getTopLayerDepth, getTopLayerMinDepth, getTopLayerVariation, getWallType, getWaterLevelAt, getWorld, heightMapChanged, isBottomless, isContoursEnabled, isEventsInhibited, isGridEnabled, isOverlaysEnabled, isPopulate, isTilePresent, isUndoAvailable, layerDataChanged, registerUndoManager, removeDimensionListener, removeOverlay, removePropertyChangeListener, removePropertyChangeListener, removeTile, removeTile, removeTile, seedsChanged, setBitLayerValueAt, setBorder, setBorderLevel, setBorderSize, setBottomless, setContoursEnabled, setContourSeparation, setCustomBiomes, setEventsInhibited, setGridEnabled, setGridSize, setHeightAt, setHeightAt, setLastViewPosition, setLayerSettings, setLayerValueAt, setMaxHeight, setMinecraftSeed, setOverlaysEnabled, setPopulate, setRawHeightAt, setRawHeightAt, setRoofType, setSubsurfaceMaterial, setTerrainAt, setTerrainAt, setTopLayerMinDepth, setTopLayerVariation, setWallType, setWaterLevelAt, terrainChanged, transform, undoChanges, unregisterUndoManager, waterLevelChanged, wrapTile

Methods inherited from class org.pepsoft.worldpainter.Dimension

clearLayerData, doGetDistanceToEdge, doGetFloodedCount, doGetSlope, getAttribute, getAutoBiome, getAutoBiome, getAutoBiome, getAutoBiome, getBitLayerCount, getCeilingHeight, getCustomLayers, getCustomLayers, getDistancesToEdge, getExportSettings, getGenerator, getHeightRange, getHiddenPalettes, getHighestHeight, getHighestIntHeight, getHighestRawHeight, getId, getIntHeightRange, getLowestHeight, getLowestIntHeight, getLowestRawHeight, getMinHeight, getMostPrevalentBiome, getRawHeightRange, getScale, getSoloedPalette, getSubsurfaceLayerAnchor, getTileForEditing, getTileForEditing, getTopLayerAnchor, getUndergroundBiome, isCoverSteepTerrain, isFixOverlayCoords, rememberChanges, save, setAttribute, setCeilingHeight, setCoverSteepTerrain, setCustomLayers, setExportSettings, setFixOverlayCoords, setGenerator, setHiddenPalettes, setMinHeight, setName, setScale, setSoloedPalette, setSubsurfaceLayerAnchor, setTopLayerAnchor, setUndergroundBiome, setWorld, visitTiles

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

Constructor Detail

FlatteningDimension

public FlatteningDimension(Dimension... dimensions)

Method Detail

getTileCount

public int getTileCount()

Overrides:

getTileCount in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getIntHeightAt

public int getIntHeightAt(int x,
                          int y,
                          int defaultValue)

Description copied from class: Dimension

Get the terrain height at the specified coordinates, rounded to the nearest integer, if a tile exists in the specified location.

Overrides:

getIntHeightAt in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

Parameters:

x - The X coordinate to query.

y - The Y coordinate to query.

defaultValue - 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.

getHeightAt

public float getHeightAt(int x,
                         int y)

Description copied from class: Dimension

Get the terrain height at the specified coordinates, if a tile exists in the specified location.

Overrides:

getHeightAt in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

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.

getRawHeightAt

public int getRawHeightAt(int x,
                          int y)

Description copied from class: Dimension

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

Overrides:

getRawHeightAt in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getAllTerrains

public java.util.Set<Terrain> getAllTerrains()

Overrides:

getAllTerrains in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getWaterLevelAt

public int getWaterLevelAt(int x,
                           int y)

Overrides:

getWaterLevelAt in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getLayerValueAt

public int getLayerValueAt(Layer layer,
                           int x,
                           int y)

Overrides:

getLayerValueAt in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getBitLayerValueAt

public boolean getBitLayerValueAt(Layer layer,
                                  int x,
                                  int y)

Overrides:

getBitLayerValueAt in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getDistanceToEdge

public float getDistanceToEdge(Layer layer,
                               int x,
                               int y,
                               float maxDistance)

Description copied from class: Dimension

Get the distance from the specified coordinate to the nearest pixel where the specified layer is not set.

Overrides:

getDistanceToEdge in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

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.

getAllLayers

public java.util.Set<Layer> getAllLayers(boolean applyCombinedLayers)

Description copied from class: Dimension

Returns the set of all layers currently in use on the world, optionally including layers that are included in combined layers.

Overrides:

getAllLayers in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

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.

containsOneOf

public boolean containsOneOf(Layer... layers)

Overrides:

containsOneOf in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getHeight

public int getHeight()

Overrides:

getHeight in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getHighestX

public int getHighestX()

Overrides:

getHighestX in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getHighestY

public int getHighestY()

Overrides:

getHighestY in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getLowestX

public int getLowestX()

Overrides:

getLowestX in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getLowestY

public int getLowestY()

Overrides:

getLowestY in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getFloodedCount

public int getFloodedCount(int x,
                           int y,
                           int r,
                           boolean lava)

Description copied from class: Dimension

Count the number of blocks that are flooded in a square around a particular location

Overrides:

getFloodedCount in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

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.

getSlope

public float getSlope(int x,
                      int y)

Overrides:

getSlope in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getTileCoords

public java.util.Set<java.awt.Point> getTileCoords()

Overrides:

getTileCoords in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

getWidth

public int getWidth()

Overrides:

getWidth in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>

isBorderTile

public boolean isBorderTile(int x,
                            int y)

Description copied from class: Dimension

Indicates whether the specified tile is a border tile.

Overrides:

isBorderTile in class Dimension

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.

getExtent

public java.awt.Rectangle getExtent()

Specified by:

getExtent in interface TileProvider

Overrides:

getExtent in class Dimension

getLayersAt

public java.util.Map<Layer,java.lang.Integer> getLayersAt(int x,
                                                          int y)

Description copied from class: Dimension

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.

Overrides:

getLayersAt in class Dimension

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.

visitTilesForEditing

public Dimension.TileVisitationBuilder visitTilesForEditing()

Description copied from class: Dimension

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 */ });

Overrides:

visitTilesForEditing in class Dimension

Returns:

doGetTile

protected Tile doGetTile(java.awt.Point coords)

Overrides:

doGetTile in class RODelegatingDimension<org.pepsoft.worldpainter.exporting.FlatteningDimension.FlatteningTile>