org.pepsoft.worldpainter

Class NoiseSettings

java.lang.Object

org.pepsoft.worldpainter.NoiseSettings

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class NoiseSettings
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Settings for a noise generator.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NoiseSettings()
NoiseSettings(long seed, int range, int roughness, float scale)

Method Summary

Modifier and Type	Method and Description
NoiseSettings	clone()
boolean	equals(java.lang.Object o)
int	getRange() The range of the noise generator.
int	getRoughness() A measure of the roughness of the noise.
float	getScale() The scale of the noise.
long	getSeed() The seed to use to initialise the noise generator.
int	hashCode()
void	setRange(int range)
void	setRoughness(int roughness)
void	setScale(float scale)
void	setSeed(long seed)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NoiseSettings

public NoiseSettings()

NoiseSettings

public NoiseSettings(long seed,
                     int range,
                     int roughness,
                     float scale)

Method Detail

getSeed

public long getSeed()

The seed to use to initialise the noise generator.

setSeed

public void setSeed(long seed)

getRange

public int getRange()

The range of the noise generator. Values returned by the generator will be between 0 (inclusive) and range (exclusive).

setRange

public void setRange(int range)

getScale

public float getScale()

The scale of the noise. A scale of 1.0 means "regular" or "default" size peaks and troughs, the actual size of which is determined by the noise generator.

setScale

public void setScale(float scale)

getRoughness

public int getRoughness()

A measure of the roughness of the noise. A value of 0 produces very smooth noise, higher values produce progressively rougher, more chaotic noise.

setRoughness

public void setRoughness(int roughness)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public NoiseSettings clone()

Overrides:

clone in class java.lang.Object