interface INoiseFunction in Tinman.Terrain.Procedural

Base interface for classes that compute procedural noise values of a specific data type.

interface	INoiseFunction	with	<TValue>	as	struct, IEquatable<TValue>
		extends	INoiseFunctionBase
		base of	INoiseFunctionOps
			NoiseFunction

Attributes

ConstantValue

For constant noise functions, returns the constant value. For all others, the default value of TValue is returned.

property	ConstantValue { get }
type	TValue
value		The constant value.

IsConstant

Does this noise function return a constant value?

property	IsConstant { get }
type	bool
value		true if this noise function is constant, false if not.
inherited	INoiseFunctionBase.IsConstant

Remarks:

A constant noise function computes the same value for all input coordinates.

SerialType

Returns the serial type of this object.

property	SerialType { get }
type	ISerialTypeInfo
value	[not-null]	The serial type.
inherited	ISerializable.SerialType

SerialVersion

Returns the serial data version.

property	SerialVersion { get }
type	int32
value	[>=1]	The serial data version tag.
inherited	ISerializable.SerialVersion

Remarks:

An ISerializable implementation is required to support all versions up to the one returned by SerialVersion.

See also:

ISerializable.Serialize
ISerializable.Deserialize

Methods

ComputeValue

Computes the noise value for the given input vector.

method	ComputeValue (Vec3D v)
type	TValue
params	v		Coordinate of input vector.
returns			The noise value.

---

Computes the noise value for the given input vector.

method	ComputeValue (float64 x, float64 y, float64 z)
type	TValue
params	x		X-coordinate of input vector.
	y		Y-coordinate of input vector.
	z		Z-coordinate of input vector.
returns			The noise value.

Deserialize

Initializes the state of this object from the given data stream.

method	Deserialize (int32 serialVersion, ISerializer data)
type	ISerializable
params	serialVersion	[>=1]	The serial data version.
	data	[not-null]	The serial data stream.
returns		[not-null]	The deserialized object. This will typically be this, but in some circumstances, another instance may be returned (e.g. singletons).
inherited	ISerializable.Deserialize

Remarks:

The Deserialize method will be called immediately after the object has been instantiated via its default constructor.

The provided serialVersion number is guaranteed to be equal to or less than the SerialVersion returned by this object (i.e. ISerializable object must provide backwards compatibility).

See also:

ISerializable.Serialize
ISerializable.SerialVersion

HasConstantValue

Does this noise function have the given constant value?

method	HasConstantValue (TValue value)
type	bool
params	value		The constant value.
returns			true if this noise function has the given constant value, false if not.

LinearBase

Applies a linear transformation on the output value of this noise function.

[Pure]
method	LinearBase (TValue scale, TValue offset)
type	INoiseFunction<TValue>
params	scale		Linear coefficient of output transform.
	offset		Linear coefficient of output transform.
returns		[not-null]	The resulting noise function.

Remarks:

result = noise * scale + offset

where noise is this noise function and result is the returned noise function.

Serialize

Serializes the current state of this object to the given data stream.

method	Serialize (ISerializer data)
params	data	[not-null]	The serial data stream.
inherited	ISerializable.Serialize

See also:

ISerializable.Deserialize
ISerializable.SerialVersion

SimplifyBase

Simplifies this noise function, if possible.

[Pure]
method	SimplifyBase ()
type	INoiseFunction<TValue>
returns		[not-null]	The simplified noise function or this.

ToConfig

Returns the configuration value that describes this object.

method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
inherited	IConfigurable.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.