Chunks
Moddable voxel sandbox for room-scale VR.
Public Member Functions | Properties | List of all members
LibNoise.Operator.Turbulence Class Reference

Provides a noise module that that randomly displaces the input value before returning the output value from a source module. [OPERATOR] More...

Inheritance diagram for LibNoise.Operator.Turbulence:
LibNoise.ModuleBase

Public Member Functions

 Turbulence ()
 Initializes a new instance of Turbulence. More...
 
 Turbulence (double power, ModuleBase input)
 Initializes a new instance of Turbulence. More...
 
 Turbulence (Perlin x, Perlin y, Perlin z, double power, ModuleBase input)
 Initializes a new instance of Turbulence. More...
 
override double GetValue (double x, double y, double z)
 Returns the output value for the given input coordinates. More...
 
- Public Member Functions inherited from LibNoise.ModuleBase
double GetValue (Vector3 coordinate)
 Returns the output value for the given input coordinates. More...
 
double GetValue (ref Vector3 coordinate)
 Returns the output value for the given input coordinates. More...
 
void Dispose ()
 Immediately releases the unmanaged resources used by this object. More...
 

Properties

double Frequency [get, set]
 Gets or sets the frequency of the turbulence. More...
 
double Power [get, set]
 Gets or sets the power of the turbulence. More...
 
int Roughness [get, set]
 Gets or sets the roughness of the turbulence. More...
 
int Seed [get, set]
 Gets or sets the seed of the turbulence. More...
 
- Properties inherited from LibNoise.ModuleBase
virtual ModuleBase this[int index] [get, set]
 Gets or sets a source module by index. More...
 
int SourceModuleCount [get]
 Gets the number of source modules required by this noise module. More...
 
bool IsDisposed [get]
 Gets a value whether the object is disposed. More...
 

Additional Inherited Members

- Protected Member Functions inherited from LibNoise.ModuleBase
 ModuleBase (int count)
 Initializes a new instance of Helpers. More...
 
virtual bool Disposing ()
 Immediately releases the unmanaged resources used by this object. More...
 
- Protected Attributes inherited from LibNoise.ModuleBase
ModuleBase[] m_modules = null
 

Detailed Description

Provides a noise module that that randomly displaces the input value before returning the output value from a source module. [OPERATOR]

Constructor & Destructor Documentation

LibNoise.Operator.Turbulence.Turbulence ( )

Initializes a new instance of Turbulence.

LibNoise.Operator.Turbulence.Turbulence ( double  power,
ModuleBase  input 
)

Initializes a new instance of Turbulence.

LibNoise.Operator.Turbulence.Turbulence ( Perlin  x,
Perlin  y,
Perlin  z,
double  power,
ModuleBase  input 
)

Initializes a new instance of Turbulence.

Parameters
xThe perlin noise to apply on the x-axis.
yThe perlin noise to apply on the y-axis.
zThe perlin noise to apply on the z-axis.
powerThe power of the turbulence.
inputThe input module.

Member Function Documentation

override double LibNoise.Operator.Turbulence.GetValue ( double  x,
double  y,
double  z 
)
virtual

Returns the output value for the given input coordinates.

Parameters
xThe input coordinate on the x-axis.
yThe input coordinate on the y-axis.
zThe input coordinate on the z-axis.
Returns
The resulting output value.

Implements LibNoise.ModuleBase.

Property Documentation

double LibNoise.Operator.Turbulence.Frequency
getset

Gets or sets the frequency of the turbulence.

double LibNoise.Operator.Turbulence.Power
getset

Gets or sets the power of the turbulence.

int LibNoise.Operator.Turbulence.Roughness
getset

Gets or sets the roughness of the turbulence.

int LibNoise.Operator.Turbulence.Seed
getset

Gets or sets the seed of the turbulence.


The documentation for this class was generated from the following file: