ComputeFunctionCurve<T> Class

    Namespace: Stride.Animations
    Assembly: Stride.Engine.dll

    A node which describes a function over t value for a compute curve

    System.Object → ComputeFunctionCurve<T>
    Derived from ComputeFunctionCurve<T>: ComputeFunctionCurveColor4 ComputeFunctionCurveFloat ComputeFunctionCurveVector2 ComputeFunctionCurveVector3 ComputeFunctionCurveVector4 

    [DataContract(Inherited = true)]
[Display("Function", null)]
public abstract class ComputeFunctionCurve<T> : IComputeCurve<T>, IComputeCurve where T : struct
    Type Parameters
    Name Description
    T

    Sampled data's type
    Name Description
    Properties
    Amplitude
    Period
    PhaseShift
    Methods
    Evaluate(Single)

    Evaluates the compute curve's value at the specified location, usually in the [0 .. 1] range
    GetElementFrom(Single)
    UpdateChanges()

    Updates any optimizations in the curve if data has changed.
    | Improve this Doc View Source

    Properties

    Amplitude

    [DataMember(14)]
[Display("Amplitude", null)]
public float Amplitude { get; set; }
    Property Value
    Type Description
    System.Single

    Period

    [DataMember(12)]
[Display("Period", null)]
public float Period { get; set; }
    Property Value
    Type Description
    System.Single

    PhaseShift

    [DataMember(10)]
[Display("Phase Shift", null)]
public float PhaseShift { get; set; }
    Property Value
    Type Description
    System.Single
    | Improve this Doc View Source

    Methods

    Evaluate(Single)

    Evaluates the compute curve's value at the specified location, usually in the [0 .. 1] range

    public T Evaluate(float location)
    Parameters
    Type Name Description
    System.Single location

    Location to sample at
    Returns
    Type Description
    T

    Sampled value

    GetElementFrom(Single)

    protected abstract T GetElementFrom(float value)
    Parameters
    Type Name Description
    System.Single value
    Returns
    Type Description
    T

    UpdateChanges()

    Updates any optimizations in the curve if data has changed.

    public bool UpdateChanges()
    Returns
    Type Description
    System.Boolean

    true there were changes since the last time; otherwise, false.

    Extension Methods