C# Class LibNoise.Transformer.Displace

Noise module that uses three source modules to displace each coordinate of the input value before returning the output value from a source module. Roles in the displacement operation: - SourceModule outputs a value. - XDisplaceModule specifies the offset to apply to the x coordinate of the input value. - YDisplaceModule specifies the offset to apply to the y coordinate of the input value. - YDisplaceModule specifies the offset to apply to the z coordinate of the input value. The GetValue() method modifies the ( x, y, z ) coordinates of the input value using the output values from the three displacement modules before retrieving the output value from the source module. The Turbulence noise module is a special case of the displacement module; internally, there are three Perlin-noise modules that perform the displacement operation.
Inheritance: TransformerModule, IModule3D
Show file Open project: everbytes/LibNoise

Protected Properties

Property Type Description
_sourceModule IModule
_xDisplaceModule IModule
_yDisplaceModule IModule
_zDisplaceModule IModule

Public Methods

Method Description
Displace ( )

Create a new noise module with default values
Displace ( IModule source, IModule xDisplaceModule, IModule yDisplaceModule, IModule zDisplaceModule )

Create a new noise module with the given values
GetValue ( float x, float y, float z ) : float

Generates an output value given the coordinates of the specified input value.

Method Details

Displace() public method

Create a new noise module with default values
public Displace ( )

Displace() public method

Create a new noise module with the given values
public Displace ( IModule source, IModule xDisplaceModule, IModule yDisplaceModule, IModule zDisplaceModule )
source IModule the source module
xDisplaceModule IModule the displacement module that displaces the x coordinate
yDisplaceModule IModule the displacement module that displaces the y coordinate
zDisplaceModule IModule the displacement module that displaces the z coordinate

GetValue() public method

Generates an output value given the coordinates of the specified input value.
public GetValue ( float x, float y, float z ) : float
x float The input coordinate on the x-axis.
y float The input coordinate on the y-axis.
z float The input coordinate on the z-axis.
return float

Property Details

_sourceModule protected property

The source input module
protected IModule _sourceModule
return IModule

_xDisplaceModule protected property

Displacement module that displaces the x coordinate.
protected IModule _xDisplaceModule
return IModule

_yDisplaceModule protected property

Displacement module that displaces the y coordinate.
protected IModule _yDisplaceModule
return IModule

_zDisplaceModule protected property

Displacement module that displaces the z coordinate.
protected IModule _zDisplaceModule
return IModule