org.pepsoft.worldpainter.layers

Class CustomLayer

java.lang.Object

org.pepsoft.worldpainter.layers.Layer

org.pepsoft.worldpainter.layers.CustomLayer

All Implemented Interfaces:

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

Direct Known Subclasses:

Bo2Layer, CliffCarver, CombinedLayer, CustomAnnotationLayer, GroundCoverLayer, PlantLayer, TunnelLayer, UndergroundPocketsLayer

public abstract class CustomLayer
extends Layer
implements java.lang.Cloneable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.pepsoft.worldpainter.layers.Layer

Layer.DataSize

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_DIMENSION

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

dataSize, discrete, id, priority

Constructor Summary

Constructors

Constructor and Description
CustomLayer(java.lang.String name, java.lang.String description, Layer.DataSize dataSize, int priority, char mnemonic, java.lang.Object paint)
CustomLayer(java.lang.String name, java.lang.String description, Layer.DataSize dataSize, int priority, java.lang.Object paint)

Method Summary

Modifier and Type	Method and Description
CustomLayer	clone() Create a deep copy of the custom layer, with a different ID and independent settings.
java.util.List<javax.swing.Action>	getActions() Get any actions (in addition to the standard add, edit and remove actions) for this custom layer.
int	getBiome()
java.lang.Integer	getExportIndex() Get the index indicating the export order of the layer.
java.awt.image.BufferedImage	getIcon()
float	getOpacity()
java.lang.Object	getPaint()
java.lang.String	getPalette()
java.lang.Integer	getPaletteIndex() Get the index indicating the position of the layer on its palette.
LayerRenderer	getRenderer()
java.lang.String	getType() Get a short, human-readable description of the layer type.
boolean	isExport()
boolean	isHide()
void	setBiome(int biome)
void	setExport(boolean export)
void	setExportIndex(java.lang.Integer exportIndex) Set the index indicating the export order of the layer.
void	setHide(boolean hide)
void	setMinMaxHeight(int oldMinHeight, int newMinHeight, int oldMaxHeight, int newMaxHeight, HeightTransform transform) This is invoked by WorldPainter when the dimension height is transformed (minHeight and/or maxHeight changes, and/or a shift and/or scaling operation applied), so that the layer settings may be adjusted accordingly, if applicable.
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	setOpacity(float opacity)
void	setPaint(java.lang.Object paint)
void	setPalette(java.lang.String palette)
void	setPaletteIndex(java.lang.Integer paletteIndex) Set the index indicating the position of the layer on its palette.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

KEY_DIMENSION

public static final java.lang.String KEY_DIMENSION

See Also:

Constant Field Values

Constructor Detail

CustomLayer

public CustomLayer(java.lang.String name,
                   java.lang.String description,
                   Layer.DataSize dataSize,
                   int priority,
                   java.lang.Object paint)

CustomLayer

public CustomLayer(java.lang.String name,
                   java.lang.String description,
                   Layer.DataSize dataSize,
                   int priority,
                   char mnemonic,
                   java.lang.Object paint)

Method Detail

setName

public void setName(java.lang.String name)

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

Overrides:

setName in class Layer

Parameters:

name - The new name of the layer.

getPaint

public final java.lang.Object getPaint()

setPaint

public final void setPaint(java.lang.Object paint)

getOpacity

public float getOpacity()

setOpacity

public void setOpacity(float opacity)

getBiome

public int getBiome()

setBiome

public void setBiome(int biome)

isHide

public boolean isHide()

setHide

public void setHide(boolean hide)

getPalette

public java.lang.String getPalette()

setPalette

public void setPalette(java.lang.String palette)

isExport

public boolean isExport()

setExport

public void setExport(boolean export)

getExportIndex

public java.lang.Integer getExportIndex()

Get the index indicating the export order of the layer.

setExportIndex

public void setExportIndex(java.lang.Integer exportIndex)

Set the index indicating the export order of the layer.

getPaletteIndex

public java.lang.Integer getPaletteIndex()

Get the index indicating the position of the layer on its palette.

setPaletteIndex

public void setPaletteIndex(java.lang.Integer paletteIndex)

Set the index indicating the position of the layer on its palette.

setMinMaxHeight

public void setMinMaxHeight(int oldMinHeight,
                            int newMinHeight,
                            int oldMaxHeight,
                            int newMaxHeight,
                            HeightTransform transform)

This is invoked by WorldPainter when the dimension height is transformed (minHeight and/or maxHeight changes, and/or a shift and/or scaling operation applied), so that the layer settings may be adjusted accordingly, if applicable.

The default implementation does nothing.

getType

public java.lang.String getType()

Get a short, human-readable description of the layer type.

getIcon

public java.awt.image.BufferedImage getIcon()

Overrides:

getIcon in class Layer

getRenderer

public LayerRenderer getRenderer()

Overrides:

getRenderer in class Layer

getActions

public java.util.List<javax.swing.Action> getActions()

Get any actions (in addition to the standard add, edit and remove actions) for this custom layer. They will be added to the popup menu of the layer button.

The KEY_DIMENSION value of the action will be set to the current dimension, if any, before the action is invoked.

Returns:

Any custom actions for this layer, or null if there aren't any.

clone

public CustomLayer clone()

Create a deep copy of the custom layer, with a different ID and independent settings.

Overrides:

clone in class java.lang.Object

Returns:

A deep copy of the custom layer.