index :: ui

ui.env

envelope editor widget

available since version: 0.5

---

information

Editor of sound envelope function

methods:

• adsr creates ADSR envelope with one stop point
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • DECAY decay time
    type: float
    units: ms
    required: True
    

  • SUSTAIN sustain level
    type: float
    units: %
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

• ar creates AR envelope without stop points
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

• asr creates ASR envelope with one stop point
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

• at output envelope value at specified position to second outlet
  parameters:

  • VAL position (in milliseconds if unit arg is ommited )
    type: float
    required: True
    

  • [UNIT] position unit: ms, % or *(phase)
    type: symbol
    

• clear clear specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• eadsr creates exponential ADSR envelope with one stop point
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • ATTACK_CURVE attack segment curve
    type: float
    required: True
    

  • DECAY decay time
    type: float
    units: ms
    required: True
    

  • DECAY_CURVE decay segment curve
    type: float
    required: True
    

  • SUSTAIN sustain level
    type: float
    units: %
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

  • RELEASE_CURVE release segment curve
    type: float
    required: True
    

• ear creates exponential AR envelope without stop points
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • ATTACK_CURVE attack segment curve
    type: float
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

  • RELEASE_CURVE release segment curve
    type: float
    required: True
    

• easr creates exponential AR envelope with one stop point
  parameters:

  • ATTACK attack time
    type: float
    units: ms
    required: True
    

  • ATTACK_CURVE attack segment curve
    type: float
    required: True
    

  • RELEASE release time
    type: float
    units: ms
    required: True
    

  • RELEASE_CURVE release segment curve
    type: float
    required: True
    

• exp creates exponential-segmented envelope with arbitrary number of segments
  parameters:

  • VAL0 begin value
    type: float
    required: True
    

  • LEN0 line length
    type: float
    units: ms
    required: True
    

  • CURVE0 segment curve
    type: float
    required: True
    

  • VAL1 value
    type: float
    required: True
    

  • [LEN1] segment length
    type: float
    

  • [CURVE1] segment curve
    type: float
    

  • [VAL2] value
    type: float
    

• interp for this object acts as load, no interpolation performed
  

• line creates line-segmented envelope with arbitrary number of segments
  parameters:

  • VAL0 begin value
    type: float
    required: True
    

  • LEN0 line length
    type: float
    units: ms
    required: True
    

  • VAL1 value
    type: float
    required: True
    

  • [LEN1] segment length
    type: float
    

  • [VAL2] value
    type: float
    

• load loads specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• pos set UI element position
  parameters:

  • X top left x-coord
    type: float
    required: True
    

  • Y top right y-coord
    type: float
    required: True
    

• sigmoid creates sigmoid-segmented envelope with arbitrary number of segments
  parameters:

  • VAL0 begin value
    type: float
    required: True
    

  • LEN0 line length
    type: float
    units: ms
    required: True
    

  • CURVE0 segment curve
    type: float
    required: True
    

  • VAL1 value
    type: float
    required: True
    

  • [LEN1] segment length
    type: float
    

  • [CURVE1] segment curve
    type: float
    

  • [VAL2] value
    type: float
    

• sin2 creates quadratic sine-segmented envelope with arbitrary number of segments
  parameters:

  • VAL0 begin value
    type: float
    required: True
    

  • LEN0 line length
    type: float
    units: ms
    required: True
    

  • VAL1 value
    type: float
    required: True
    

  • [LEN1] segment length
    type: float
    

  • [VAL2] value
    type: float
    

• step creates step-segmented envelope with arbitrary number of segments
  parameters:

  • VAL0 begin value
    type: float
    required: True
    

  • LEN0 step length
    type: float
    units: ms
    required: True
    

  • VAL1 value
    type: float
    required: True
    

  • [LEN1] segment length
    type: float
    

  • [VAL2] value
    type: float
    

• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

properties:

• @length Get/set envelope time length
  type: float
  units: ms
  min value: 10
  default: 400
  

• @presetname Get/set preset name for using with [ui.preset]
  type: symbol
  default: (null)
  

• @send Get/set send destination
  type: symbol
  default: (null)
  

• @receive Get/set receive source
  type: symbol
  default: (null)
  

• @size Get/set element size (width, height pair)
  type: list
  default: 200 150
  

• @pinned Get/set pin mode. if 1 - put element to the lowest level
  type: bool
  default: 0
  

• @norm Get/set normalize input values
  type: bool
  default: 1
  

• @active_color Get/set element active color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0 0.75 1 1
  

• @line_color Get/set line color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.1 0.1 0.1 1
  

• @background_color Get/set element background color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.93 0.93 0.93 1
  

• @border_color Get/set border color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.6 0.6 0.6 1
  

• @fontsize Get/set fontsize
  type: int
  range: 4..100
  default: 11
  

• @fontname Get/set fontname
  type: symbol
  enum: Courier, DejaVu, Helvetica, Monaco, Times
  default: Helvetica
  

• @fontweight Get/set font weight
  type: symbol
  enum: normal, bold
  default: normal
  

• @fontslant Get/set font slant
  type: symbol
  enum: roman, italic
  default: roman
  

• @mouse_events Get/set mouse events output mode. If on outputs @mouse_down, @mouse_up and @mouse_drag events
  type: bool
  default: 0
  

• @output_mode Get/set output envelope mode. If set to "mouse_up" - output envelope on mouse up if Ctrl/Cmd key not pressed. If set to "drag" - output envelope on every change. Note: in any mode you can output evenlope with Ctrl/Cmd + mouse down.
  type: symbol
  enum: mouse_up, drag
  default: mouse_up
  

inlets:

• set new envelope and output it
  type: control

outlets:

• envelope
  type: control
• float: envelope value at time moment
  type: control

keywords:

ui envelope

Authors: Serge Poltavsky

License: GPL3 or later