org.pepsoft.worldpainter.layers

Class Layer

java.lang.Object

org.pepsoft.worldpainter.layers.Layer

All Implemented Interfaces:

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

Direct Known Subclasses:

Annotations, Biome, Caverns, Caves, Chasms, CustomLayer, Delete, Dirty, FloodWithLava, Frost, GardenCategory, NotPresent, NotPresentBlock, Populate, ReadOnly, Resources, River, SelectionBlock, SelectionChunk, TreeLayer, Trees, Void

public abstract class Layer
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<Layer>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Layer.DataSize

Field Summary

Fields

Modifier and Type	Field and Description
Layer.DataSize	dataSize
boolean	discrete
protected java.lang.String	id
int	priority

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Layer(java.lang.String name, java.lang.String description, Layer.DataSize dataSize, boolean discrete, int priority) Deprecated.
protected	Layer(java.lang.String name, java.lang.String description, Layer.DataSize dataSize, boolean discrete, int priority, char mnemonic) Deprecated.
protected	Layer(java.lang.String id, java.lang.String name, java.lang.String description, Layer.DataSize dataSize, boolean discrete, int priority)
protected	Layer(java.lang.String id, java.lang.String name, java.lang.String description, Layer.DataSize dataSize, boolean discrete, int priority, char mnemonic)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Layer layer)
boolean	equals(java.lang.Object obj)
Layer.DataSize	getDataSize()
int	getDefaultValue() The default value which will be returned wherever the layer has not been set.
java.lang.String	getDescription()
LayerExporter	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 getExporter(Dimension, Platform, ExporterSettings) will return.
java.awt.image.BufferedImage	getIcon()
java.lang.String	getId()
char	getMnemonic()
java.lang.String	getName()
int	getPriority()
LayerRenderer	getRenderer()
int	hashCode()
boolean	isExportableToFile() Indicates whether this layer should be allowed to be exported to a file.
protected void	setDescription(java.lang.String description)
protected void	setName(java.lang.String name)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

dataSize

public final Layer.DataSize dataSize

priority

public final int priority

id

protected java.lang.String id

discrete

public boolean discrete

Constructor Detail

Layer

@Deprecated
protected Layer(java.lang.String name,
                             java.lang.String description,
                             Layer.DataSize dataSize,
                             boolean discrete,
                             int priority)

Deprecated.

Layer

@Deprecated
protected Layer(java.lang.String name,
                             java.lang.String description,
                             Layer.DataSize dataSize,
                             boolean discrete,
                             int priority,
                             char mnemonic)

Deprecated.

Layer

protected Layer(java.lang.String id,
                java.lang.String name,
                java.lang.String description,
                Layer.DataSize dataSize,
                boolean discrete,
                int priority)

Layer

protected Layer(java.lang.String id,
                java.lang.String name,
                java.lang.String description,
                Layer.DataSize dataSize,
                boolean discrete,
                int priority,
                char mnemonic)

Method Detail

getDataSize

public final Layer.DataSize getDataSize()

getName

public java.lang.String getName()

setName

protected void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

protected void setDescription(java.lang.String description)

getExporterType

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

Return the type of the exporter that 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.

getExporter

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

Create a new exporter for this layer.

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

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 LayerRenderer getRenderer()

getIcon

public java.awt.image.BufferedImage getIcon()

getMnemonic

public char getMnemonic()

getPriority

public int getPriority()

getId

public java.lang.String getId()

getDefaultValue

public int getDefaultValue()

The default value which will be returned wherever the layer has not been set. By default this is zero (or false).

Returns:

The default value which will be returned where the layer value is not set.

isExportableToFile

public boolean isExportableToFile()

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.

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public final int compareTo(Layer layer)

Specified by:

compareTo in interface java.lang.Comparable<Layer>