Module org.spongepowered.noise

Package org.spongepowered.noise.module.combiner

Class Power

java.lang.Object

org.spongepowered.noise.module.NoiseModule

org.spongepowered.noise.module.combiner.Power

public class Power
extends NoiseModule

Noise module that raises the output value from a first source module to the power of the output value from a second source module.

The first source module must have an index value of 0.

The second source module must have an index value of 1.

Source Modules

This module requires 2 source modules.

Field Summary

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

sourceModule

Constructor Summary

Constructors

Constructor	Description
Power()
Power(NoiseModule base, NoiseModule exponent)	Create a new Power 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.

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

Constructor Details

Power

public Power()

Power

public Power(NoiseModule base,
 NoiseModule exponent)

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

Parameters:

base - the base

exponent - the exponent to raise the base to

Method Details

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