Class Curve

constructor

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

  Creates a new Curve instance.

  Parameters

  • Optionaldata: number[]

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

  Returns Curve

  Example

  const curve = new pc.Curve([
      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
  ]);
  Copy

keys

tension

type

length

• get length(): number

  Gets the number of keys in the curve.

  Returns number

add

• add(time: number, value: number): number[]

  Adds a new key to the curve.

  Parameters

  • time: number

    Time to add new key.

  • value: number

    Value of new key.

  Returns number[]

  The newly created [time, value] pair.

  Example

  const curve = new pc.Curve();
  curve.add(0, 1);   // add key at time 0 with value 1
  curve.add(1, 2);   // add key at time 1 with value 2
  Copy

clone

• clone(): Curve

  Returns a clone of the specified curve object.

  Returns Curve

  A clone of the specified curve.

  Example

  const curve = new pc.Curve([0, 0, 1, 10]);
  const clonedCurve = curve.clone();
  Copy

closest

• closest(time: number): number[] | null

  Returns the key closest to the specified time.

  Parameters

  • time: number

    The time to find the closest key to.

  Returns number[] | null

  The [time, value] pair closest to the specified time, or null if no keys exist.

  Example

  const curve = new pc.Curve([0, 1, 0.5, 2, 1, 3]);
  const key = curve.closest(0.6); // returns [0.5, 2]
  Copy

get

• get(index: number): number[]

  Gets the [time, value] pair at the specified index.

  Parameters

  • index: number

    The index of key to return.

  Returns number[]

  The [time, value] pair at the specified index.

  Example

  const curve = new pc.Curve([0, 1, 1, 2]);
  const key = curve.get(0); // returns [0, 1]
  Copy

sort

• sort(): void

  Sorts keys by time.

  Returns void

value

• value(time: number): number

  Returns the interpolated value of the curve at specified time.

  Parameters

  • time: number

    The time at which to calculate the value.

  Returns number

  The interpolated value.

  Example

  const curve = new pc.Curve([0, 0, 1, 10]);
  const value = curve.value(0.5); // returns interpolated value at time 0.5
  Copy