org.pepsoft.worldpainter.layers

Class TreeLayer

java.lang.Object

org.pepsoft.worldpainter.layers.Layer

org.pepsoft.worldpainter.layers.TreeLayer

All Implemented Interfaces:

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

Direct Known Subclasses:

DeciduousForest, Jungle, PineForest, SwampLand

public abstract class TreeLayer
extends Layer

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

dataSize, discrete, id, priority

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TreeLayer(java.lang.String treeName, java.lang.String treeDescription, int priority)
protected	TreeLayer(java.lang.String treeName, java.lang.String treeDescription, int priority, char mnemonic)

Method Summary

Modifier and Type	Method and Description
int	getDefaultLayerStrengthCap()
int	getDefaultMaxWaterDepth()
float	getDefaultMushroomChance()
int	getDefaultMushroomIncidence()
int	getDefaultTreeChance()
TreesExporter<? extends TreeLayer>	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.
abstract TreeType	pickTree(java.util.Random random)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeLayer

protected TreeLayer(java.lang.String treeName,
                    java.lang.String treeDescription,
                    int priority,
                    char mnemonic)

TreeLayer

protected TreeLayer(java.lang.String treeName,
                    java.lang.String treeDescription,
                    int priority)

Method Detail

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 TreesExporter<? extends TreeLayer> 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.

getDefaultMaxWaterDepth

public int getDefaultMaxWaterDepth()

getDefaultTreeChance

public int getDefaultTreeChance()

getDefaultMushroomIncidence

public int getDefaultMushroomIncidence()

getDefaultMushroomChance

public float getDefaultMushroomChance()

getDefaultLayerStrengthCap

public int getDefaultLayerStrengthCap()

pickTree

public abstract TreeType pickTree(java.util.Random random)