com.sudoplay.joise.module

Class ModuleFractal

java.lang.Object

com.sudoplay.joise.module.Module

com.sudoplay.joise.module.SeededModule

com.sudoplay.joise.module.ModuleFractal

public class ModuleFractal
extends SeededModule

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleFractal.FractalType

Field Summary

Fields inherited from class com.sudoplay.joise.module.SeededModule

seed

Fields inherited from class com.sudoplay.joise.module.Module

DEFAULT_SEED

Constructor Summary

Constructors

Constructor and Description
ModuleFractal()
ModuleFractal(int octaves, double frequency)
ModuleFractal(ModuleFractal.FractalType type, ModuleBasisFunction.BasisType basisType, ModuleBasisFunction.InterpolationType interpolationType)
ModuleFractal(ModuleFractal.FractalType type, ModuleBasisFunction.BasisType basisType, ModuleBasisFunction.InterpolationType interpolationType, int octaves, double frequency)
ModuleFractal(java.lang.String id)
ModuleFractal(java.lang.String id, ModuleFractal.FractalType fractalType, ModuleBasisFunction.BasisType basisType, ModuleBasisFunction.InterpolationType interpolationType, int octaves, double frequency, int seed)

Method Summary

Modifier and Type	Method and Description
Module	buildFromPropertyMap(com.sudoplay.joise.ModulePropertyMap modulePropertyMap, com.sudoplay.joise.ModuleInstanceMap moduleInstanceMap)
double	get(double x, double y)
double	get(double x, double y, double z)
double	get(double x, double y, double z, double w)
double	get(double x, double y, double z, double w, double u, double v)
ModuleBasisFunction	getBasis(int index)
void	overrideSource(int index, Module source) Allows overriding internal sources with custom sources.
void	resetAllSources() Resets all sources overridden with overrideSource(int, Module).
void	resetSource(int index) Resets a source overridden with overrideSource(int, Module) at the provided index.
void	setAllSourceBasisTypes(ModuleBasisFunction.BasisType basisType) Sets the ModuleBasisFunction.BasisType for all internal ModuleBasisFunction.
void	setAllSourceInterpolationTypes(ModuleBasisFunction.InterpolationType interpolationType) Sets the ModuleBasisFunction.InterpolationType for all internal ModuleBasisFunction.
void	setAllSourceTypes(ModuleBasisFunction.BasisType basisType, ModuleBasisFunction.InterpolationType interpolationType) Sets the ModuleBasisFunction.BasisType and ModuleBasisFunction.InterpolationType for all internal ModuleBasisFunction.
void	setFrequency(double f)
void	setGain(double g)
void	setH(double h)
void	setLacunarity(double l)
void	setNumOctaves(int n)
void	setOffset(double o)
void	setSeed(long seed) Iterates through all currently assigned sources and calls SeededModule.setSeed(long) on each if the source is an instance of SeededModule.
void	setSeed(java.lang.String seedName, long seed) Iterates through all currently assigned sources and calls Module.setSeed(String, long).
void	setSeedName(java.lang.String name) Iterates through all currently assigned sources and calls SeededModule.setSeedName(String) on each if the source is an instance of SeededModule.
void	setSourceDerivativeSpacing(int index, double derivativeSpacing) Sets the derivative spacing.
void	setSourceType(int index, ModuleBasisFunction.BasisType basisType, ModuleBasisFunction.InterpolationType interpolationType) Sets the ModuleBasisFunction.BasisType and ModuleBasisFunction.InterpolationType for the internal ModuleBasisFunction assigned to the index given.
void	setType(ModuleFractal.FractalType type)
void	writeToMap(com.sudoplay.joise.ModuleMap moduleMap)

Methods inherited from class com.sudoplay.joise.module.SeededModule

getSeed, getSeedName, hasSeedName, readSeed, writeSeed

Methods inherited from class com.sudoplay.joise.module.Module

getId, getModuleMap, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleFractal

public ModuleFractal()

ModuleFractal

public ModuleFractal(java.lang.String id)

ModuleFractal

public ModuleFractal(int octaves,
                     double frequency)

ModuleFractal

public ModuleFractal(ModuleFractal.FractalType type,
                     ModuleBasisFunction.BasisType basisType,
                     ModuleBasisFunction.InterpolationType interpolationType)

ModuleFractal

public ModuleFractal(ModuleFractal.FractalType type,
                     ModuleBasisFunction.BasisType basisType,
                     ModuleBasisFunction.InterpolationType interpolationType,
                     int octaves,
                     double frequency)

ModuleFractal

public ModuleFractal(java.lang.String id,
                     ModuleFractal.FractalType fractalType,
                     ModuleBasisFunction.BasisType basisType,
                     ModuleBasisFunction.InterpolationType interpolationType,
                     int octaves,
                     double frequency,
                     int seed)

Method Detail

setNumOctaves

public void setNumOctaves(int n)

setFrequency

public void setFrequency(double f)

setLacunarity

public void setLacunarity(double l)

setGain

public void setGain(double g)

setOffset

public void setOffset(double o)

setH

public void setH(double h)

setType

public void setType(ModuleFractal.FractalType type)

setAllSourceTypes

public void setAllSourceTypes(ModuleBasisFunction.BasisType basisType,
                              ModuleBasisFunction.InterpolationType interpolationType)

Sets the ModuleBasisFunction.BasisType and ModuleBasisFunction.InterpolationType for all internal ModuleBasisFunction.

Sources set with overrideSource(int, Module) will not be affected.

Parameters:

basisType - the ModuleBasisFunction.BasisType

interpolationType - the ModuleBasisFunction.InterpolationType

setAllSourceBasisTypes

public void setAllSourceBasisTypes(ModuleBasisFunction.BasisType basisType)

Sets the ModuleBasisFunction.BasisType for all internal ModuleBasisFunction.

Sources set with overrideSource(int, Module) will not be affected.

Parameters:

basisType - the ModuleBasisFunction.BasisType

setAllSourceInterpolationTypes

public void setAllSourceInterpolationTypes(ModuleBasisFunction.InterpolationType interpolationType)

Sets the ModuleBasisFunction.InterpolationType for all internal ModuleBasisFunction.

Sources set with overrideSource(int, Module) will not be affected.

Parameters:

interpolationType - the ModuleBasisFunction.InterpolationType

setSourceType

public void setSourceType(int index,
                          ModuleBasisFunction.BasisType basisType,
                          ModuleBasisFunction.InterpolationType interpolationType)

Sets the ModuleBasisFunction.BasisType and ModuleBasisFunction.InterpolationType for the internal ModuleBasisFunction assigned to the index given.

Sources set with overrideSource(int, Module) will not be affected.

Parameters:

index - the index

basisType - the ModuleBasisFunction.BasisType

interpolationType - the ModuleBasisFunction.InterpolationType

setSourceDerivativeSpacing

public void setSourceDerivativeSpacing(int index,
                                       double derivativeSpacing)

Sets the derivative spacing. This parameter is only used when calculating the DeCarpentierSwiss fractal type.

Parameters:

derivativeSpacing - the derivative spacing

overrideSource

public void overrideSource(int index,
                           Module source)

Allows overriding internal sources with custom sources.

Parameters:

index - the index of the source to override

source - the source to override with

resetSource

public void resetSource(int index)

Resets a source overridden with overrideSource(int, Module) at the provided index.

Parameters:

index - the index of the overridden source

resetAllSources

public void resetAllSources()

Resets all sources overridden with overrideSource(int, Module).

setSeedName

public void setSeedName(java.lang.String name)

Iterates through all currently assigned sources and calls SeededModule.setSeedName(String) on each if the source is an instance of SeededModule.

If overrideSource(int, Module) is called after calling this method, the new source will not contain the seed name set here.

Overrides:

setSeedName in class SeededModule

Parameters:

name - the seed name

setSeed

public void setSeed(long seed)

Iterates through all currently assigned sources and calls SeededModule.setSeed(long) on each if the source is an instance of SeededModule.

If overrideSource(int, Module) is called after calling this method, the new source will not contain the seed set here.

Overrides:

setSeed in class SeededModule

Parameters:

seed - the seed

setSeed

public void setSeed(java.lang.String seedName,
                    long seed)

Iterates through all currently assigned sources and calls Module.setSeed(String, long).

If overrideSource(int, Module) is called after calling this method, the new source will not contain the seed set here.

Overrides:

setSeed in class SeededModule

Parameters:

seedName - the seed name

seed - the seed

getBasis

public ModuleBasisFunction getBasis(int index)

Parameters:

index - the basis function index

Returns:

the internal ModuleBasisFunction assigned to the index given

get

public double get(double x,
                  double y)

Specified by:

get in class Module

get

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

Specified by:

get in class Module

get

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

Specified by:

get in class Module

get

public double get(double x,
                  double y,
                  double z,
                  double w,
                  double u,
                  double v)

Specified by:

get in class Module

writeToMap

public void writeToMap(com.sudoplay.joise.ModuleMap moduleMap)

Specified by:

writeToMap in class Module

buildFromPropertyMap

public Module buildFromPropertyMap(com.sudoplay.joise.ModulePropertyMap modulePropertyMap,
                                   com.sudoplay.joise.ModuleInstanceMap moduleInstanceMap)

Specified by:

buildFromPropertyMap in class Module