Module org.spongepowered.noise

Package org.spongepowered.noise.module.modifier

Class Invert

java.lang.Object

org.spongepowered.noise.module.NoiseModule

org.spongepowered.noise.module.modifier.Invert

public class Invert
extends NoiseModule

Noise module that inverts the output value from a source module.

Source Modules

This module requires one source module.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_MIDDLE	The default middle value for an Invert module.

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

sourceModule

Constructor Summary

Constructors

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

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.
double	middle()	Get the middle or 'zero' value to invert around.
void	setMiddle(double middle)	Set the middle or 'zero' value to invert around.

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_MIDDLE

public static final double DEFAULT_MIDDLE

The default middle value for an Invert module.

See Also:

• Constant Field Values

Constructor Details

Invert

public Invert()

Invert

public Invert(NoiseModule source)

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

Parameters:

source - the input module

Method Details

middle

public double middle()

Get the middle or 'zero' value to invert around.

Returns:

the middle value

See Also:

• DEFAULT_MIDDLE

setMiddle

public void setMiddle(double middle)

Set the middle or 'zero' value to invert around.

Parameters:

middle - the middle value

See Also:

• DEFAULT_MIDDLE

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