org.pepsoft.worldpainter.exporting

Class AbstractLayerExporter<L extends Layer>

java.lang.Object

org.pepsoft.worldpainter.exporting.AbstractLayerExporter<L>

All Implemented Interfaces:

LayerExporter

Direct Known Subclasses:

AbstractCavesExporter, AnnotationsExporter, CliffCarverExporter, FrostExporter, GroundCoverLayerExporter, ResourcesExporter, RiverExporter, TreesExporter, UndergroundPocketsLayerExporter, VoidExporter, WPObjectExporter

public abstract class AbstractLayerExporter<L extends Layer>
extends java.lang.Object
implements LayerExporter

An abstract base class for LayerExporter implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractLayerExporter.ChunksInTilesVisitor A visitor of chunks.

Field Summary

Fields

Modifier and Type	Field and Description
protected Dimension	dimension
protected L	layer
protected int	maxHeight One more than the highest height supported by both the selected platform and configured on the dimension.
protected int	maxZ The highest height blocks should actually be placed or removed.
protected int	minHeight The lowest height supported by both the selected platform and configured on the dimension.
protected int	minZ The lowest height blocks should actually be placed or removed, taking into account such things as whether the dimension is bottomless.
protected Platform	platform
protected ExporterSettings	settings

Constructor Summary

Constructors

Constructor and Description
AbstractLayerExporter(Dimension dimension, Platform platform, ExporterSettings settings, L layer)

Method Summary

Modifier and Type	Method and Description
Dimension	getDimension()
L	getLayer()
protected boolean	visitChunksForLayerInAreaForEditing(MinecraftWorld world, Layer layer, java.awt.Rectangle area, Dimension dimension, AbstractLayerExporter.ChunksInTilesVisitor visitor) Visits the existent chunks in a particular rectangular area, and containing a particular layer, for editing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

dimension

protected final Dimension dimension

platform

protected final Platform platform

layer

protected final L extends Layer layer

minHeight

protected final int minHeight

The lowest height supported by both the selected platform and configured on the dimension.

maxHeight

protected final int maxHeight

One more than the highest height supported by both the selected platform and configured on the dimension.

minZ

protected final int minZ

The lowest height blocks should actually be placed or removed, taking into account such things as whether the dimension is bottomless.

maxZ

protected final int maxZ

The highest height blocks should actually be placed or removed.

settings

protected final ExporterSettings settings

Constructor Detail

AbstractLayerExporter

public AbstractLayerExporter(Dimension dimension,
                             Platform platform,
                             ExporterSettings settings,
                             L layer)

Method Detail

getDimension

public final Dimension getDimension()

getLayer

public final L getLayer()

Specified by:

getLayer in interface LayerExporter

visitChunksForLayerInAreaForEditing

protected final boolean visitChunksForLayerInAreaForEditing(MinecraftWorld world,
                                                            Layer layer,
                                                            java.awt.Rectangle area,
                                                            Dimension dimension,
                                                            AbstractLayerExporter.ChunksInTilesVisitor visitor)

Visits the existent chunks in a particular rectangular area, and containing a particular layer, for editing. The chunks are lazily loaded. The visitor can abort the process by returning false.

Parameters:

dimension - The dimension in which to check which tiles contain the layer.

world - The MinecraftWorld in which to visit the existent chunks.

layer - The layer to which to constrain the visited tiles.

area - The area in block coordinates in which to visit the chunks.

visitor - The visitor to invoke for each existing chunk that is in the specified area, and which is on a tile containing the specified layer.

Returns:

true is all chunks were visited, false if the visitor returned false.