org.pepsoft.worldpainter.layers.tunnel

Class TunnelLayer

java.lang.Object

org.pepsoft.worldpainter.layers.Layer

org.pepsoft.worldpainter.layers.CustomLayer

org.pepsoft.worldpainter.layers.tunnel.TunnelLayer

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Layer>

public class TunnelLayer
extends CustomLayer

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TunnelLayer.EdgeShape
static class	TunnelLayer.FillMode
static class	TunnelLayer.LayerMode
static class	TunnelLayer.LayerSettings
static class	TunnelLayer.Mode

Nested classes/interfaces inherited from class org.pepsoft.worldpainter.layers.Layer

Layer.DataSize

Field Summary

Fields inherited from class org.pepsoft.worldpainter.layers.CustomLayer

KEY_DIMENSION

Fields inherited from class org.pepsoft.worldpainter.layers.Layer

dataSize, discrete, id, priority

Constructor Summary

Constructors

Constructor and Description
TunnelLayer(java.lang.String name, TunnelLayer.LayerMode mode, java.lang.Object paint, Platform platform)

Method Summary

Modifier and Type	Method and Description
TunnelLayer	clone() Create a deep copy of the custom layer, with a different ID and independent settings.
static TunnelLayer	find(Dimension floorDimension) Find the TunnelLayer instance with which a particular cave floor dimension is associated.
TunnelLayer.EdgeShape	getBottomEdgeShape()
AbstractTunnelLayerExporter	getExporter(Dimension dimension, Platform platform, ExporterSettings settings) Create a new exporter for this layer.
java.lang.Class<? extends LayerExporter>	getExporterType() Return the type of the exporter that Layer.getExporter(Dimension, Platform, ExporterSettings) will return.
int	getFillLightLevel()
MixedMaterial	getFillMaterial()
TunnelLayer.FillMode	getFillMode()
int	getFloodLevel()
java.lang.Integer	getFloorDimensionId()
java.util.List<TunnelLayer.LayerSettings>	getFloorLayers()
int	getFloorLevel()
MixedMaterial	getFloorMaterial()
int	getFloorMax()
int	getFloorMin()
TunnelLayer.Mode	getFloorMode()
NoiseSettings	getFloorNoise()
int	getFloorWallDepth()
TunnelLayerHelper	getHelper(Dimension dimension) Get a helper for applying this layer to a particular dimension.
TunnelLayer.LayerMode	getLayerMode()
PaintRenderer	getRenderer()
java.util.List<TunnelLayer.LayerSettings>	getRoofLayers()
int	getRoofLevel()
MixedMaterial	getRoofMaterial()
int	getRoofMax()
int	getRoofMin()
TunnelLayer.Mode	getRoofMode()
NoiseSettings	getRoofNoise()
int	getRoofWallDepth()
java.lang.Integer	getTunnelBiome()
java.lang.String	getType() Get a short, human-readable description of the layer type.
MixedMaterial	getWallMaterial()
NoiseSettings	getWallNoise()
boolean	isExportableToFile() Indicates whether this layer should be allowed to be exported to a file.
boolean	isFloodWithLava()
static boolean	isLayerSupportedForCaveFloorDimension(Layer layer)
static boolean	isLayerSupportedForFloatingFloorDimension(Layer layer)
static boolean	isLayerTypeSupportedForCaveFloorDimension(java.lang.Class<? extends Layer> layerType)
static boolean	isLayerTypeSupportedForFloatingFloorDimension(java.lang.Class<? extends Layer> layerType)
boolean	isRemoveWater()
boolean	isStalactites()
boolean	isStalagmites()
void	setBottomEdgeShape(TunnelLayer.EdgeShape bottomEdgeShape)
void	setFillLightLevel(int fillLightLevel)
void	setFillMaterial(MixedMaterial fillMaterial)
void	setFillMode(TunnelLayer.FillMode fillMode)
void	setFloodLevel(int floodLevel)
void	setFloodWithLava(boolean floodWithLava)
void	setFloorDimensionId(java.lang.Integer floorDimensionId)
void	setFloorLayers(java.util.List<TunnelLayer.LayerSettings> floorLayers)
void	setFloorLevel(int floorLevel)
void	setFloorMaterial(MixedMaterial floorMaterial)
void	setFloorMax(int floorMax)
void	setFloorMin(int floorMin)
void	setFloorMode(TunnelLayer.Mode floorMode)
void	setFloorNoise(NoiseSettings floorNoise)
void	setFloorWallDepth(int floorWallDepth)
void	setMinMaxHeight(int oldMinHeight, int newMinHeight, int oldMaxHeight, int newMaxHeight, HeightTransform transform) This is invoked by WorldPainter when the dimension height is transformed (minHeight and/or maxHeight changes, and/or a shift and/or scaling operation applied), so that the layer settings may be adjusted accordingly, if applicable.
void	setRemoveWater(boolean removeWater)
void	setRoofLayers(java.util.List<TunnelLayer.LayerSettings> roofLayers)
void	setRoofLevel(int roofLevel)
void	setRoofMaterial(MixedMaterial roofMaterial)
void	setRoofMax(int roofMax)
void	setRoofMin(int roofMin)
void	setRoofMode(TunnelLayer.Mode roofMode)
void	setRoofNoise(NoiseSettings roofNoise)
void	setRoofWallDepth(int roofWallDepth)
void	setStalactites(boolean stalactites)
void	setStalagmites(boolean stalagmites)
void	setTunnelBiome(java.lang.Integer biome)
void	setWallMaterial(MixedMaterial wallMaterial)
void	setWallNoise(NoiseSettings wallNoise)
Dimension	updateFloorDimension(Dimension dimension, java.lang.String name) Ensure that tiles exist in the floor dimension for this layer for all the places where the layer is painted, and mark out the shape of the layer on the floor dimension using the NotPresentBlock layer.
void	updateFloorDimensionTiles(Dimension dimension) Ensure that tiles exist in the floor dimension for this layer for all the places where the layer is painted.

Methods inherited from class org.pepsoft.worldpainter.layers.CustomLayer

getActions, getBiome, getExportIndex, getIcon, getOpacity, getPaint, getPalette, getPaletteIndex, isExport, isHide, setBiome, setExport, setExportIndex, setHide, setName, setOpacity, setPaint, setPalette, setPaletteIndex

Methods inherited from class org.pepsoft.worldpainter.layers.Layer

compareTo, equals, getDataSize, getDefaultValue, getDescription, getId, getMnemonic, getName, getPriority, hashCode, setDescription, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TunnelLayer

public TunnelLayer(java.lang.String name,
                   TunnelLayer.LayerMode mode,
                   java.lang.Object paint,
                   Platform platform)

Method Detail

getRoofMode

public TunnelLayer.Mode getRoofMode()

setRoofMode

public void setRoofMode(TunnelLayer.Mode roofMode)

getFloorMode

public TunnelLayer.Mode getFloorMode()

setFloorMode

public void setFloorMode(TunnelLayer.Mode floorMode)

getRoofLevel

public int getRoofLevel()

setRoofLevel

public void setRoofLevel(int roofLevel)

getFloorLevel

public int getFloorLevel()

setFloorLevel

public void setFloorLevel(int floorLevel)

getFloorWallDepth

public int getFloorWallDepth()

setFloorWallDepth

public void setFloorWallDepth(int floorWallDepth)

getRoofWallDepth

public int getRoofWallDepth()

setRoofWallDepth

public void setRoofWallDepth(int roofWallDepth)

isStalactites

public boolean isStalactites()

setStalactites

public void setStalactites(boolean stalactites)

isStalagmites

public boolean isStalagmites()

setStalagmites

public void setStalagmites(boolean stalagmites)

getFloorMaterial

public MixedMaterial getFloorMaterial()

setFloorMaterial

public void setFloorMaterial(MixedMaterial floorMaterial)

getWallMaterial

public MixedMaterial getWallMaterial()

setWallMaterial

public void setWallMaterial(MixedMaterial wallMaterial)

getRoofMaterial

public MixedMaterial getRoofMaterial()

setRoofMaterial

public void setRoofMaterial(MixedMaterial roofMaterial)

getFloorNoise

public NoiseSettings getFloorNoise()

setFloorNoise

public void setFloorNoise(NoiseSettings floorNoise)

getRoofNoise

public NoiseSettings getRoofNoise()

setRoofNoise

public void setRoofNoise(NoiseSettings roofNoise)

getWallNoise

public NoiseSettings getWallNoise()

setWallNoise

public void setWallNoise(NoiseSettings wallNoise)

getRoofMin

public int getRoofMin()

setRoofMin

public void setRoofMin(int roofMin)

getRoofMax

public int getRoofMax()

setRoofMax

public void setRoofMax(int roofMax)

getFloorMin

public int getFloorMin()

setFloorMin

public void setFloorMin(int floorMin)

getFloorMax

public int getFloorMax()

setFloorMax

public void setFloorMax(int floorMax)

isRemoveWater

public boolean isRemoveWater()

setRemoveWater

public void setRemoveWater(boolean removeWater)

setMinMaxHeight

public void setMinMaxHeight(int oldMinHeight,
                            int newMinHeight,
                            int oldMaxHeight,
                            int newMaxHeight,
                            HeightTransform transform)

Description copied from class: CustomLayer

This is invoked by WorldPainter when the dimension height is transformed (minHeight and/or maxHeight changes, and/or a shift and/or scaling operation applied), so that the layer settings may be adjusted accordingly, if applicable.

The default implementation does nothing.

Overrides:

setMinMaxHeight in class CustomLayer

getType

public java.lang.String getType()

Description copied from class: CustomLayer

Get a short, human-readable description of the layer type.

Overrides:

getType in class CustomLayer

getFloodLevel

public int getFloodLevel()

setFloodLevel

public void setFloodLevel(int floodLevel)

isFloodWithLava

public boolean isFloodWithLava()

setFloodWithLava

public void setFloodWithLava(boolean floodWithLava)

getFloorLayers

public java.util.List<TunnelLayer.LayerSettings> getFloorLayers()

setFloorLayers

public void setFloorLayers(java.util.List<TunnelLayer.LayerSettings> floorLayers)

getRoofLayers

public java.util.List<TunnelLayer.LayerSettings> getRoofLayers()

setRoofLayers

public void setRoofLayers(java.util.List<TunnelLayer.LayerSettings> roofLayers)

getTunnelBiome

public java.lang.Integer getTunnelBiome()

setTunnelBiome

public void setTunnelBiome(java.lang.Integer biome)

getFloorDimensionId

public java.lang.Integer getFloorDimensionId()

setFloorDimensionId

public void setFloorDimensionId(java.lang.Integer floorDimensionId)

getFillMode

public TunnelLayer.FillMode getFillMode()

setFillMode

public void setFillMode(TunnelLayer.FillMode fillMode)

getFillLightLevel

public int getFillLightLevel()

setFillLightLevel

public void setFillLightLevel(int fillLightLevel)

getFillMaterial

public MixedMaterial getFillMaterial()

setFillMaterial

public void setFillMaterial(MixedMaterial fillMaterial)

getLayerMode

public TunnelLayer.LayerMode getLayerMode()

getBottomEdgeShape

public TunnelLayer.EdgeShape getBottomEdgeShape()

setBottomEdgeShape

public void setBottomEdgeShape(TunnelLayer.EdgeShape bottomEdgeShape)

updateFloorDimension

public Dimension updateFloorDimension(Dimension dimension,
                                      java.lang.String name)

Ensure that tiles exist in the floor dimension for this layer for all the places where the layer is painted, and mark out the shape of the layer on the floor dimension using the NotPresentBlock layer.

updateFloorDimensionTiles

public void updateFloorDimensionTiles(Dimension dimension)

Ensure that tiles exist in the floor dimension for this layer for all the places where the layer is painted. That might not be the case if the user has painted the layer in additional places but not then edited the floor dimension to fill in those places.

getHelper

public TunnelLayerHelper getHelper(Dimension dimension)

Get a helper for applying this layer to a particular dimension.

find

public static TunnelLayer find(Dimension floorDimension)

Find the TunnelLayer instance with which a particular cave floor dimension is associated.

Parameters:

floorDimension - The cave floor dimension for which to find the TunnelLayer.

Returns:

The TunnelLayer with which the specified floor dimension is associated.

Throws:

java.lang.IllegalArgumentException - If the specified dimension is not a cave floor dimension.

java.lang.IllegalStateException - If no TunnelLayer can be found, or if multiple TunnelLayers claim to be associated with the specified floor dimension.

isLayerTypeSupportedForCaveFloorDimension

public static boolean isLayerTypeSupportedForCaveFloorDimension(java.lang.Class<? extends Layer> layerType)

isLayerTypeSupportedForFloatingFloorDimension

public static boolean isLayerTypeSupportedForFloatingFloorDimension(java.lang.Class<? extends Layer> layerType)

isLayerSupportedForCaveFloorDimension

public static boolean isLayerSupportedForCaveFloorDimension(Layer layer)

isLayerSupportedForFloatingFloorDimension

public static boolean isLayerSupportedForFloatingFloorDimension(Layer layer)

getExporterType

public java.lang.Class<? extends LayerExporter> getExporterType()

Description copied from class: Layer

Return the type of the exporter that Layer.getExporter(Dimension, Platform, ExporterSettings) will return. If that method is implemented, this method must also be implemented. May be used to examine which phases the exporter requires. May return null for layers that cannot be exported.

Overrides:

getExporterType in class Layer

getExporter

public AbstractTunnelLayerExporter getExporter(Dimension dimension,
                                               Platform platform,
                                               ExporterSettings settings)

Description copied from class: Layer

Create a new exporter for this layer.

If this method is implemented, Layer.getExporterType() must also be implemented to indicate which type this method will return.

Overrides:

getExporter in class Layer

Parameters:

dimension - The dimension that is being exported.

platform - The platform for which the dimension is being exported.

settings - The configured settings for the layer, if any. May be null.

Returns:

A new exporter for this layer.

getRenderer

public PaintRenderer getRenderer()

Overrides:

getRenderer in class CustomLayer

isExportableToFile

public boolean isExportableToFile()

Description copied from class: Layer

Indicates whether this layer should be allowed to be exported to a file. This may not make sense for some layers, e.g. TunnelLayers with a floor dimension.

Overrides:

isExportableToFile in class Layer

clone

public TunnelLayer clone()

Description copied from class: CustomLayer

Create a deep copy of the custom layer, with a different ID and independent settings.

Overrides:

clone in class CustomLayer

Returns:

A deep copy of the custom layer.