Class SliderInput

The SliderInput class models a slider that can move through a range of numerical values.

Hierarchy

  • SliderInput

Constructors

constructor

Properties

changed valueTracker

Accessors

activeMs name typeName value

Methods

update

Constructors

constructor

  • Parameters

    • name: string

      The name property allows for an easy way to identify a button when it may be one of many sliders available.

    Returns SliderInput

Properties

changed

changed: SliderEvent = ...

This event is fired every time the slider value changes.

valueTracker

valueTracker: PropertyTracker<number>

Tracks changes to the sliders value.

Accessors

activeMs

  • get activeMs(): number

  • Returns how many consecutive milliseconds the slider has had a non-zero value.

    Returns number

name

  • get name(): string

  • The name property allows for an easy way to identify a button when it may be one of many sliders available.

    Returns string

typeName

  • get typeName(): string

  • Returns the name of this type. This can be used rather than instanceof which is sometimes unreliable.

    Returns string

value

  • get value(): number

  • Returns the value of the slider.

    Returns number

Methods

update

  • This method is intended to be called by a clock to provide regular updates. It should not be called by consumers of the library.

    Returns

    Parameters

    • deltaMs: number

      How many milliseconds have passed since the last update cycle.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc