org.pepsoft.worldpainter.layers

Class CombinedLayer

java.lang.Object

org.pepsoft.worldpainter.layers.Layer

org.pepsoft.worldpainter.layers.CustomLayer

org.pepsoft.worldpainter.layers.CombinedLayer

All Implemented Interfaces:

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

public class CombinedLayer
extends CustomLayer
implements LayerContainer

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
CombinedLayer(java.lang.String name, java.lang.String description, java.lang.Object paint)

Method Summary

Modifier and Type	Method and Description
java.util.Set<Layer>	apply(Dimension dimension)
java.util.Set<Layer>	apply(Dimension dimension, java.util.Set<java.awt.Point> selectedTiles)
java.util.Set<Layer>	apply(Tile tile)
CombinedLayer	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.
LayerExporter	getExporter(Dimension dimension, Platform platform, ExporterSettings settings) Returns a dummy exporter, all methods of which throw an UnsupportedOperationException, since combined layers must be exported by applying them and then exporting its constituent layers, if any.
java.lang.Class<? extends LayerExporter>	getExporterType() Return the type of the exporter that Layer.getExporter(Dimension, Platform, ExporterSettings) will return.
java.util.Map<Layer,java.lang.Float>	getFactors()
java.util.List<Layer>	getLayers()
Terrain	getTerrain()
java.lang.String	getType() Get a short, human-readable description of the layer type.
boolean	isApplyTerrainAndBiomeOnExport()
boolean	restoreCustomTerrain() If this combined layer contains a custom terrain, make sure that it is installed.
void	setApplyTerrainAndBiomeOnExport(boolean applyTerrainAndBiomeOnExport)
void	setFactors(java.util.Map<Layer,java.lang.Float> factors)
void	setLayers(java.util.List<Layer> layers)
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	setTerrain(Terrain terrain)

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

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

CombinedLayer

public CombinedLayer(java.lang.String name,
                     java.lang.String description,
                     java.lang.Object paint)

Method Detail

apply

public java.util.Set<Layer> apply(Dimension dimension)

apply

public java.util.Set<Layer> apply(Dimension dimension,
                                  java.util.Set<java.awt.Point> selectedTiles)

apply

public java.util.Set<Layer> apply(Tile tile)

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

getTerrain

public Terrain getTerrain()

setTerrain

public void setTerrain(Terrain terrain)

getLayers

public java.util.List<Layer> getLayers()

Specified by:

getLayers in interface LayerContainer

setLayers

public void setLayers(java.util.List<Layer> layers)

getFactors

public java.util.Map<Layer,java.lang.Float> getFactors()

setFactors

public void setFactors(java.util.Map<Layer,java.lang.Float> factors)

isApplyTerrainAndBiomeOnExport

public boolean isApplyTerrainAndBiomeOnExport()

setApplyTerrainAndBiomeOnExport

public void setApplyTerrainAndBiomeOnExport(boolean applyTerrainAndBiomeOnExport)

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 LayerExporter getExporter(Dimension dimension,
                                 Platform platform,
                                 ExporterSettings settings)

Returns a dummy exporter, all methods of which throw an UnsupportedOperationException, since combined layers must be exported by applying them and then exporting its constituent layers, if any.

The exporter does implement FirstPassLayerExporter and SecondPassLayerExporter though, to signal the fact that it can contain layers for both phases.

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 dummy exporter which always throws UnsupportedOperationException.

getActions

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

Description copied from class: CustomLayer

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 CustomLayer.KEY_DIMENSION value of the action will be set to the current dimension, if any, before the action is invoked.

Overrides:

getActions in class CustomLayer

Returns:

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

restoreCustomTerrain

public boolean restoreCustomTerrain()

If this combined layer contains a custom terrain, make sure that it is installed. If the original material is available as a custom terrain type, use that, otherwise install the material as a new custom terrain type, assuming a slot is available. Should be invoked once, after a combined layer has been loaded.

Returns false if a custom terrain was present but it could not be restored because all custom terrain slots are in use, true in all other circumstances.

Please note: if this returns true a new custom terrain may have been installed, so in that case the invoker MUST check whether a button already exists for the custom terrain used by this combined layer, and add one if not.

Returns:

false if a custom terrain was present but it could not be restored because all custom terrain slots are in use, true otherwise.

clone

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