File Duplex/Display.lua

Functions

Display:__init (device) Initialize the Display class
Display:__tostring ()
Display:_validate_group (xargs) Validate/fix groups and try to give the control map author some hints of what might be wrong with the control map
Display:_validate_param (xargs) Validate/fix parameters and try to give the control map author some hints of what might be wrong with the control map
Display:_walk_table (t, done, deep) Walk control-map defition, and create the virtual control surface
Display:add (obj_instance) Register a UIComponent with this display
Display:apply_tooltips (group_name) Apply_tooltips: set tooltips on the virtual display based on the tooltip property assigned to existing ui_objects
Display:build_control_surface () Build the virtual control-surface (based on the parsed control-map)
Display:clear () Clear display, force update of all UI components
Display:generate_message (value, metadata, released) Generate message : used by virtual control-surface elements
Display:set_parameter (elm, obj, point, secondary) Set_parameter: apply parameter changes, update the display
Display:update () Update any UIComponent that has been modified since the last update (this function is called continously)
Display:update_key (key_idx, elm, obj) Update special UI key widgets (pressed, normal, disabled)


Functions

Display:__init (device)
Initialize the Display class

Parameters:

  • device: (Device) associate the Display with this device
Display:__tostring ()
Display:_validate_group (xargs)
Validate/fix groups and try to give the control map author some hints of what might be wrong with the control map

Parameters:

  • xargs: (Table) the control-map attributes
Display:_validate_param (xargs)
Validate/fix parameters and try to give the control map author some hints of what might be wrong with the control map

Parameters:

  • xargs: (Table) the control-map attributes
Display:_walk_table (t, done, deep)
Walk control-map defition, and create the virtual control surface

Parameters:

  • t: (Table) the control-map defition
  • done: (Table) internal calculation table
  • deep: (Number/Int) the nesting level
Display:add (obj_instance)
Register a UIComponent with this display

Parameters:

  • obj_instance: (UIComponent) a UIComponent class instance
Display:apply_tooltips (group_name)
Apply_tooltips: set tooltips on the virtual display based on the tooltip property assigned to existing ui_objects

Parameters:

  • group_name: (String) the control-map group name, e.g. "Encoders"
Display:build_control_surface ()
Build the virtual control-surface (based on the parsed control-map)

Return value:

    ViewBuilder
Display:clear ()
Clear display, force update of all UI components
Display:generate_message (value, metadata, released)
Generate message : used by virtual control-surface elements

Parameters:

  • value: (Number or Table) value, or table of values
  • metadata: (Table) metadata, such as min/max etc.
  • released: (Boolean), true when button has been released
Display:set_parameter (elm, obj, point, secondary)
Set_parameter: apply parameter changes, update the display

Parameters:

  • elm: (Table) control-map definition of the element
  • obj: (UIComponent) instance of UIComponent
  • point: (CanvasPoint) point containing text/value/color
  • secondary: (Boolean), true when method call itself (value-pairs)
Display:update ()
Update any UIComponent that has been modified since the last update (this function is called continously)
Display:update_key (key_idx, elm, obj)
Update special UI key widgets (pressed, normal, disabled)

Parameters:

  • key_idx: (Number) the keys index
  • elm: (Table) control-map definition of the element
  • obj: (UIKey) instance of a UIKey component

Valid XHTML 1.0!