Package de.articdive.jnoise.modules.octavation

Class OctavationModule.OctavationModuleBuilder

java.lang.Object

de.articdive.jnoise.modules.octavation.OctavationModule.OctavationModuleBuilder

All Implemented Interfaces:

NoiseSourceBuilder

Enclosing class:

OctavationModule

@NullMarked
public static final class OctavationModule.OctavationModuleBuilder
extends Object
implements NoiseSourceBuilder

Method Summary

Modifier and Type	Method	Description
OctavationModule	build()	Builds the NoiseSource.
OctavationModule.OctavationModuleBuilder	setFractalFunction(FractalFunction fractalFunction)	Sets the FractalFunction for the OctavationModule.
OctavationModule.OctavationModuleBuilder	setGain(double gain)	Sets the gain for the OctavationModule.
OctavationModule.OctavationModuleBuilder	setIncrementSeed(boolean incrementSeed)	Should the Noise Generator increment the seed with each octave?
OctavationModule.OctavationModuleBuilder	setLacunarity(double lacunarity)	Sets the lacunarity for the OctavationModule.
OctavationModule.OctavationModuleBuilder	setNoiseSource(NoiseSource noiseSource)	Sets the noise source for the OctavationModule.
OctavationModule.OctavationModuleBuilder	setNoiseSource(NoiseSourceBuilder noiseSourceBuilder)	Sets the noise source for the OctavationModule.
OctavationModule.OctavationModuleBuilder	setOctaves(int octaves)	Sets the amount of octaves for the OctavationModule.
OctavationModule.OctavationModuleBuilder	setPersistence(double persistence)	Deprecated. Use setGain(double) - Internals have not changed.

Methods inherited from class java.lang.Object

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

Method Details

setNoiseSource

public OctavationModule.OctavationModuleBuilder setNoiseSource(NoiseSource noiseSource)

Sets the noise source for the OctavationModule.

Parameters:

noiseSource - the new noise source for the OctavationModule.

Returns:

OctavationModule.OctavationModuleBuilder this

setNoiseSource

public OctavationModule.OctavationModuleBuilder setNoiseSource(NoiseSourceBuilder noiseSourceBuilder)

Sets the noise source for the OctavationModule.

Parameters:

noiseSourceBuilder - the new noise source for the OctavationModule.

Returns:

OctavationModule.OctavationModuleBuilder this

setOctaves

public OctavationModule.OctavationModuleBuilder setOctaves(int octaves)

Sets the amount of octaves for the OctavationModule.

Parameters:

octaves - the new amount of octaves for the OctavationModule.

Returns:

OctavationModule.OctavationModuleBuilder this

setPersistence

@Deprecated
public OctavationModule.OctavationModuleBuilder setPersistence(double persistence)

Deprecated.

Use setGain(double) - Internals have not changed.

Sets the persistence for the OctavationModule.

Parameters:

persistence - the new persistence for the OctavationModule.

Returns:

OctavationModule.OctavationModuleBuilder this

setGain

public OctavationModule.OctavationModuleBuilder setGain(double gain)

Sets the gain for the OctavationModule.

Parameters:

gain - the new gain for the OctavationModule.

Returns:

OctavationModule.OctavationModuleBuilder this

setLacunarity

public OctavationModule.OctavationModuleBuilder setLacunarity(double lacunarity)

Sets the lacunarity for the OctavationModule.

Parameters:

lacunarity - the new lacunarity for the OctavationModule.

Returns:

OctavationModule.OctavationModuleBuilder this

setFractalFunction

public OctavationModule.OctavationModuleBuilder setFractalFunction(FractalFunction fractalFunction)

Sets the FractalFunction for the OctavationModule.

Parameters:

fractalFunction - the new FractalFunction for the OctavationModule.

Returns:

OctavationModule.OctavationModuleBuilder this

setIncrementSeed

public OctavationModule.OctavationModuleBuilder setIncrementSeed(boolean incrementSeed)

Should the Noise Generator increment the seed with each octave?

Parameters:

incrementSeed - true if seed should increment each octave for the OctavationModule.

Returns:

OctavationModule.OctavationModuleBuilder this

build

public OctavationModule build()

Description copied from interface: NoiseSourceBuilder

Builds the NoiseSource.

Specified by:

build in interface NoiseSourceBuilder

Returns:

NoiseSource resulting from the parameters of the NoiseSourceBuilder.