INoiseFunction

Description

`interface` `Tinman.Terrain.Procedural.INoiseFunction`
`<TValue val : IEquatable<TValue>>`

Derived from

INoiseFunctionBase

Extended by

INoiseFunctionOps
NoiseFunction abstract

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

Public / Methods

Compute​Value

`public` `method` `ComputeValue1` → `(1)`

in : Vec3D

Coordinate of input vector.

returns → TValue

The noise value.

Computes the noise value for the given input vector.

`public` `method` `ComputeValue2` → `(3)`

in : float64

X-coordinate of input vector.

in : float64

Y-coordinate of input vector.

in : float64

Z-coordinate of input vector.

returns → TValue

The noise value.

Computes the noise value for the given input vector.

Has​Constant​Value

`public` `method` `HasConstantValue` → `(1)`

value in : TValue

The constant value.

returns → bool

`true` if this noise function has the given constant value, `false` if not.

Does this noise function have the given constant value?

Linear​Base

`[Pure]`
`public` `method` `LinearBase` → `(2)`

scale in : TValue

Linear coefficient of output transform.

offset in : TValue

Linear coefficient of output transform.

returns → INoiseFunction<TValue>

The resulting noise function.

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

`result = noise * scale + offset`

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

Simplify​Base

`[Pure]`
`public` `method` `SimplifyBase` → `()`

returns → INoiseFunction<TValue>

The simplified noise function or `this`.

Simplifies this noise function, if possible.

Public / Attributes

Constant​Value

`public` `attribute` `ConstantValue` → `(get)`

value : TValue

The constant value.

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