org.pepsoft.worldpainter.exporting

Class PostProcessor

java.lang.Object

org.pepsoft.worldpainter.exporting.PostProcessor

Direct Known Subclasses:

Java1_15PostProcessor, Java1_2PostProcessor

public abstract class PostProcessor
extends java.lang.Object

Helper class which can post process a fully rendered map to make sure it doesn't violate any rules.

Created by Pepijn on 25-2-2017.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	enabled

Constructor Summary

Constructors

Constructor and Description
PostProcessor()

Method Summary

Modifier and Type	Method and Description
protected boolean	containsAnyWater(Material material) Whether the material is any kind of water, including falling or flowing water (with a non zero level).
protected void	dropBlock(MinecraftWorld world, int x, int y, int z)
protected void	dropFluid(MinecraftWorld world, int x, int y, int z)
protected boolean	isLavaContained(MinecraftWorld world, int x, int y, int z, Material materialBelow)
protected boolean	isWaterContained(MinecraftWorld world, int x, int y, int z, Material materialBelow)
abstract void	postProcess(MinecraftWorld minecraftWorld, org.pepsoft.util.Box volume, ExportSettings exportSettings, org.pepsoft.util.ProgressReceiver progressReceiver) Post process (part of) a MinecraftWorld to make sure it conforms to platform rules.
void	postProcess(MinecraftWorld minecraftWorld, java.awt.Rectangle area, ExportSettings exportSettings, org.pepsoft.util.ProgressReceiver progressReceiver) Post process (part of) a MinecraftWorld to make sure it conforms to platform rules.

Methods inherited from class java.lang.Object

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

Field Detail

enabled

public static final boolean enabled

Constructor Detail

PostProcessor

public PostProcessor()

Method Detail

postProcess

public void postProcess(MinecraftWorld minecraftWorld,
                        java.awt.Rectangle area,
                        ExportSettings exportSettings,
                        org.pepsoft.util.ProgressReceiver progressReceiver)
                 throws org.pepsoft.util.ProgressReceiver.OperationCancelled

Post process (part of) a MinecraftWorld to make sure it conforms to platform rules.

Parameters:

minecraftWorld - The MinecraftWorld to post process.

area - The area of the world to post process from top to bottom.

exportSettings - The export settings to apply, if any. May be null, in which case the post processor should use default settings. If the settings are of an unsupported type and/or belong to a different platform, they must be silently ignored rather than cause an exception.

progressReceiver - The optional progress receiver to which to report progress. May be null.

Throws:

ProgressReceiver.OperationCancelled - If the progress receiver threw an OperationCancelled exception.

postProcess

public abstract void postProcess(MinecraftWorld minecraftWorld,
                                 org.pepsoft.util.Box volume,
                                 ExportSettings exportSettings,
                                 org.pepsoft.util.ProgressReceiver progressReceiver)
                          throws org.pepsoft.util.ProgressReceiver.OperationCancelled

Post process (part of) a MinecraftWorld to make sure it conforms to platform rules.

Parameters:

minecraftWorld - The MinecraftWorld to post process.

volume - The three dimensional area of the world to post process.

exportSettings - The export settings to apply, if any. May be null, in which case the post processor should use default settings. If the settings are of an unsupported type and/or belong to a * different platform, they must be silently ignored rather than cause an exception.

progressReceiver - The optional progress receiver to which to report progress. May be null.

Throws:

ProgressReceiver.OperationCancelled - If the progress receiver threw an OperationCancelled exception.

dropBlock

protected final void dropBlock(MinecraftWorld world,
                               int x,
                               int y,
                               int z)

dropFluid

protected final void dropFluid(MinecraftWorld world,
                               int x,
                               int y,
                               int z)

isWaterContained

protected final boolean isWaterContained(MinecraftWorld world,
                                         int x,
                                         int y,
                                         int z,
                                         Material materialBelow)

containsAnyWater

protected final boolean containsAnyWater(Material material)

Whether the material is any kind of water, including falling or flowing water (with a non zero level).

isLavaContained

protected final boolean isLavaContained(MinecraftWorld world,
                                        int x,
                                        int y,
                                        int z,
                                        Material materialBelow)