VectorFunction

Description

abstract class Tinman.Terrain.Procedural.VectorFunction

Derived from

NoiseFunction<Vec3D> abstract
IVectorFunction

Abstract base class for IVectorFunction implementations.

Public / Constants

Gradient

public static readonly attribute Gradient → (IVectorFunction)

A vector function that returns smooth gradient vectors.

Public / Constructors

Constant

2 overloads

public static method Constant1 → (1)

value in : Vec3D

The constant value.

returns → IVectorFunction

The resulting noise function.

Returns a vector function that returns the given constant value.

public static method Constant2 → (3)

x in : float64

X-component of constant value.

y in : float64

Y-component of constant value.

z in : float64

Z-component of constant value.

returns → IVectorFunction

The resulting noise function.

Returns a vector function that returns the given constant value.

Input

2 overloads

public static method Input1 → (2)

scale in : float64

Linear coefficient (see remarks).

offset in : Vec3D

Linear coefficient (see remarks).

returns → IVectorFunction

The resulting noise function.

Returns a vector function that applies a linear transformation on the input coordinates.

          | x * s + offset.X |
result := | y * s + offset.Y |
          | z * s + offset.Z |

where x, y and z are the noise input coordinates.

public static method Input2 → (4)

scale opt : float64 = 1

Linear coefficient (see remarks).

offsetX opt : float64 = 0

Linear coefficient (see remarks).

offsetY opt : float64 = 0

Linear coefficient (see remarks).

offsetZ opt : float64 = 0

Linear coefficient (see remarks).

returns → IVectorFunction

The resulting noise function.

Returns a vector function that applies a linear transformation on the input coordinates.

          | x * s + offsetX |
result := | y * s + offsetY |
          | z * s + offsetZ |

where x, y and z are the noise input coordinates.

Protected / Constructors

Vector​Function

protected constructor VectorFunction → (1)

serialType in : ISerialTypeInfo

[not-null]
The serial ID.

Creates a new instance of VectorFunction.

Configuration

Config

public static attribute Config → (get)

value : IConfigurator<IVectorFunction>

[not-null]
The configurator object.

The configurator object for this type.