com.sk89q.worldedit.operation

Class GroundScatterFunction

java.lang.Object

com.sk89q.worldedit.operation.GroundFindingFunction

com.sk89q.worldedit.operation.GroundScatterFunction

All Implemented Interfaces:

FlatRegionFunction

public class GroundScatterFunction
extends GroundFindingFunction

Randomly applies the given RegionFunction onto random ground blocks.

This class can be used to generate a structure randomly over an area.

Constructor Summary

Constructors

Constructor and Description
GroundScatterFunction(EditSession editSession, RegionFunction function) Create a new instance using a RandomNoise as the noise generator.
GroundScatterFunction(EditSession editSession, RegionFunction function, NoiseGenerator noiseGenerator) Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	apply(Vector position, BaseBlock block) Apply the function to the given ground block.
double	getDensity() Get the density (0 <= density <= 1) which indicates the threshold that must be met for the function to be applied to a column.
RegionFunction	getFunction() Get the function to apply.
NoiseGenerator	getNoiseGenerator() Get the noise generator.
void	setDensity(double density) Set the density (0 <= density <= 1) which indicates the threshold that must be met for the function to be applied to a column.
void	setFunction(RegionFunction function) Set the function to apply.
void	setNoiseGenerator(NoiseGenerator noiseGenerator) Set the noise generator.
protected boolean	shouldContinue(Vector2D pt) Returns whether a search for the ground should be performed for the given column.

Methods inherited from class com.sk89q.worldedit.operation.GroundFindingFunction

apply, getLowerY, getUpperY, raiseCeiling, setRange, setRange, shouldPassThrough

Methods inherited from class java.lang.Object

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

Constructor Detail

GroundScatterFunction

public GroundScatterFunction(EditSession editSession,
                     RegionFunction function)

Create a new instance using a RandomNoise as the noise generator.

Parameters:

editSession - the edit session

function - the function

GroundScatterFunction

public GroundScatterFunction(EditSession editSession,
                     RegionFunction function,
                     NoiseGenerator noiseGenerator)

Create a new instance.

Parameters:

editSession - the edit session

function - the function

Method Detail

getDensity

public double getDensity()

Get the density (0 <= density <= 1) which indicates the threshold that must be met for the function to be applied to a column.

Returns:

the density

setDensity

public void setDensity(double density)

Set the density (0 <= density <= 1) which indicates the threshold that must be met for the function to be applied to a column.

Parameters:

density - the density

getNoiseGenerator

public NoiseGenerator getNoiseGenerator()

Get the noise generator.

Returns:

the noise generator

setNoiseGenerator

public void setNoiseGenerator(NoiseGenerator noiseGenerator)

Set the noise generator.

Parameters:

noiseGenerator - the noise generator

getFunction

public RegionFunction getFunction()

Get the function to apply.

Returns:

the region function

setFunction

public void setFunction(RegionFunction function)

Set the function to apply.

Parameters:

function - the region function

shouldContinue

protected boolean shouldContinue(Vector2D pt)

Description copied from class: GroundFindingFunction

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

Overrides:

shouldContinue in class GroundFindingFunction

Parameters:

pt - the point

Returns:

true if the search should begin

apply

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

Description copied from class: GroundFindingFunction

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.

Specified by:

apply in class GroundFindingFunction

Parameters:

position - the position

block - the block

Returns:

true if something was changed

Throws:

WorldEditException - thrown on an error