org.pepsoft.worldpainter.exporting

Interface SecondPassLayerExporter

All Superinterfaces:

LayerExporter

All Known Implementing Classes:

AnnotationsExporter, Bo2LayerExporter, CavernsExporter, CavesExporter, ChasmsExporter, CliffCarverExporter, FloatingLayerExporter, FrostExporter, PlantLayerExporter, RiverExporter, SwampLandExporter, TreesExporter, TunnelLayerExporter, VoidExporter

public interface SecondPassLayerExporter
extends LayerExporter

An exporter which will be invoked in a second pass, after all chunks have been generated. This is for exporters which need information from, or make changes to, neighbouring chunks.

There are multiple stages in which this exporter may be invoked. Each stage is finished for all layers before the next stage is started. The exporter should indicate with getStages()} for which stages it would like to be invoked.

Implementations should implement carve(Rectangle, Rectangle, MinecraftWorld) and/or addFeatures(Rectangle, Rectangle, MinecraftWorld) and implement getStages() accordingly.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SecondPassLayerExporter.Stage

Method Summary

Modifier and Type	Method and Description
default java.util.List<Fixup>	addFeatures(java.awt.Rectangle area, java.awt.Rectangle exportedArea, MinecraftWorld minecraftWorld) Add features to an area of the map.
default java.util.List<Fixup>	carve(java.awt.Rectangle area, java.awt.Rectangle exportedArea, MinecraftWorld minecraftWorld) Carve an area of the map.
default java.util.Set<SecondPassLayerExporter.Stage>	getStages()
default java.util.List<Fixup>	render(Dimension dimension, java.awt.Rectangle area, java.awt.Rectangle exportedArea, MinecraftWorld minecraftWorld, Platform platform) Deprecated. Use carve(Rectangle, Rectangle, MinecraftWorld) instead.

Methods inherited from interface org.pepsoft.worldpainter.exporting.LayerExporter

getLayer

Method Detail

getStages

default java.util.Set<SecondPassLayerExporter.Stage> getStages()

carve

default java.util.List<Fixup> carve(java.awt.Rectangle area,
                                    java.awt.Rectangle exportedArea,
                                    MinecraftWorld minecraftWorld)

Carve an area of the map. Will be invoked if getStages() contains SecondPassLayerExporter.Stage.CARVE.

Parameters:

area - The area to process.

exportedArea - The area which will actually be exported. May be smaller than area. May be used to for instance avoid objects getting cut off at area boundaries.

minecraftWorld - The MinecraftWorld to which to export the layer.

Returns:

An optional list of fixups which should be executed after all regions have been exported.

addFeatures

default java.util.List<Fixup> addFeatures(java.awt.Rectangle area,
                                          java.awt.Rectangle exportedArea,
                                          MinecraftWorld minecraftWorld)

Add features to an area of the map. Will be invoked if getStages() contains SecondPassLayerExporter.Stage.ADD_FEATURES, after the SecondPassLayerExporter.Stage.CARVE stage is finished for all layers.

Parameters:

area - The area to process.

exportedArea - The area which will actually be exported. May be smaller than area. May be used to for instance avoid objects getting cut off at area boundaries.

minecraftWorld - The MinecraftWorld to which to export the layer.

Returns:

An optional list of fixups which should be executed after all regions have been exported.

render

@Deprecated
default java.util.List<Fixup> render(Dimension dimension,
                                                  java.awt.Rectangle area,
                                                  java.awt.Rectangle exportedArea,
                                                  MinecraftWorld minecraftWorld,
                                                  Platform platform)

Deprecated. Use carve(Rectangle, Rectangle, MinecraftWorld) instead.