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

Provides a noise module that clamps the output value from a source module to a range of values. [OPERATOR] More...

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

Public Member Functions

 Clamp ()
 Initializes a new instance of Clamp. More...
 
 Clamp (double min, double max, ModuleBase input)
 Initializes a new instance of Clamp. 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 Maximum [get, set]
 Gets or sets the maximum to clamp to. More...
 
double Minimum [get, set]
 Gets or sets the minimum to clamp to. 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 clamps the output value from a source module to a range of values. [OPERATOR]

Constructor & Destructor Documentation

LibNoise.Operator.Clamp.Clamp ( )

Initializes a new instance of Clamp.

LibNoise.Operator.Clamp.Clamp ( double  min,
double  max,
ModuleBase  input 
)

Initializes a new instance of Clamp.

Parameters
inputThe input module.
minThe minimum value.
maxThe maximum value.

Member Function Documentation

override double LibNoise.Operator.Clamp.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.Clamp.Maximum
getset

Gets or sets the maximum to clamp to.

double LibNoise.Operator.Clamp.Minimum
getset

Gets or sets the minimum to clamp to.


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