index :: ui

ui.knob

aliases: [ui.k]

knob widget

available since version: 0.1

---

information

Simple knob widget with default range 0-1.

arguments:

• MIN min value
  type: float
  

• MAX max value
  type: float
  

methods:

• set sets knob value without output
  parameters:
  • V new float value or 'random'
    type: atom
    required: True
    

• ++ increment knob value without output
  

• – decrement knob value without output
  

• + add value to knob without output
  parameters:
  • V added value
    type: float
    required: True
    
• - subtract value from knob without output
  parameters:
  • V subtracted value
    type: float
    required: True
    

---

multiply knob value without output
parameters:

• V multiplied value
  type: float
  required: True
  

• / divide knob value without output
  parameters:
  • V denominator value
    type: float
    required: True
    

• random set knob to random value and output
  

• load loads specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• interp interplolates between presets
  parameters:
  • IDX preset fraction index
    type: float
    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
    

• dump dumps all object info to Pd console window
  

properties:

• @min Get/set minimum knob value
  type: float
  default: 0
  

• @max Get/set maximum knob value
  type: float
  default: 1
  

• @midi_channel Get/set binded MIDI channel. 0 means listen to all channels
  type: int
  range: 0..16
  default: 0
  

• @midi_control Get/set binded MIDI controller number. -1 means not binded to any controller.
  type: int
  range: -1..127
  default: -1
  

• @midi_pickup Get/set pickup current value. If slider is binded to value, first time you should pass over this value to make binding. It prevents from sudden value change on first control change
  type: bool
  default: 1
  

• @active_scale Get/set if should draw active scale
  type: bool
  default: 0
  

• @value Get/set current value
  type: float
  default: 0
  

• @show_range Get/set show knob range
  type: bool
  default: 0
  

• @show_value Get/set show value
  type: bool
  default: 0
  

• @scale Get/set scale mode. Linear or logarithmic.
  type: symbol
  enum: linear, log
  default: linear
  

• @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: 40 40
  

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

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

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

• @scale_color Get/set scale color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.6 0.6 0.6 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
  

• @label Get/set label text
  type: symbol
  default: (null)
  

• @label_color Get/set label color in RGB format within 0-1 range, for example: 0.2 0.4 0.1
  type: list
  default: 0 0 0 1
  

• @label_inner Get/set label position (1 - inner, 0 - outer).
  type: bool
  default: 0
  

• @label_align Get/set label horizontal align
  type: symbol
  enum: left, center, right
  default: left
  

• @label_valign Get/set label vertical align
  type: symbol
  enum: top, center, bottom
  default: top
  

• @label_side Get/set label snap side
  type: symbol
  enum: left, top, right, bottom
  default: top
  

• @label_margins Get/set label offset in pixels
  type: list
  default: 0 0
  

inlets:

• outputs knob value
  type: control

outlets:

• knob output
  type: control

keywords:

ui knob

See also: [ui.slider]

Authors: Alex Nadzharov, Serge Poltavsky

License: GPL3 or later