com.sudoplay.joise.module

Class ModuleBasisFunction

java.lang.Object

com.sudoplay.joise.module.Module

com.sudoplay.joise.module.SeededModule

com.sudoplay.joise.module.ModuleBasisFunction

public class ModuleBasisFunction
extends SeededModule

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleBasisFunction.BasisType
static class	ModuleBasisFunction.InterpolationType

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
ModuleBasisFunction()
ModuleBasisFunction(ModuleBasisFunction.BasisType type)
ModuleBasisFunction(ModuleBasisFunction.BasisType type, ModuleBasisFunction.InterpolationType interpolationType)
ModuleBasisFunction(ModuleBasisFunction.BasisType type, ModuleBasisFunction.InterpolationType interpolationType, long 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.BasisType	getBasisType()
ModuleBasisFunction.InterpolationType	getInterpolationType()
void	setInterpolation(ModuleBasisFunction.InterpolationType type)
void	setRotationAngle(double angle) Set the rotation angle for 2D noise.
void	setRotationAngle(double x, double y, double z, double angle) Set the rotation axis and angle to use for 3D, 4D and 6D noise.
void	setSeed(long seed) Sets the seed for this module.
void	setType(ModuleBasisFunction.BasisType type)
void	writeToMap(com.sudoplay.joise.ModuleMap moduleMap)

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

getSeed, getSeedName, hasSeedName, readSeed, setSeed, setSeedName, 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

ModuleBasisFunction

public ModuleBasisFunction()

ModuleBasisFunction

public ModuleBasisFunction(ModuleBasisFunction.BasisType type)

ModuleBasisFunction

public ModuleBasisFunction(ModuleBasisFunction.BasisType type,
                           ModuleBasisFunction.InterpolationType interpolationType)

ModuleBasisFunction

public ModuleBasisFunction(ModuleBasisFunction.BasisType type,
                           ModuleBasisFunction.InterpolationType interpolationType,
                           long seed)

Method Detail

setType

public void setType(ModuleBasisFunction.BasisType type)

getBasisType

public ModuleBasisFunction.BasisType getBasisType()

setInterpolation

public void setInterpolation(ModuleBasisFunction.InterpolationType type)

getInterpolationType

public ModuleBasisFunction.InterpolationType getInterpolationType()

setRotationAngle

public void setRotationAngle(double angle)

Set the rotation angle for 2D noise.

Does not recalculate the rotation matrix for 3D, 4D and 6D noise. For higher dimensional noise, use ModuleBasisFunctionsetRotationAngle(double, double, double, double).

Parameters:

angle - the angle in radians

setRotationAngle

public void setRotationAngle(double x,
                             double y,
                             double z,
                             double angle)

Set the rotation axis and angle to use for 3D, 4D and 6D noise.

Also sets the rotation angle for 2D noise.

Parameters:

x - x value of axis vector

y - y value of axis vector

z - z value of axis vector

angle - angle in radians

setSeed

public void setSeed(long seed)

Sets the seed for this module.

Note: calling this method will override the rotation axis and angle from values derived from the seed. If you want to manually set the rotation axis and / or angle, call setRotationAngle(double) or setRotationAngle(double, double, double, double) after calling this method.

Overrides:

setSeed in class SeededModule

Parameters:

seed - the seed

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