com.sk89q.worldedit.operation

Class GroundFindingFunction

java.lang.Object

com.sk89q.worldedit.operation.GroundFindingFunction

All Implemented Interfaces:

FlatRegionFunction

Direct Known Subclasses:

GroundScatterFunction

public abstract class GroundFindingFunction
extends Object
implements FlatRegionFunction

An abstract implementation of FlatRegionFunction that searches for the first "ground" block." A ground block is found when the method shouldPassThrough(Vector, BaseBlock) returns false, which, by default, does so for all non-air blocks.

This function starts from the provided upperY in each block column and traverses down the column until it finds the first ground block, at which point apply(Vector, BaseBlock) is called with the position and the BaseBlock for the found ground block. Implementations that want to skip certain columns (and avoid the ground search) can override shouldContinue(com.sk89q.worldedit.Vector2D) and return true as necessary.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GroundFindingFunction(EditSession editSession) Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	apply(Vector2D pt) Apply the function to the given point.
protected abstract boolean	apply(Vector position, BaseBlock block) Apply the function to the given ground block.
int	getLowerY() Get the lower Y coordinate to end the ground search at.
int	getUpperY() Get the upper Y coordinate to start the ground search from.
void	raiseCeiling(int y) Increase the upper Y by the given amount.
void	setRange(int lowerY, int upperY) Set the range of Y coordinates to perform a search for ground within.
void	setRange(Region region) Set the range of Y coordinates to perform a search for ground within from the minimum and maximum Y of the given region.
protected boolean	shouldContinue(Vector2D pt) Returns whether a search for the ground should be performed for the given column.
protected boolean	shouldPassThrough(Vector position, BaseBlock block) Returns whether the given block should be "passed through" when conducting the ground search.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroundFindingFunction

protected GroundFindingFunction(EditSession editSession)

Create a new instance.

Parameters:

editSession - the edit session

Method Detail

getUpperY

public int getUpperY()

Get the upper Y coordinate to start the ground search from.

Returns:

the upper Y coordinate

getLowerY

public int getLowerY()

Get the lower Y coordinate to end the ground search at.

Returns:

lowerY the lower Y coordinate

setRange

public void setRange(int lowerY,
            int upperY)

Set the range of Y coordinates to perform a search for ground within.

Parameters:

lowerY - the lower Y coordinate

upperY - the upper Y coordinate (upperY >= lowerY)

setRange

public void setRange(Region region)

Set the range of Y coordinates to perform a search for ground within from the minimum and maximum Y of the given region.

Parameters:

region - the region

raiseCeiling

public void raiseCeiling(int y)

Increase the upper Y by the given amount.

Parameters:

y - the amount to increase the upper Y by

apply

public final boolean apply(Vector2D pt)
                    throws WorldEditException

Description copied from interface: FlatRegionFunction

Apply the function to the given point.

Specified by:

apply in interface FlatRegionFunction

Parameters:

pt - the point

Returns:

true if something was changed

Throws:

WorldEditException - thrown on an error

shouldContinue

protected boolean shouldContinue(Vector2D pt)

Returns whether a search for the ground should be performed for the given column. Return false if the column is to be skipped.

Parameters:

pt - the point

Returns:

true if the search should begin

shouldPassThrough

protected boolean shouldPassThrough(Vector position,
                        BaseBlock block)

Returns whether the given block should be "passed through" when conducting the ground search.

Examples of blocks where this method could return true include snow, tall grass, shrubs, and flowers. Note that this method will also receive calls on each air block so that condition must be handled. Be aware that blocks passed through are not automatically removed from the world, so implementations may need to remove the block immediately above the ground.

The default implementation only returns true for air blocks.

Parameters:

position - the position

block - the block

Returns:

true if the block should be passed through during the ground search

apply

protected abstract boolean apply(Vector position,
            BaseBlock block)
                          throws WorldEditException

Apply the function to the given ground block.

Naive implementations may provide flowers, tall grass, and other blocks not often considered to be the ground as the ground block.

Parameters:

position - the position

block - the block

Returns:

true if something was changed

Throws:

WorldEditException - thrown on an error