index :: ui

ui.matrix

The matrix of toggles has you.

available since version: 0.1

---

information

Rectangle matrix of toggles. Note: all matrix operations have following cell address format - ROW COL. On click outputs message with format [cell ROW COL VALUE(

arguments:

• ROW matrix rows
  type: int
  

• COL matrix columns
  type: int
  

methods:

• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

• dump dumps all object info to Pd console window.
  

• flip flips all matrix cells
  

• flip R C flips single cell
  parameters:

  • R row index
    type: int
    required: True
    

  • C column index
    type: int
    required: True
    

• flip col N flips cells in specified column.
  parameters:
  • N column index
    type: int
    required: True
    
• flip row N flips cells in specified row.
  parameters:
  • N row index
    type: int
    required: True
    
• get cell R C outputs single cell value as message [cell ROW COL VALUE(
  parameters:

  • R row index
    type: int
    required: True
    

  • C column index
    type: int
    required: True
    

• get cells output all cells as separate messages [cell R C VALUE(
  

• get col N outputs column cells as message [col N V0 V1…(
  parameters:
  • N column index
    type: int
    required: True
    

• get cols output all columns as separate messages [col N V0 V1…(
  

• get list output all cell values as list, row by raw. [0 1 1 1 0…(
  

• get row N outputs row cells as message [row N V0 V1…(
  parameters:
  • N row index
    type: int
    required: True
    

• get rows output all rows as separate messages [row N V0 V1…(
  

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

• 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
    

• random fill matrix random and output
  

• read
  parameters:
  • [FNAME] read matrix values from text file (space separated). If fname argument is not specified opens file chooser dialog
    type: symbol
    

• reset uncheck all matrix cells. No output
  

• set col N … set specified column without output
  parameters:

  • N column index
    type: int
    required: True
    

  • … cell values (1 - checked, 0 - unchecked)
    type: list
    required: True
    

• set list … set matrix without output
  parameters:
  • … cell values (1 - checked, 0 - unchecked), row by row
    type: list
    required: True
    
• set row N … set specified row without output
  parameters:

  • N row index
    type: int
    required: True
    

  • … cell values (1 - checked, 0 - unchecked)
    type: list
    required: True
    

• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• write
  parameters:
  • [FNAME] write matrix values to text file (space separated). If fname argument is not specified opens file chooser dialog
    type: symbol
    

properties:

• @rows Get/set number of matrix rows
  type: int
  range: 1..64
  default: 4
  

• @cols Get/set number of matrix columns
  type: int
  range: 1..64
  default: 8
  

• @current_row Get/set current row index. -1 if not specified. This property is not saved in patch
  type: int
  min value: -1
  default: -1
  

• @current_col Get/set current column index. -1 if not specified. This property is not saved in patch
  type: int
  min value: -1
  default: -1
  

• @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: 105 53
  

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

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

• @current_color Get/set current col/row color (list of red, green, blue values in 0-1 range)
  type: list
  default: 1 0.75 0 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
  

inlets:

• output all cells. Same as [get cells(
  type: control

outlets:

• output
  type: control

keywords:

ui matrix

See also: [ui.radio] [ui.toggle]

Authors: Pierre Guillot, Serge Poltavsky

License: GPL3 or later