net.malisis.core.util.floodfill

Class FloodFill

java.lang.Object

net.malisis.core.util.floodfill.FloodFill

public class FloodFill
extends java.lang.Object

The FloodFill tool gives a customizable way to perform flood fill algorithm in the world.
A custom predicate can be provided to check if whether a position should be processed. And a consumer can also be used for each processed position if needed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FloodFill.FloodFillBuilder Builder for FloodFill.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	countLimit Maximum number of position to process.
protected java.util.function.BiConsumer<net.minecraft.world.World,net.minecraft.util.math.BlockPos>	onProcess Function to execute for each position processed.
protected net.minecraft.util.math.BlockPos	origin Starting position for the flood fill.
protected net.minecraft.block.state.IBlockState	originState IBlockState of the origin position .
protected java.util.Set<net.minecraft.util.math.BlockPos>	processed List of positions already processed.
protected java.util.EnumSet<net.minecraft.util.EnumFacing>	searchDirs Directions to use when expending the positions to be processed.
protected java.util.function.BiPredicate<net.minecraft.world.World,net.minecraft.util.math.BlockPos>	shouldProcess Predicate to check whether a position should be processed.
protected java.util.ArrayDeque<net.minecraft.util.math.BlockPos>	toProcess List of position that has yet to be processed.
protected net.minecraft.world.World	world World to perform the flood fill.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FloodFill(net.minecraft.world.World world, net.minecraft.util.math.BlockPos origin, java.util.function.BiPredicate<net.minecraft.world.World,net.minecraft.util.math.BlockPos> shouldProcess, java.util.function.BiConsumer<net.minecraft.world.World,net.minecraft.util.math.BlockPos> onProcess, java.util.EnumSet<net.minecraft.util.EnumFacing> searchDirs, int countLimit) Instantiates a new FloodFill.

Method Summary

Modifier and Type	Method and Description
static FloodFill.FloodFillBuilder	builder(net.minecraft.world.World world) Creates the FloodFill.FloodFillBuilder for a FloodFill.
net.minecraft.util.math.BlockPos	getOrigin() Gets the stating position of this FloodFill.
net.minecraft.block.state.IBlockState	getOriginState() Gets the origin IBlockState for this FloodFill.
java.util.Set<net.minecraft.util.math.BlockPos>	getProcessed() Gets the list of BlockPos already processed.
java.util.Set<net.minecraft.util.math.BlockPos>	getToProcess()
boolean	process() Processes a single position.
protected void	process(net.minecraft.util.math.BlockPos pos) Processes the position.
boolean	process(int maxCount) Processes maxCount positions, or until
void	processAll() Performs the algorithm completely, until no more position is left to process, or until countLimit is reached.
boolean	processStep() Processes all currently known positions to be processed, or until countLimit is reached.
protected boolean	shouldProcessed(net.minecraft.util.math.BlockPos pos) Checks whether the position should be processed.

Methods inherited from class java.lang.Object

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

Field Detail

world

protected net.minecraft.world.World world

World to perform the flood fill.

origin

protected net.minecraft.util.math.BlockPos origin

Starting position for the flood fill.

originState

protected net.minecraft.block.state.IBlockState originState

IBlockState of the origin position .

shouldProcess

protected java.util.function.BiPredicate<net.minecraft.world.World,net.minecraft.util.math.BlockPos> shouldProcess

Predicate to check whether a position should be processed.

onProcess

protected java.util.function.BiConsumer<net.minecraft.world.World,net.minecraft.util.math.BlockPos> onProcess

Function to execute for each position processed.

searchDirs

protected java.util.EnumSet<net.minecraft.util.EnumFacing> searchDirs

Directions to use when expending the positions to be processed.

countLimit

protected int countLimit

Maximum number of position to process.

processed

protected java.util.Set<net.minecraft.util.math.BlockPos> processed

List of positions already processed.

toProcess

protected java.util.ArrayDeque<net.minecraft.util.math.BlockPos> toProcess

List of position that has yet to be processed.

Constructor Detail

FloodFill

protected FloodFill(net.minecraft.world.World world,
                    net.minecraft.util.math.BlockPos origin,
                    java.util.function.BiPredicate<net.minecraft.world.World,net.minecraft.util.math.BlockPos> shouldProcess,
                    java.util.function.BiConsumer<net.minecraft.world.World,net.minecraft.util.math.BlockPos> onProcess,
                    java.util.EnumSet<net.minecraft.util.EnumFacing> searchDirs,
                    int countLimit)

Instantiates a new FloodFill.

Parameters:

world - the world

origin - the origin

shouldProcess - the should parse

onProcess - the on parse

searchDirs - the search dirs

countLimit - the count limit

Method Detail

getOrigin

public net.minecraft.util.math.BlockPos getOrigin()

Gets the stating position of this FloodFill.

Returns:

the origin

getOriginState

public net.minecraft.block.state.IBlockState getOriginState()

Gets the origin IBlockState for this FloodFill.

Returns:

the origin state

getProcessed

public java.util.Set<net.minecraft.util.math.BlockPos> getProcessed()

Gets the list of BlockPos already processed.

Returns:

the parsed

getToProcess

public java.util.Set<net.minecraft.util.math.BlockPos> getToProcess()

processAll

public void processAll()

Performs the algorithm completely, until no more position is left to process, or until countLimit is reached.

processStep

public boolean processStep()

Processes all currently known positions to be processed, or until countLimit is reached.

Returns:

true, if there are more position to process

process

public boolean process(int maxCount)

Processes maxCount positions, or until

Parameters:

maxCount - the max count

Returns:

true, if there are more position to process

process

public boolean process()

Processes a single position.

Returns:

true, if there are more position to process

shouldProcessed

protected boolean shouldProcessed(net.minecraft.util.math.BlockPos pos)

Checks whether the position should be processed.

Parameters:

pos - the pos

Returns:

true, if successful

process

protected void process(net.minecraft.util.math.BlockPos pos)

Processes the position.

Parameters:

pos - the pos

builder

public static FloodFill.FloodFillBuilder builder(net.minecraft.world.World world)

Creates the FloodFill.FloodFillBuilder for a FloodFill.

Parameters:

world - the world

Returns:

the flood fill builder