Class Vector3Distribution

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

Hierarchy

FrameworkObject
- Vector3Distribution

Index

Constructors

Accessors

distributionType

Methods

evaluate getMaxConstant getMaxCurve getMinConstant getMinCurve

Constructors

constructor

new Vector3Distribution(options?, isInternalConstructor?): Vector3Distribution
Creates a new distribution that returns a constant value.
Parameters
- Optionaloptions:
      | {
          value: Immutable<Vector3>;
      }
      | {
          maxValue: Immutable<Vector3>;
          minValue: Immutable<Vector3>;
      }
      | {
          curve: Vector3Curve;
      }
      | {
          maxCurve: Vector3Curve;
          minCurve: Vector3Curve;
      }
  Options object for the function call.
- OptionalisInternalConstructor: boolean
Returns Vector3Distribution
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): Vector3
Evaluates the value of the distribution.
Parameters
- options: {
      factor: number;
      t: number;
  } | {
      factorGenerator: Random;
      t: number;
  }
  Options object for the function call.
Returns Vector3
Evaluated value.

getMaxConstant

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

Returns Immutable<Vector3>

getMaxCurve

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

Returns Vector3Curve

getMinConstant

getMinConstant(): Immutable<Vector3>
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 Immutable<Vector3>

getMinCurve

getMinCurve(): Vector3Curve
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 Vector3Curve