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

Provides a noise module that outputs a three-dimensional perlin noise. [GENERATOR] More...

Inheritance diagram for LibNoise.Generator.Perlin:
LibNoise.ModuleBase

Public Member Functions

 Perlin ()
 Initializes a new instance of Perlin. More...
 
 Perlin (double frequency, double lacunarity, double persistence, int octaves, int seed, QualityMode quality)
 Initializes a new instance of Perlin. 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 first octave. More...
 
double Lacunarity [get, set]
 Gets or sets the lacunarity of the perlin noise. More...
 
QualityMode Quality [get, set]
 Gets or sets the quality of the perlin noise. More...
 
int OctaveCount [get, set]
 Gets or sets the number of octaves of the perlin noise. More...
 
double Persistence [get, set]
 Gets or sets the persistence of the perlin noise. More...
 
int Seed [get, set]
 Gets or sets the seed of the perlin noise. 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 outputs a three-dimensional perlin noise. [GENERATOR]

Constructor & Destructor Documentation

LibNoise.Generator.Perlin.Perlin ( )

Initializes a new instance of Perlin.

LibNoise.Generator.Perlin.Perlin ( double  frequency,
double  lacunarity,
double  persistence,
int  octaves,
int  seed,
QualityMode  quality 
)

Initializes a new instance of Perlin.

Parameters
frequencyThe frequency of the first octave.
lacunarityThe lacunarity of the perlin noise.
persistenceThe persistence of the perlin noise.
octavesThe number of octaves of the perlin noise.
seedThe seed of the perlin noise.
qualityThe quality of the perlin noise.

Member Function Documentation

override double LibNoise.Generator.Perlin.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.Generator.Perlin.Frequency
getset

Gets or sets the frequency of the first octave.

double LibNoise.Generator.Perlin.Lacunarity
getset

Gets or sets the lacunarity of the perlin noise.

int LibNoise.Generator.Perlin.OctaveCount
getset

Gets or sets the number of octaves of the perlin noise.

double LibNoise.Generator.Perlin.Persistence
getset

Gets or sets the persistence of the perlin noise.

QualityMode LibNoise.Generator.Perlin.Quality
getset

Gets or sets the quality of the perlin noise.

int LibNoise.Generator.Perlin.Seed
getset

Gets or sets the seed of the perlin noise.


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