org.pepsoft.worldpainter.layers.groundcover

Class GroundCoverLayer

java.lang.Object

org.pepsoft.worldpainter.layers.Layer

org.pepsoft.worldpainter.layers.CustomLayer

org.pepsoft.worldpainter.layers.groundcover.GroundCoverLayer

All Implemented Interfaces:

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

public class GroundCoverLayer
extends CustomLayer

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroundCoverLayer.EdgeShape
static class	GroundCoverLayer.LayerAnchor The anchor relative to which the layers of a layered material should be placed.

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
GroundCoverLayer(java.lang.String name, MixedMaterial material, java.lang.Object paint)

Method Summary

Modifier and Type	Method and Description
GroundCoverLayer	clone() Create a deep copy of the custom layer, with a different ID and independent settings.
GroundCoverLayer.EdgeShape	getEdgeShape()
int	getEdgeWidth()
GroundCoverLayerExporter	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.
GroundCoverLayer.LayerAnchor	getLayerAnchor()
MixedMaterial	getMaterial()
NoiseSettings	getNoiseSettings()
int	getThickness()
java.lang.String	getType() Get a short, human-readable description of the layer type.
boolean	isSmooth()
void	setEdgeShape(GroundCoverLayer.EdgeShape edgeShape)
void	setEdgeWidth(int edgeWidth)
void	setLayerAnchor(GroundCoverLayer.LayerAnchor layerAnchor)
void	setMaterial(MixedMaterial material)
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	setNoiseSettings(NoiseSettings noiseSettings)
void	setSmooth(boolean smooth)
void	setThickness(int thickness)

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

GroundCoverLayer

public GroundCoverLayer(java.lang.String name,
                        MixedMaterial material,
                        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

getMaterial

public MixedMaterial getMaterial()

setMaterial

public void setMaterial(MixedMaterial material)

getThickness

public int getThickness()

setThickness

public void setThickness(int thickness)

getEdgeWidth

public int getEdgeWidth()

setEdgeWidth

public void setEdgeWidth(int edgeWidth)

getEdgeShape

public GroundCoverLayer.EdgeShape getEdgeShape()

setEdgeShape

public void setEdgeShape(GroundCoverLayer.EdgeShape edgeShape)

getNoiseSettings

public NoiseSettings getNoiseSettings()

setNoiseSettings

public void setNoiseSettings(NoiseSettings noiseSettings)

isSmooth

public boolean isSmooth()

setSmooth

public void setSmooth(boolean smooth)

getLayerAnchor

public GroundCoverLayer.LayerAnchor getLayerAnchor()

setLayerAnchor

public void setLayerAnchor(GroundCoverLayer.LayerAnchor layerAnchor)

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 GroundCoverLayerExporter 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 GroundCoverLayer 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.