index :: spat

hoa.map.ui

a GUI to spatialize sources on a map

available since version: 0.9.7

---

information

[hoa.map.ui] allows you to spatialize several sources on a plane to control [hoa.2d.map~] or [hoa.3d.map]. You can add and remove sources, change coordinates, add description and create groups.

methods:

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

• clear_all remove all sources from map
  

• dump dumps all object info to Pd console window
  

• group group operations
  parameters:

  • IDX group index
    type: int
    required: True
    

  • ACTION action
    type: symbol
    required: True
    

  • [ARGS] action arguments
    type: list
    

• info outputs info to 3rd outlet
  

• 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
    

• set sets toggle state without output
  

• source source operations
  parameters:

  • IDX source index
    type: int
    required: True
    

  • ACTION action
    type: symbol
    required: True
    

  • [ARGS] action arguments
    type: list
    

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

properties:

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

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

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

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

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

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

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

• @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_margins Get/set label offset in pixels
  type: list
  default: 0 0
  

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

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

• @mapname Get/set widget name to link them between
  type: symbol
  default: (null)
  

• @outputmode Get/set output mode
  type: symbol
  enum: polar, cartesian
  default: polar
  

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

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

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

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

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

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

• @view Get/set coordinate view
  type: symbol
  enum: xy, xz, yz
  default: xy
  

• @zoom Get/set zoom factor
  type: float
  range: 0.01..1
  default: 0.35
  

inlets:

• output group and source info
  type: control

outlets:

• source output
  type: control
• group output
  type: control
• info output
  type: control

keywords:

hoa map

Authors: Serge Poltavsky, Pierre Guillot, Eliott Paris, Thomas Le Meur

License: GPL3 or later