Abstract base class for IColorFunction implementations.
abstract class
|
ColorFunction
|
implements
|
IColorFunction
|
||
extends
|
NoiseFunction<int64>
|
The configurator object for this type.
public
static
property
|
Config
{
get
}
|
||
type
|
IConfigurator<IColorFunction>
|
||
value
|
|
The configurator object. |
Returns the configuration value that describes this object.
public
abstract
method
|
ToConfig
()
|
||
type
|
ConfigValue
|
||
returns
|
|
The configuration value. | |
inherited
|
NoiseFunction.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.
For
constant
noise
functions,
returns
the
constant
value.
For
all
others,
the
default
value
of
TValue
is
returned.
public
property
|
ConstantValue
{
get
}
|
||
type
|
TValue
|
||
value
|
The constant value. | ||
inherited
|
NoiseFunction.ConstantValue
|
Does this noise function return a constant value?
public
virtual
property
|
IsConstant
{
get
}
|
||
type
|
bool
|
||
value
|
true
if
this
noise
function
is
constant,
false
if
not. |
||
inherited
|
NoiseFunction.IsConstant
|
Remarks:
A constant noise function computes the same value for all input coordinates.
Returns the serial type of this object.
public
property
|
SerialType
{
get
}
|
||
type
|
ISerialTypeInfo
|
||
value
|
|
The serial type. | |
inherited
|
SerializableBase.SerialType
|
Returns the serial data version.
public
virtual
property
|
SerialVersion
{
get
}
|
||
type
|
int32
|
||
value
|
|
The serial data version tag. | |
inherited
|
SerializableBase.SerialVersion
|
Remarks:
An ISerializable implementation is required to support all versions up to the one returned by SerialVersion.
See also:
ISerializable.SerializeReturns a color function that sums the color values of the given function and this one.
[Pure]
|
||||
public
virtual
method
|
Add
(IColorFunction function)
|
|||
type
|
IColorFunction
|
|||
params
|
function
|
[not-null]
|
The color function to add. | |
returns
|
|
The resulting color function. | ||
implements
|
IColorFunction.Add
|
Remarks:
result := this + function
See also:
Colors.AddReturns a color function that blends the color values returned by this color function with the color values returned by the given color function.
[Pure]
|
||||
public
virtual
method
|
Blend
(IColorFunction function)
|
|||
type
|
IColorFunction
|
|||
params
|
function
|
[not-null]
|
The color function. | |
returns
|
|
The resulting color function. | ||
implements
|
IColorFunction.Blend
|
See also:
Colors.BlendComputes the noise value for the given input vector.
public
method
|
ComputeValue
(Vec3D v)
|
||
type
|
TValue
|
||
params
|
v
|
Coordinate of input vector. | |
returns
|
The noise value. | ||
inherited
|
NoiseFunction.ComputeValue
|
Computes the noise value for the given input vector.
public
abstract
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. | ||
inherited
|
NoiseFunction.ComputeValue
|
public
static
method
|
Constant
(int64 value)
|
||
type
|
IColorFunction
|
||
params
|
value
|
Initializes the state of this object from the given data stream.
public
virtual
method
|
Deserialize
(int32 serialVersion,
ISerializer data)
|
||
type
|
ISerializable
|
||
params
|
serialVersion
|
[>=1]
|
The serial data version. |
data
|
[not-null]
|
The serial data stream. | |
returns
|
|
The
deserialized
object.
This
will
typically
be
this ,
but
in
some
circumstances,
another
instance
may
be
returned
(e.g.
singletons).
|
|
inherited
|
SerializableBase.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.SerializeCompares this object with the given one.
[Pure]
|
||||
public
abstract
method
|
Equals
(INoiseFunctionBase other)
|
|||
type
|
bool
|
|||
params
|
other
|
The object to compare to. | ||
returns
|
true
if
this
object
is
equal
to
other,
false
if
not.
|
|||
inherited
|
NoiseFunction.Equals
|
Does this noise function have the given constant value?
public
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.
|
||
inherited
|
NoiseFunction.HasConstantValue
|
Applies a linear transformation on the output value of this noise function.
[Pure]
|
||||
public
method
|
Linear
(int64 scale,
int64 offset)
|
|||
type
|
IColorFunction
|
|||
params
|
scale
|
Linear coefficient of output transform. | ||
offset
|
Linear coefficient of output transform. | |||
returns
|
|
The resulting noise function. | ||
implements
|
INoiseFunctionOps.Linear
|
Remarks:
result = noise * scale + offsetwhere
noise
is
this
noise
function
and
result
is
the
returned
noise
function.
Applies a linear transformation on the output value of this noise function.
[Pure]
|
||||
public
override
method
|
LinearBase
(int64 scale,
int64 offset)
|
|||
type
|
INoiseFunction<int64>
|
|||
params
|
scale
|
Linear coefficient of output transform. | ||
offset
|
Linear coefficient of output transform. | |||
returns
|
|
The resulting noise function. | ||
implements
|
NoiseFunction.LinearBase
|
Remarks:
result = noise * scale + offsetwhere
noise
is
this
noise
function
and
result
is
the
returned
noise
function.
Returns a color function that multiplies the color values returned by this color function with the color values returned by the given color function.
[Pure]
|
||||
public
virtual
method
|
Mul
(IColorFunction function)
|
|||
type
|
IColorFunction
|
|||
params
|
function
|
[not-null]
|
The color function. | |
returns
|
|
The resulting color function. | ||
implements
|
IColorFunction.Mul
|
Remarks:
result := this * factor
See also:
Colors.MulSerializes the current state of this object to the given data stream.
public
virtual
method
|
Serialize
(ISerializer data)
|
||
params
|
data
|
[not-null]
|
The serial data stream. |
inherited
|
SerializableBase.Serialize
|
See also:
ISerializable.DeserializeSimplifies this noise function, if possible.
[Pure]
|
||||
public
method
|
Simplify
()
|
|||
type
|
IColorFunction
|
|||
returns
|
|
The
simplified
noise
function
or
this . |
||
implements
|
INoiseFunctionOps.Simplify
|
Simplifies this noise function, if possible.
[Pure]
|
||||
public
virtual
method
|
SimplifyBase
()
|
|||
type
|
INoiseFunction<TValue>
|
|||
returns
|
|
The
simplified
noise
function
or
this . |
||
inherited
|
NoiseFunction.SimplifyBase
|
Returns a color function that subtracts the color values returned by the given color function from the color values returned by this color function.
[Pure]
|
||||
public
virtual
method
|
Sub
(IColorFunction function)
|
|||
type
|
IColorFunction
|
|||
params
|
function
|
[not-null]
|
The color function. | |
returns
|
|
The resulting color function. | ||
implements
|
IColorFunction.Sub
|
See also:
Colors.SubTransforms the input coordinates using the given vector function before plugging them into this noise function.
[Pure]
|
||||
public
virtual
method
|
Transform
(IVectorFunction function)
|
|||
type
|
IColorFunction
|
|||
params
|
function
|
[not-null]
|
The vector function to use for transforming the input coordinates. | |
returns
|
|
The resulting noise function. | ||
implements
|
INoiseFunctionOps.Transform
|
protected
constructor
|
ColorFunction
(ISerialTypeInfo serialType)
|
||
params
|
serialType
|
protected
override
sealed
method
|
EqualValue
(int64 a,
int64 b)
|
||
type
|
bool
|
||
params
|
a
|
||
b
|
|||
implements
|
NoiseFunction.EqualValue
|
protected
method
|
SimplifyAdd
(INoiseFunction<TValue> a,
INoiseFunction<TValue> b)
|
||
type
|
INoiseFunction<TValue>
|
||
params
|
a
|
||
b
|
|||
inherited
|
NoiseFunction.SimplifyAdd
|
protected
method
|
SimplifyMul
(INoiseFunction<TValue> a,
INoiseFunction<TValue> b)
|
||
type
|
INoiseFunction<TValue>
|
||
params
|
a
|
||
b
|
|||
inherited
|
NoiseFunction.SimplifyMul
|
protected
method
|
SimplifySub
(INoiseFunction<TValue> a,
INoiseFunction<TValue> b)
|
||
type
|
INoiseFunction<TValue>
|
||
params
|
a
|
||
b
|
|||
inherited
|
NoiseFunction.SimplifySub
|
Negates
the
given
noise
value,
so
that
value
+
(-value)
=
0
.
protected
virtual
method
|
ValueNeg
(TValue value)
|
||
type
|
TValue
|
||
params
|
value
|
The noise value. | |
returns
|
The resulting noise value. | ||
inherited
|
NoiseFunction.ValueNeg
|