Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "gen/curve"

Index

Functions

Functions

Const curve

  • curve(start: number, end: number, num: number, rate?: number, skipFirst?: boolean, clampEnd?: boolean): MAdd
  • Returns new MAdd gen, producing an exponential curve (with adjustable curvature) between start and end values over num steps. This is the exponential equivalent of line.

    remarks

    Unless skipFirst is true (default: false), the end value is only reached at num + 1 steps. Unless clampEnd is true (default: false), the curve will NOT stop at end but continue indefinitely if more values are requested from the generator.

    The curvature can be controlled via the logarithmic rate param. Recommended range [0.0001 - 10000] (curved -> linear). Default: 0.1

    Also see madd.

    example
    curve(-1, 1, 5, 0.1).take(7)
    // [
    //   -1,
    //   -0.04228753006664476,
    //   0.4786567612639258,
    //   0.7620225554764573,
    //   0.9161583712747458,
    //   1.0000000000000002,  // target
    //   1.0456053557111122
    // ]

    Parameters

    • start: number

      start value

    • end: number

      end value

    • num: number

      num steps

    • Default value rate: number = 0.1

      curvature control

    • Default value skipFirst: boolean = false

      true to skip start value (default: false)

    • Default value clampEnd: boolean = false

      true to clamp curve at end value (default: false)

    Returns MAdd

Generated using TypeDoc