org.pepsoft.worldpainter.layers

Class Bo2Layer

java.lang.Object

org.pepsoft.worldpainter.layers.Layer

org.pepsoft.worldpainter.layers.CustomLayer

org.pepsoft.worldpainter.layers.Bo2Layer

All Implemented Interfaces:

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

public class Bo2Layer
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
Bo2Layer(Bo2ObjectProvider objectProvider, java.lang.String description, java.lang.Object paint)

Method Summary

Modifier and Type	Method and Description
Bo2Layer	clone() Create a deep copy of the custom layer, with a different ID and independent settings.
int	getDensity()
Bo2LayerExporter	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.
java.util.List<java.io.File>	getFiles()
int	getGridX()
int	getGridY()
Bo2ObjectProvider	getObjectProvider()
int	getRandomDisplacement()
java.lang.String	getType() Get a short, human-readable description of the layer type.
void	setDensity(int density)
void	setGridX(int gridX)
void	setGridY(int gridY)
void	setObjectProvider(Bo2ObjectProvider objectProvider)
void	setRandomDisplacement(int randomDisplacement)

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, setName, 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

Bo2Layer

public Bo2Layer(Bo2ObjectProvider objectProvider,
                java.lang.String description,
                java.lang.Object paint)

Method Detail

getObjectProvider

public Bo2ObjectProvider getObjectProvider()

setObjectProvider

public void setObjectProvider(Bo2ObjectProvider objectProvider)

getFiles

public java.util.List<java.io.File> getFiles()

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

getDensity

public int getDensity()

setDensity

public void setDensity(int density)

getGridX

public int getGridX()

setGridX

public void setGridX(int gridX)

getGridY

public int getGridY()

setGridY

public void setGridY(int gridY)

getRandomDisplacement

public int getRandomDisplacement()

setRandomDisplacement

public void setRandomDisplacement(int randomDisplacement)

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

clone

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