org.pepsoft.worldpainter.layers.pockets

Class UndergroundPocketsLayer

java.lang.Object

org.pepsoft.worldpainter.layers.Layer

org.pepsoft.worldpainter.layers.CustomLayer

org.pepsoft.worldpainter.layers.pockets.UndergroundPocketsLayer

All Implemented Interfaces:

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

public class UndergroundPocketsLayer
extends CustomLayer

See Also:

Serialized Form

Nested Class Summary

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
UndergroundPocketsLayer(java.lang.String name, MixedMaterial material, Terrain terrain, int frequency, int minLevel, int maxLevel, int scale, java.lang.Object paint)

Method Summary

Modifier and Type	Method and Description
UndergroundPocketsLayer	clone() Create a deep copy of the custom layer, with a different ID and independent settings.
UndergroundPocketsLayerExporter	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	getFrequency()
MixedMaterial	getMaterial()
int	getMaxLevel()
int	getMinLevel()
int	getScale()
Terrain	getTerrain()
java.lang.String	getType() Get a short, human-readable description of the layer type.
void	setFrequency(int frequency)
void	setMaterial(MixedMaterial material)
void	setMaxLevel(int maxLevel)
void	setMinLevel(int minLevel)
void	setName(java.lang.String name) Custom layers have names independent of their ID, so changing the name after creation is not a problem.
void	setScale(int scale)
void	setTerrain(Terrain terrain)

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UndergroundPocketsLayer

public UndergroundPocketsLayer(java.lang.String name,
                               MixedMaterial material,
                               Terrain terrain,
                               int frequency,
                               int minLevel,
                               int maxLevel,
                               int scale,
                               java.lang.Object paint)

Method Detail

setName

public void setName(java.lang.String name)

Description copied from class: CustomLayer

Custom layers have names independent of their ID, so changing the name after creation is not a problem.

Overrides:

setName in class CustomLayer

Parameters:

name - The new name of the layer.

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

getFrequency

public int getFrequency()

setFrequency

public void setFrequency(int frequency)

getMaterial

public MixedMaterial getMaterial()

setMaterial

public void setMaterial(MixedMaterial material)

getScale

public int getScale()

setScale

public void setScale(int scale)

getMaxLevel

public int getMaxLevel()

setMaxLevel

public void setMaxLevel(int maxLevel)

getMinLevel

public int getMinLevel()

setMinLevel

public void setMinLevel(int minLevel)

getTerrain

public Terrain getTerrain()

setTerrain

public void setTerrain(Terrain terrain)

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

clone

public UndergroundPocketsLayer 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.