org.pepsoft.worldpainter.exporting

Class BlockPropertiesCalculator

java.lang.Object

org.pepsoft.worldpainter.exporting.BlockPropertiesCalculator

public class BlockPropertiesCalculator
extends java.lang.Object

A block properties calculator for MinecraftWorlds. This can calculate properties of blocks that are influenced by neighbouring blocks and may therefore need multiple passes. It can currently calculate three properties: daylight, block light and leaf distance. It can also remove leaf blocks for which the distance is too great.

The process consists of three passes. In the first pass, the blocks are set to their initial values:

• Daylight is initialised to full daylight for those blocks not covered from above
• Block light is initialised to the appropriate value for each material according to the materials database
• The leaf distance property is removed for all leaf blocks

In the second pass, the previously calculated values are propagated into the surrounding blocks. The second pass should be repeated until no changes result from it, meaning the area has been fully processed.

In the third pass the process is finalised, e.g. any floating leaf blocks are removed. The third pass should be executed after the second pass has returned false.

This class uses the Minecraft coordinate system.

Constructor Summary

Constructors

Constructor and Description
BlockPropertiesCalculator(MinecraftWorld world, Platform platform, WorldExportSettings worldExportSettings, BlockBasedExportSettings exportSettings)

Method Summary

Modifier and Type	Method and Description
void	finalise() This should be invoked once after secondPass() has returned false, to take any necessary final steps of the process, such as removing floating leaf blocks.
void	firstPass() Set the blocks to their initial values for the current dirty area.
int[]	firstPass(Chunk chunk) Set the blocks to their initial values for one entire chunk.
org.pepsoft.util.Box	getDirtyArea() Get the current dirty area in Minecraft coordinates.
static boolean	isBlockPropertiesPassNeeded(Platform platform, WorldExportSettings worldExportSettings, BlockBasedExportSettings exportSettings)
boolean	secondPass() For the current dirty area, propagate the selected block properties to surrounding blocks.
void	setDirtyArea(org.pepsoft.util.Box dirtyArea) Set the dirty area in Minecraft coordinates.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockPropertiesCalculator

public BlockPropertiesCalculator(MinecraftWorld world,
                                 Platform platform,
                                 WorldExportSettings worldExportSettings,
                                 BlockBasedExportSettings exportSettings)

Method Detail

getDirtyArea

public org.pepsoft.util.Box getDirtyArea()

Get the current dirty area in Minecraft coordinates.

Returns:

The current dirty area in Minecraft coordinates.

setDirtyArea

public void setDirtyArea(org.pepsoft.util.Box dirtyArea)

Set the dirty area in Minecraft coordinates.

Parameters:

dirtyArea - The dirty area in Minecraft coordinates to set.

secondPass

public boolean secondPass()

For the current dirty area, propagate the selected block properties to surrounding blocks. The dirty area is constricted to the blocks that were actually changed, and false is returned if no changes were made at all (indicating that the process is complete).

firstPass

public int[] firstPass(Chunk chunk)

Set the blocks to their initial values for one entire chunk.

firstPass

public void firstPass()

Set the blocks to their initial values for the current dirty area.

finalise

public void finalise()

This should be invoked once after secondPass() has returned false, to take any necessary final steps of the process, such as removing floating leaf blocks.

isBlockPropertiesPassNeeded

public static boolean isBlockPropertiesPassNeeded(Platform platform,
                                                  WorldExportSettings worldExportSettings,
                                                  BlockBasedExportSettings exportSettings)