Class CurveSet

constructor

• new CurveSet(...args: any[]): CurveSet

  Creates a new CurveSet instance.

  Parameters

  • ...args: any[]

    Variable arguments with several possible formats:

    • No arguments: Creates a CurveSet with a single default curve.
    • Single number argument: Creates a CurveSet with the specified number of default curves.
    • Single array argument: An array of arrays, where each sub-array contains keys (pairs of numbers with the time first and value second).
    • Multiple arguments: Each argument becomes a separate curve.

  Returns CurveSet

  Example

  // Create from an array of arrays of keys
  const curveSet = new pc.CurveSet([
      [
          0, 0,        // At 0 time, value of 0
          0.33, 2,     // At 0.33 time, value of 2
          0.66, 2.6,   // At 0.66 time, value of 2.6
          1, 3         // At 1 time, value of 3
      ],
      [
          0, 34,
          0.33, 35,
          0.66, 36,
          1, 37
      ]
  ]);
  Copy

curves

length

• get length(): number

  Gets the number of curves in the curve set.

  Returns number

type

• get type(): number

  Gets the interpolation scheme applied to all curves in the curve set.

  Returns number

• set type(value: number): void

  Sets the interpolation scheme applied to all curves in the curve set. Can be:

  • CURVE_LINEAR
  • CURVE_SMOOTHSTEP
  • CURVE_SPLINE
  • CURVE_STEP

  Defaults to CURVE_SMOOTHSTEP.

  Parameters

  • value: number

  Returns void

add

• add(data?: number[]): Curve

  Appends a new curve to the curve set. The new curve adopts the curve set's current CurveSet#type interpolation scheme, so that all curves in the set continue to share the same type.

  Parameters

  • Optionaldata: number[]

    An array of keys (pairs of numbers with the time first and value second) for the new curve.

  Returns Curve

  The newly created curve.

  Example

  const curveSet = new pc.CurveSet([[0, 0, 1, 1]]);
  const curve = curveSet.add([0, 0, 1, 0.5]); // append a second curve
  Copy

clear

• clear(): CurveSet

  Removes all curves from the curve set, leaving it empty.

  Returns CurveSet

  The curve set instance.

  Example

  const curveSet = new pc.CurveSet([[0, 0, 1, 1], [0, 0, 1, 0.5]]);
  curveSet.clear(); // the set now has no curves
  Copy

clearKeys

• clearKeys(): CurveSet

  Removes all keys from every curve in the set, while keeping the curves themselves. The number of curves is unchanged, so CurveSet#value still returns an array of the same length.

  Returns CurveSet

  The curve set instance.

  Example

  const curveSet = new pc.CurveSet([[0, 0, 1, 1], [0, 0, 1, 0.5]]);
  curveSet.clearKeys(); // both curves are now empty, but the set still has 2 curves
  Copy

clone

• clone(): CurveSet

  Returns a clone of the specified curve set object.

  Returns CurveSet

  A clone of the specified curve set.

  Example

  const curveSet = new pc.CurveSet([[0, 0, 1, 1]]);
  const clonedCurveSet = curveSet.clone();
  Copy

get

• get(index: number): Curve

  Return a specific curve in the curve set.

  Parameters

  • index: number

    The index of the curve to return.

  Returns Curve

  The curve at the specified index.

  Example

  const curveSet = new pc.CurveSet([[0, 0, 1, 1], [0, 0, 1, 0.5]]);
  const curve = curveSet.get(0); // returns the first curve
  Copy

remove

• remove(indexOrCurve: number | Curve): Curve | null

  Removes a curve from the curve set.

  Parameters

  • indexOrCurve: number | Curve

    The index of the curve to remove, or the curve instance itself.

  Returns Curve | null

  The removed curve, or null if it was not found.

  Example

  const curveSet = new pc.CurveSet([[0, 0, 1, 1], [0, 0, 1, 0.5]]);
  curveSet.remove(0);             // remove by index
  curveSet.remove(curveSet.get(0)); // or remove by reference
  Copy

value

• value(time: number, result?: number[]): number[]

  Returns the interpolated value of all curves in the curve set at the specified time.

  Parameters

  • time: number

    The time at which to calculate the value.

  • Optionalresult: number[] = []

    The interpolated curve values at the specified time. If this parameter is not supplied, the function allocates a new array internally to return the result.

  Returns number[]

  The interpolated curve values at the specified time.

  Example

  const curveSet = new pc.CurveSet([[0, 0, 1, 1], [0, 0, 1, 0.5]]);
  const values = curveSet.value(0.5); // returns interpolated values for all curves at time 0.5
  Copy