Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChannelItemWithGUI

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new ChannelItemWithGUI(automaton: Automaton, data: SerializedChannelItem): ChannelItemWithGUI

  • Constructor of the [[ChannelItem]].

    Parameters

    • automaton: Automaton

      Parent automaton

    • data: SerializedChannelItem

      Data of the item

    Returns ChannelItemWithGUI

Properties

$id

$id: string

Protected __automaton

__automaton: AutomatonWithGUI

amp

amp: number

This will only make sense when curve is specified. The scale of the item in the value axis.

Optional curve

curve: CurveWithGUI

deserialize

length

length: number

Length of the item.

offset

offset: number

This will only make sense when curve is specified. The time offset of the item.

Optional reset

reset: undefined | false | true

Whether reset channels value to zero at the end of this item or not.

serialize

  • serialize(): SerializedChannelItem

speed

speed: number

This will only make sense when curve is specified. The speed rate of the item.

time

time: number

Beginning timepoint of the item.

value

value: number

Value of the item.

Accessors

end

  • get end(): number

  • Ending timepoint of the item.

    Returns number

Methods

getValue

  • getValue(time: number, isFromGUI?: undefined | false | true): number

  • TODO

    Parameters

    • time: number

      The timepoint you want to grab the value

    • Optional isFromGUI: undefined | false | true

      If you're poking the method from Automaton GUI, set this to true otherwise you are going to suffer in redux hell

    Returns number

serializeGUI

serializeWithID

  • serializeWithID(): SerializedChannelItem & WithID

Generated using TypeDoc