Module org.spongepowered.noise

Package org.spongepowered.noise.module.source

Class Cylinders

java.lang.Object

org.spongepowered.noise.module.NoiseModule

org.spongepowered.noise.module.source.Cylinders

public class Cylinders
extends NoiseModule

Noise module that outputs concentric cylinders.

This noise module outputs concentric cylinders centered on the origin. These cylinders are oriented along the y axis similar to the concentric rings of a tree. Each cylinder extends infinitely along the y axis.

By default, the first cylinder has a radius of 1.0. Each subsequent cylinder has a radius that is 1.0 unit larger than the previous cylinder.

The output value from this noise module is determined by the distance between the input value and the nearest cylinder surface. The input values that are located on a cylinder surface are given the output value 1.0 and the input values that are equidistant from two cylinder surfaces are given the output value -1.0.

An application can change the frequency of the concentric cylinders. Increasing the frequency reduces the distances between cylinders. To specify the frequency, call the setFrequency(double) method.

This noise module, modified with some low-frequency, low-power turbulence, is useful for generating wood-like textures.

Source Modules

This module does not require any source modules.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_CYLINDERS_FREQUENCY	Default frequency value for the Cylinders noise module.

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

sourceModule

Constructor Summary

Constructors

Constructor	Description
Cylinders()

Method Summary

Modifier and Type	Method	Description
double	frequency()	Get the frequency of the concentric cylinders.
double	get(double x, double y, double z)	Generates an output value given the coordinates of the specified input value.
void	setFrequency(double frequency)	Set the frequency of the concentric cylinders.

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_CYLINDERS_FREQUENCY

public static final double DEFAULT_CYLINDERS_FREQUENCY

Default frequency value for the Cylinders noise module.

See Also:

• Constant Field Values

Constructor Details

Cylinders

public Cylinders()

Method Details

frequency

public double frequency()

Get the frequency of the concentric cylinders.

Increasing the frequency increases the density of the concentric cylinders, reducing the distances between them.

Returns:

the frequency of the concentric cylinders

setFrequency

public void setFrequency(double frequency)

Set the frequency of the concentric cylinders.

Increasing the frequency increases the density of the concentric cylinders, reducing the distances between them.

Parameters:

frequency - the frequency of the concentric cylinders

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