squidpony.squidmath

Class WhirlingNoise

java.lang.Object

squidpony.squidmath.SeededNoise

squidpony.squidmath.WhirlingNoise

All Implemented Interfaces:

java.io.Serializable, Noise.Noise2D, Noise.Noise3D, Noise.Noise4D, Noise.Noise5D, Noise.Noise6D

public class WhirlingNoise
extends SeededNoise
implements Noise.Noise2D, Noise.Noise3D, Noise.Noise4D, Noise.Noise6D, java.io.Serializable

A Noise class that's here for compatibility; it extends SeededNoise and delegates to it for all methods except noiseAlt(double, double) and noiseAlt(double, double, double). Normally you should use SeededNoise directly for new code if you expect to mostly use the inner classes in Noise for special effects, or FastNoise if you want the effects all in one place or to use float instead of double.
Created by Tommy Ettinger on 12/14/2016. The technique for point hashing in the "noiseAlt" code is based closely on this paper, with credit to Andrew Kensler, Aaron Knoll and Peter Shirley. This technique is good, but it may be periodic in undesirable ways, and isn't much faster when implemented in Java than IntPointHash, if at all.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static float[][]	grad3f The 32 3D vertices of a rhombic triacontahedron.
static WhirlingNoise	instance
static int[]	perm_u
static int[]	perm_v
static int[]	perm_w
static int[]	perm_x
static int[]	perm_y
static int[]	perm_z

Fields inherited from class squidpony.squidmath.SeededNoise

defaultSeed, F2, F3, F4, F5, F6, G2, G3, G4, G5, G6, grad2d, grad3d, grad4d, grad5d, grad6d, H2, LIMIT4, LIMIT5, LIMIT6, SIMPLEX_4D

Constructor Summary

Constructors

Constructor and Description
WhirlingNoise()
WhirlingNoise(long seed)

Method Summary

Modifier and Type	Method and Description
protected static float	dotf(float[] g, float x, float y, float z)
double	getNoise(double x, double y) Delegates to SeededNoise.noise(double, double, long) with the initial seed given to this object.
double	getNoise(double x, double y, double z) Delegates to SeededNoise.noise(double, double, double, long) with the initial seed given to this object.
double	getNoise(double x, double y, double z, double w) Delegates to SeededNoise.noise(double, double, double, double, long) with the initial seed given to this object.
double	getNoiseWithSeed(double x, double y, double z, double w, long seed) Delegates to SeededNoise.noise(double, double, double, double, long).
double	getNoiseWithSeed(double x, double y, double z, long seed) Delegates to SeededNoise.noise(double, double, double, long).
double	getNoiseWithSeed(double x, double y, long seed) Delegates to SeededNoise.noise(double, double, long).
static double	noise(double xin, double yin) Delegates to SeededNoise.noise(double, double, long) with 123456789 as the seed.
static double	noise(double xin, double yin, double zin) Delegates to SeededNoise.noise(double, double, double, long) with 123456789 as the seed.
static double	noise(double x, double y, double z, double w) Delegates to SeededNoise.noise(double, double, double, double, long) with 123456789 as the seed.
static double	noise(double x, double y, double z, double w, long seed) Delegates to SeededNoise.noise(double, double, double, double, long).
static double	noise(double xin, double yin, double zin, long seed) Delegates to SeededNoise.noise(double, double, double, long).
static double	noise(double xin, double yin, long seed) Delegates to SeededNoise.noise(double, double, long).
static float	noiseAlt(double x, double y) 2D simplex noise returning a float; extremely similar to noise(double, double), but this may be slightly faster or slightly slower.
static float	noiseAlt(double x, double y, double z) 3D simplex noise returning a float; extremely similar to noise(double, double, double), but this may be slightly faster or slightly slower.

Methods inherited from class squidpony.squidmath.SeededNoise

getNoise, getNoise, getNoiseWithSeed, getNoiseWithSeed, gradCoord2D, gradCoord3D, gradCoord5D, noise, noise

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface squidpony.squidmath.Noise.Noise6D

getNoise, getNoiseWithSeed

Field Detail

instance

public static final WhirlingNoise instance

grad3f

protected static final float[][] grad3f

The 32 3D vertices of a rhombic triacontahedron. These were modified from values taken from Vladimir Bulatov's stellation applet, which has available source but is unlicensed, and is available here, but the vertices are mathematical constants so copyright isn't an issue.

perm_x

public static final int[] perm_x

perm_y

public static final int[] perm_y

perm_z

public static final int[] perm_z

perm_w

public static final int[] perm_w

perm_u

public static final int[] perm_u

perm_v

public static final int[] perm_v

Constructor Detail

WhirlingNoise

public WhirlingNoise()

WhirlingNoise

public WhirlingNoise(long seed)

Method Detail

dotf

protected static float dotf(float[] g,
                            float x,
                            float y,
                            float z)

getNoise

public double getNoise(double x,
                       double y)

Delegates to SeededNoise.noise(double, double, long) with the initial seed given to this object.

Specified by:

getNoise in interface Noise.Noise2D

Overrides:

getNoise in class SeededNoise

Parameters:

x - X input

y - Y input

Returns:

noise from -1.0 to 1.0, inclusive

getNoiseWithSeed

public double getNoiseWithSeed(double x,
                               double y,
                               long seed)

Delegates to SeededNoise.noise(double, double, long).

Specified by:

getNoiseWithSeed in interface Noise.Noise2D

Overrides:

getNoiseWithSeed in class SeededNoise

Parameters:

x - X input

y - Y input

seed - will completely alter the shape of the noise if changed between calls

Returns:

noise from -1.0 to 1.0, inclusive

getNoise

public double getNoise(double x,
                       double y,
                       double z)

Delegates to SeededNoise.noise(double, double, double, long) with the initial seed given to this object.

Specified by:

getNoise in interface Noise.Noise3D

Overrides:

getNoise in class SeededNoise

Parameters:

x - X input

y - Y input

z - Z input

Returns:

noise from -1.0 to 1.0, inclusive

getNoiseWithSeed

public double getNoiseWithSeed(double x,
                               double y,
                               double z,
                               long seed)

Delegates to SeededNoise.noise(double, double, double, long).

Specified by:

getNoiseWithSeed in interface Noise.Noise3D

Overrides:

getNoiseWithSeed in class SeededNoise

Parameters:

x - X input

y - Y input

z - Z input

seed - will completely alter the shape of the noise if changed between calls

Returns:

noise from -1.0 to 1.0, inclusive

getNoise

public double getNoise(double x,
                       double y,
                       double z,
                       double w)

Delegates to SeededNoise.noise(double, double, double, double, long) with the initial seed given to this object.

Specified by:

getNoise in interface Noise.Noise4D

Overrides:

getNoise in class SeededNoise

Parameters:

x - X input

y - Y input

z - Z input

w - W input (fourth-dimension)

Returns:

noise from -1.0 to 1.0, inclusive

getNoiseWithSeed

public double getNoiseWithSeed(double x,
                               double y,
                               double z,
                               double w,
                               long seed)

Delegates to SeededNoise.noise(double, double, double, double, long).

Specified by:

getNoiseWithSeed in interface Noise.Noise4D

Overrides:

getNoiseWithSeed in class SeededNoise

Parameters:

x - X input

y - Y input

z - Z input

w - W input (fourth-dimension)

seed - will completely alter the shape of the noise if changed between calls

Returns:

noise from -1.0 to 1.0, inclusive

noise

public static double noise(double xin,
                           double yin)

Delegates to SeededNoise.noise(double, double, long) with 123456789 as the seed.

Parameters:

xin - X input

yin - Y input

Returns:

noise from -1.0 to 1.0, inclusive

noise

public static double noise(double xin,
                           double yin,
                           long seed)

Delegates to SeededNoise.noise(double, double, long).

Parameters:

xin - X input

yin - Y input

seed - will completely alter the shape of the noise if changed between calls

Returns:

noise from -1.0 to 1.0, inclusive

noise

public static double noise(double xin,
                           double yin,
                           double zin)

Delegates to SeededNoise.noise(double, double, double, long) with 123456789 as the seed.

Parameters:

xin - X input

yin - Y input

zin - Z input

Returns:

noise from -1.0 to 1.0, inclusive

noise

public static double noise(double xin,
                           double yin,
                           double zin,
                           long seed)

Delegates to SeededNoise.noise(double, double, double, long).

Parameters:

xin - X input

yin - Y input

zin - Z input

seed - will completely alter the shape of the noise if changed between calls

Returns:

noise from -1.0 to 1.0, inclusive

noise

public static double noise(double x,
                           double y,
                           double z,
                           double w)

Delegates to SeededNoise.noise(double, double, double, double, long) with 123456789 as the seed.

Parameters:

x - X input

y - Y input

z - Z input

w - W input (fourth-dimensional)

Returns:

noise from -1.0 to 1.0, inclusive

noise

public static double noise(double x,
                           double y,
                           double z,
                           double w,
                           long seed)

Delegates to SeededNoise.noise(double, double, double, double, long).

Parameters:

x - X input

y - Y input

z - Z input

w - W input (fourth-dimensional)

seed - will completely alter the shape of the noise if changed between calls

Returns:

noise from -1.0 to 1.0, inclusive

noiseAlt

public static float noiseAlt(double x,
                             double y)

2D simplex noise returning a float; extremely similar to noise(double, double), but this may be slightly faster or slightly slower. This uses its parameters verbatim, so you should apply frequency changes yourself. This also cannot take a seed, while noise(double, double, long) can.

Parameters:

x - x input

y - y input

Returns:

noise from -1.0 to 1.0, inclusive

noiseAlt

public static float noiseAlt(double x,
                             double y,
                             double z)

3D simplex noise returning a float; extremely similar to noise(double, double, double), but this may be slightly faster or slightly slower. This uses its parameters verbatim, so you should apply frequency changes yourself. This also cannot take a seed, while noise(double, double, double, long) can.

Parameters:

x - X input

y - Y input

z - Z input

Returns:

noise from -1.0 to 1.0, inclusive