Module org.spongepowered.noise

Package org.spongepowered.noise.module.source

Class Const

java.lang.Object

org.spongepowered.noise.module.NoiseModule

org.spongepowered.noise.module.source.Const

public class Const
extends NoiseModule

Noise module that outputs a constant value.

To specify the constant value, call the setValue(double) method.

This noise module is not useful by itself, but is often used as a source module for other noise modules.

Source Modules

This module does not require any source modules.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_VALUE

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

sourceModule

Constructor Summary

Constructors

Constructor	Description
Const()

Method Summary

Modifier and Type	Method	Description
double	get(double x, double y, double z)	Generates an output value given the coordinates of the specified input value.
void	setValue(double value)	Set the constant value for this noise module.
double	value()	Get the constant value for this noise 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_VALUE

public static final double DEFAULT_VALUE

See Also:

• Constant Field Values

Constructor Details

Const

public Const()

Method Details

value

public double value()

Get the constant value for this noise module.

Returns:

the constant output value for this noise module.

setValue

public void setValue(double value)

Set the constant value for this noise module.

Parameters:

value - the constant output value for this noise module.

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