LibNoise.Operator.Displace Class Reference

Provides a noise module that uses three source modules to displace each coordinate of the input value before returning the output value from a source module. [OPERATOR] More...

Inheritance diagram for LibNoise.Operator.Displace:

Public Member Functions
	Displace ()
	Initializes a new instance of Displace. More...
	Displace (ModuleBase input, ModuleBase x, ModuleBase y, ModuleBase z)
	Initializes a new instance of Displace. 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
ModuleBase	X [get, set]
	Gets or sets the controlling module on the x-axis. More...
ModuleBase	Y [get, set]
	Gets or sets the controlling module on the z-axis. More...
ModuleBase	Z [get, set]
	Gets or sets the controlling module on the z-axis. 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 uses three source modules to displace each coordinate of the input value before returning the output value from a source module. [OPERATOR]

Constructor & Destructor Documentation

LibNoise.Operator.Displace.Displace

(

)

Initializes a new instance of Displace.

LibNoise.Operator.Displace.Displace	(	ModuleBase	input,
		ModuleBase	x,
		ModuleBase	y,
		ModuleBase	z
	)

Initializes a new instance of Displace.

Parameters

input	The input module.
x	The displacement module of the x-axis.
y	The displacement module of the y-axis.
z	The displacement module of the z-axis.

Member Function Documentation

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

virtual

Returns the output value for the given input coordinates.

Parameters

x	The input coordinate on the x-axis.
y	The input coordinate on the y-axis.
z	The input coordinate on the z-axis.

Returns

The resulting output value.

Implements LibNoise.ModuleBase.

Property Documentation

ModuleBase LibNoise.Operator.Displace.X

getset

Gets or sets the controlling module on the x-axis.

ModuleBase LibNoise.Operator.Displace.Y

getset

Gets or sets the controlling module on the z-axis.

ModuleBase LibNoise.Operator.Displace.Z

getset

Gets or sets the controlling module on the z-axis.

---

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

• Source/Chunks/LibNoise/Operator/Displace.cs