metamorphosis
    Preparing search index...

    Class InterpolatedVars<TUnit>

    Creates a list of interpolated values from a given list of ControlVars.


    const v1 = new ControlVar(Units.num, 0)
    const v2 = new ControlVar(Units.num, 100)

    const interpolated = new InterpolatedVars("spacing", Units.px, [v1, v2])
    // interpolates from 0-100

    v1.set(50) // interpolated will now update to interpolate from 50-100

    It can be passed multiple stops.

    const interpolated = new InterpolatedVars("spacing", Units.px, [v1, v2, v3])

    ... or stops with positions (otherwise they are evenly spaced).

    	// positions should be in a 0-1 percentage range
    const interpolated = new InterpolatedVars("spacing", Units.px, [v1, v2, v3], [0, 0.2, 1])

    You can change interpolation control variables and any options using set:

    interpolated.set("values-stops", [vOther1, vOther2, vOther3], undefined)
    interpolated.set("values-stops", [vOther1, vOther2, vOther3], [0, 0.2, 1])
    interpolated.set("options", {steps: 20})
    interpolated.set("stop", currentIndex, newPercent) // will re-sort after

    Type Parameters

    • TUnit extends Record<string, any> = Record<string, any>

    Hierarchy (View Summary)

    • Base
      • InterpolatedVars
    Index

    Constructors

    constructor

    Properties

    _dependants interpolated name options ready stops unit value values

    Methods

    _notify addDep checkStopsCorrectness notify recompute removeDep set sortStopsAndValues

    Constructors

    Properties

    Protected_dependants

    _dependants: Base[] = []
    interpolated: Record<string, string> = {}
    name: string
    options: InterpolatedVarsOptions<ControlVar<any, TUnit>> = ...
    ready: boolean = false
    stops: number[] | undefined = undefined
    unit: (value: TUnit) => string
    value: Record<string, any>[] = []
    values: ControlVar<any, TUnit>[] = []

    Methods

    Protected_notify

    • Parameters

      • dep: any

      Returns void

    • Parameters

      • type: "values-stops"

        The property configuration to update.

      • values: ControlVar<any, TUnit>[]

        The new control variables array.

      • Optionalstops: number[]

        The new explicit stops array, or undefined to switch to even spacing.

      Returns void

    • Parameters

      • type: "stop"

        Targets a specific stop position to change.

      • index: number

        The target array index of the stop to modify. Values will get resorted after setting.

      • value: number

        The new position value (0 to 1) for the stop.

      Returns void

    • Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods