LibNoise.ModuleBase Class Reference

Base class for noise modules. More...

Inheritance diagram for LibNoise.ModuleBase:

Public Member Functions
abstract double	GetValue (double x, double y, double z)
	Returns the output value for the given input coordinates. More...
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...

Protected Member Functions
	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
ModuleBase[]	m_modules = null

Properties
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...

Detailed Description

Base class for noise modules.

Constructor & Destructor Documentation

LibNoise.ModuleBase.ModuleBase ( int  count )

protected

Initializes a new instance of Helpers.

Parameters

count

The number of source modules.

Member Function Documentation

void LibNoise.ModuleBase.Dispose

(

)

Immediately releases the unmanaged resources used by this object.

virtual bool LibNoise.ModuleBase.Disposing ( )

protectedvirtual

Immediately releases the unmanaged resources used by this object.

Returns

True if the object is completely disposed.

abstract double LibNoise.ModuleBase.GetValue ( double  x, double  y, double  z  )

pure 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.

Implemented in LibNoise.Operator.Turbulence, LibNoise.Generator.RiggedMultifractal, LibNoise.Operator.Select, LibNoise.Operator.Rotate, LibNoise.Operator.Terrace, LibNoise.Generator.Billow, LibNoise.Generator.Perlin, LibNoise.Operator.Curve, LibNoise.Generator.Voronoi, LibNoise.Operator.Displace, LibNoise.Operator.Scale, LibNoise.Operator.Translate, LibNoise.Operator.Clamp, LibNoise.Operator.ScaleBias, LibNoise.Operator.Cache, LibNoise.Operator.Blend, LibNoise.Operator.Exponent, LibNoise.Generator.Const, LibNoise.Generator.Cylinders, LibNoise.Generator.Spheres, LibNoise.Operator.Add, LibNoise.Operator.Max, LibNoise.Operator.Min, LibNoise.Operator.Multiply, LibNoise.Operator.Power, LibNoise.Operator.Subtract, LibNoise.Operator.Abs, LibNoise.Operator.Invert, and LibNoise.Generator.Checker.

double LibNoise.ModuleBase.GetValue

(

Vector3

coordinate

)

Returns the output value for the given input coordinates.

Parameters

coordinate

The input coordinate.

Returns

The resulting output value.

double LibNoise.ModuleBase.GetValue

(

ref Vector3

coordinate

)

Returns the output value for the given input coordinates.

Parameters

coordinate

The input coordinate.

Returns

The resulting output value.

Member Data Documentation

ModuleBase [] LibNoise.ModuleBase.m_modules = null

protected

Property Documentation

bool LibNoise.ModuleBase.IsDisposed

get

Gets a value whether the object is disposed.

int LibNoise.ModuleBase.SourceModuleCount

get

Gets the number of source modules required by this noise module.

virtual ModuleBase LibNoise.ModuleBase.this[int index]

getset

Gets or sets a source module by index.

Parameters

index

The index of the source module to aquire.

Returns

The requested source module.

---

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

• Source/Chunks/LibNoise/ModuleBase.cs