Class FloatDistribution

Specifies a value as a distribution, which can include a constant value, random range or a curve.

Hierarchy

FrameworkObject
- FloatDistribution

Index

Constructors

Accessors

distributionType

Methods

evaluate getMaxConstant getMaxCurve getMinConstant getMinCurve

Constructors

constructor

new FloatDistribution(options?, isInternalConstructor?): FloatDistribution
Creates a new distribution that returns a constant value.
Parameters
- Optionaloptions:
      | {
          value: number;
      }
      | {
          maxValue: number;
          minValue: number;
      }
      | {
          curve: AnimationCurve;
      }
      | {
          maxCurve: AnimationCurve;
          minCurve: AnimationCurve;
      }
  Options object for the function call.
- OptionalisInternalConstructor: boolean
Returns FloatDistribution
Overrides FrameworkObject.constructor

Accessors

distributionType

get distributionType(): EnumValue<PropertyDistributionType, number>
Returns the type of the represented distribution.

Returns EnumValue<PropertyDistributionType, number>

Methods

evaluate

evaluate(options): number
Evaluates the value of the distribution.
Parameters
- options: {
      factor: number;
      t: number;
  } | {
      factorGenerator: Random;
      t: number;
  }
  Options object for the function call.
Returns number
Evaluated value.

getMaxConstant

getMaxConstant(): number
Returns the maximum value of a constant range. Only defined if the distribution represents a non-curve range.

Returns number

getMaxCurve

getMaxCurve(): AnimationCurve
Returns the curve representing the second curve of a curve range. Only defined if the distribution represents a curve range.

Returns AnimationCurve

getMinConstant

getMinConstant(): number
Returns the constant value of the distribution, or the minimal value of a constant range. Undefined if the distribution is represented by a curve.

Returns number

getMinCurve

getMinCurve(): AnimationCurve
Returns the curve representing the distribution, or the first curve representing a curve range. Undefined if the distribution is represented by a constant or a non-curve range.

Returns AnimationCurve