Module org.spongepowered.noise

Package org.spongepowered.noise.module.modifier

Class Range

java.lang.Object

org.spongepowered.noise.module.NoiseModule

org.spongepowered.noise.module.modifier.Range

public class Range
extends NoiseModule

A modifier module to map a value from one range to another.

For example: 0.5 (-1 < x < 1) -> 0.75 (0 < x < 1)

Source Modules

This module requires one source module.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_CURRENT_LOWER_BOUND
static final double	DEFAULT_CURRENT_UPPER_BOUND
static final double	DEFAULT_NEW_LOWER_BOUND
static final double	DEFAULT_NEW_UPPER_BOUND

Fields inherited from class org.spongepowered.noise.module.NoiseModule

sourceModule

Constructor Summary

Constructors

Constructor	Description
Range()
Range(NoiseModule source)	Create a new Range module with the source modules pre-configured.

Method Summary

Modifier and Type	Method	Description
double	currentLowerBound()
double	currentUpperBound()
double	get(double x, double y, double z)	Generates an output value given the coordinates of the specified input value.
double	newLowerBound()
double	newUpperBound()
void	setBounds(double currentLower, double currentUpper, double newLower, double newUpper)	Configure bounds for range module

Methods inherited from class org.spongepowered.noise.module.NoiseModule

setSourceModule, sourceModule, sourceModuleCount

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CURRENT_LOWER_BOUND

public static final double DEFAULT_CURRENT_LOWER_BOUND

See Also:

• Constant Field Values

DEFAULT_CURRENT_UPPER_BOUND

public static final double DEFAULT_CURRENT_UPPER_BOUND

See Also:

• Constant Field Values

DEFAULT_NEW_LOWER_BOUND

public static final double DEFAULT_NEW_LOWER_BOUND

See Also:

• Constant Field Values

DEFAULT_NEW_UPPER_BOUND

public static final double DEFAULT_NEW_UPPER_BOUND

See Also:

• Constant Field Values

Constructor Details

Range

public Range()

Range

public Range(NoiseModule source)

Create a new Range module with the source modules pre-configured.

Parameters:

source - the input module

Method Details

currentLowerBound

public double currentLowerBound()

currentUpperBound

public double currentUpperBound()

newLowerBound

public double newLowerBound()

newUpperBound

public double newUpperBound()

setBounds

public void setBounds(double currentLower,
 double currentUpper,
 double newLower,
 double newUpper)

Configure bounds for range module

Parameters:

currentLower - current lower bound

currentUpper - current upper bound

newLower - new lower bound

newUpper - new upper bound

get

public double get(double x,
 double y,
 double z)

Description copied from class: NoiseModule

Generates an output value given the coordinates of the specified input value.

All source modules required by this module must have been connected with the NoiseModule.setSourceModule(int, NoiseModule) method. If these source modules are not connected, this method will throw a NoModuleException.

To determine the number of source modules required by this noise module, call the NoiseModule.sourceModuleCount() method.

Specified by:

get in class NoiseModule

Parameters:

x - the x coordinate of the input value

y - the y coordinate of the input value

z - the z coordinate of the input value

Returns:

the output value