index :: ui

ui.knob

knob widget

доступно с версии: 0.1

---

информация

Simple knob widget with default range 0-1.

аргументы:

• MIN min value
  тип: float
  

• MAX max value
  тип: float
  

методы:

• set sets knob value without output
  параметры:
  • V new float value or 'random'
    тип: atom
    обязательно: True
    

• ++ increment knob value without output
  

• – decrement knob value without output
  

• + add value to knob without output
  параметры:
  • V added value
    тип: float
    обязательно: True
    
• - subtract value from knob without output
  параметры:
  • V subtracted value
    тип: float
    обязательно: True
    

---

multiply knob value without output
параметры:

• V multiplied value
  тип: float
  обязательно: True
  

• / divide knob value without output
  параметры:
  • V denominator value
    тип: float
    обязательно: True
    

• random set knob to random value and output
  

• load loads specified preset
  параметры:
  • IDX preset index
    тип: int
    обязательно: True
    
• store stores specified preset
  параметры:
  • IDX preset index
    тип: int
    обязательно: True
    
• clear clears specified preset
  параметры:
  • IDX preset index
    тип: int
    обязательно: True
    
• interp interplolates between presets
  параметры:
  • IDX preset fraction index
    тип: float
    обязательно: True
    
• pos set UI element position
  параметры:

  • X top left x-coord
    тип: float
    обязательно: True
    

  • Y top right y-coord
    тип: float
    обязательно: True
    

• dump dumps all object info to Pd console window
  

свойства:

• @min Запросить/установить minimum knob value
  тип: float
  по умолчанию: 0
  

• @max Запросить/установить maximum knob value
  тип: float
  по умолчанию: 1
  

• @midi_channel Запросить/установить binded MIDI channel. 0 means listen to all channels
  тип: int
  диапазон: 0..16
  по умолчанию: 0
  

• @midi_control Запросить/установить binded MIDI controller number. -1 means not binded to any controller.
  тип: int
  диапазон: -1..127
  по умолчанию: -1
  

• @midi_pickup Запросить/установить 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
  тип: bool
  по умолчанию: 1
  

• @active_scale Запросить/установить if should draw active scale
  тип: bool
  по умолчанию: 0
  

• @value Запросить/установить current value
  тип: float
  по умолчанию: 0
  

• @show_range Запросить/установить show knob range
  тип: bool
  по умолчанию: 0
  

• @show_value Запросить/установить show value
  тип: bool
  по умолчанию: 0
  

• @scale Запросить/установить scale mode. Linear or logarithmic.
  тип: symbol
  варианты: linear, log
  по умолчанию: linear
  

• @presetname Запросить/установить preset name for using with [ui.preset]
  тип: symbol
  по умолчанию: (null)
  

• @send Запросить/установить send destination
  тип: symbol
  по умолчанию: (null)
  

• @receive Запросить/установить receive source
  тип: symbol
  по умолчанию: (null)
  

• @size Запросить/установить element size (width, height pair)
  тип: list
  по умолчанию: 40 40
  

• @pinned Запросить/установить pin mode. if 1 - put element to the lowest level
  тип: bool
  по умолчанию: 0
  

• @mouse_events Запросить/установить mouse events output mode. If on outputs @mouse_down, @mouse_up and @mouse_drag events
  тип: bool
  по умолчанию: 0
  

• @knob_color Запросить/установить knob color (list of red, green, blue values in 0-1 range)
  тип: list
  по умолчанию: 0 0.75 1 1
  

• @scale_color Запросить/установить scale color (list of red, green, blue values in 0-1 range)
  тип: list
  по умолчанию: 0.6 0.6 0.6 1
  

• @background_color Запросить/установить element background color (list of red, green, blue values in 0-1 range)
  тип: list
  по умолчанию: 0.93 0.93 0.93 1
  

• @border_color Запросить/установить border color (list of red, green, blue values in 0-1 range)
  тип: list
  по умолчанию: 0.6 0.6 0.6 1
  

• @fontsize Запросить/установить fontsize
  тип: int
  диапазон: 4..100
  по умолчанию: 11
  

• @fontname Запросить/установить fontname
  тип: symbol
  варианты: Courier, DejaVu, Helvetica, Monaco, Times
  по умолчанию: Helvetica
  

• @fontweight Запросить/установить font weight
  тип: symbol
  варианты: normal, bold
  по умолчанию: normal
  

• @fontslant Запросить/установить font slant
  тип: symbol
  варианты: roman, italic
  по умолчанию: roman
  

• @label Запросить/установить label text
  тип: symbol
  по умолчанию: (null)
  

• @label_color Запросить/установить label color in RGB format within 0-1 range, for example: 0.2 0.4 0.1
  тип: list
  по умолчанию: 0 0 0 1
  

• @label_inner Запросить/установить label position (1 - inner, 0 - outer).
  тип: bool
  по умолчанию: 0
  

• @label_align Запросить/установить label horizontal align
  тип: symbol
  варианты: left, center, right
  по умолчанию: left
  

• @label_valign Запросить/установить label vertical align
  тип: symbol
  варианты: top, center, bottom
  по умолчанию: top
  

• @label_side Запросить/установить label snap side
  тип: symbol
  варианты: left, top, right, bottom
  по умолчанию: top
  

• @label_margins Запросить/установить label offset in pixels
  тип: list
  по умолчанию: 0 0
  

входы:

• outputs knob value
  тип: control

выходы:

• knob output
  тип: control

ключевые слова:

ui knob

Смотрите также: [ui.slider]

Авторы: Alex Nadzharov, Serge Poltavsky

Лицензия: GPL3 or later