Panel Matrix

Module to display or edit values of an array.

Settings

matrix type

Sets the type of the matrix:

• switch: cells are switch and can take the value 0 or 1.

• fader: cells are continuous value in the range [0..1].

exclusive mode

Determines the exclusion mode, used to allow only one active cell per line or column.

• disabled : no exclusive mode
• per line : only one active cell per line.
• per column : only one active cell per column.
• all : only one active cell in the entire matrix.

example of per line exclusive mode

array

Array input or output containing values. The size of the array is nb lines x nb columns ordered line by line.

[(line1, col1),(line1,col2),...,(line1,colN),(line2,col1),..., (lineN,col1),...(lineN,colN)]

nb lines

Number of lines of the array editor or the matrix.

nb columns

Number of columns of the array editor or the matrix.

precision

Precision of the displayed numeric value, from integer up to five digits precision.

For example 1 1.1 1.11 1.111 1.1111 1.11111

caption

Displayed caption of the object. Click to enter a new name.

reset value

Reset value applies when the reset button is pressed or when the user does a [ctrl+click].

reset

Resets all the values of the selected object.

randomize

Randomizes the array, fill the array with random value in the range [0..1].

randomize coverage

Amount of cells which are randomized by the randomize operation. For 0, no cells are randomized, for 1 all cells are randomized.

cells captions

Captions of the cells as a comma-text.

cells color

Foreground colors of the cells.

cells background color

Background colors of the cells.

cells mode

Mode used to fill the cells color input.

• disabled: the color input has no effect and the settings colors of the panel are used instead.
• line: colors are filled by lines.
• columns: colors are filled by columns.
• cells: colors are filled cell by cell from top left cell to bottom right cell

line headers captions

Captions of the line headers as a comma-text.

line headers color

Color or color array of the line headers.

line headers mode

Mode used to fill the line headers color input.

• disabled: the color input has no effect and the settings colors of the panel are used instead.
• enabled: line headers colors are filled with the input.

column headers captions

Captions of the column headers as a comma-text.

column headers color

Color or color array of the column headers.

column headers mode

Mode used to fill the column headers color input.

• disabled: the color input has no effect and the settings colors of the panel are used instead.
• enabled: line headers colors are filled with the input.

cursor position

Position of the cursor. Use -1 to set the cursor invisible.

cursor out

Cells output at the cursor position.

cursor mode

Determines the orientation of the cursor, by line, or columns.

save to file

Prompt for a file name and save the values to a text file ordered line by line.

load from file

Prompt for a file name and load the values to a text file ordered line by line.

file loaded

Sends a 1 value when the file is loaded. Must be connected to a flow-from-0-to-1.

save load headers in files

Determines if the columns and lines headers are also saved/loaded during the save to file and load from file operations.

file extension

Extension of the file name used for the load and save operations.

scroller pos V

Gets or Sets the vertical scroller position.

scroller pos H

Gets or Sets the horizontal scroller position.

clicked column

Latest clicked column number starting at the index 0 (line headers). Sends -1 if nothing has been clicked.

clicked line

Latest clicked line number starting at the index 0 (column headers). Sends -1 if nothing has been clicked.

clicked index

Index of the latest clicked cell starting at the index 0. The index is the position in the output array. Sends -1 if nothing has been clicked.

show horizontal scroller

Shows or hides the horizontal scroller displayed at the bottom of the editor. The scroller is used to scroll the columns when they do not all fit in the width of the editor.

horizontal scroller height

Height of the horizontal scroller in pixels, from 0 to 100.

horizontal scroller color

Color of the horizontal scroller handle (the draggable part).

horizontal scroller back color

Background color of the horizontal scroller track.

horizontal scroller opacity

Opacity of the horizontal scroller, from 0.2 to 1 (fully opaque).

show vertical scroller

Shows or hides the vertical scroller displayed on the right side of the editor. The scroller is used to scroll the lines when they do not all fit in the height of the editor.

vertical scroller width

Width of the vertical scroller in pixels, from 0 to 100.

vertical scroller color

Color of the vertical scroller handle (the draggable part).

vertical scroller back color

Background color of the vertical scroller track.

vertical scroller opacity

Opacity of the vertical scroller, from 0.2 to 1 (fully opaque).

edit with dbl click

Determines how the value of a cell is edited with the mouse. When OFF, a single left click on a cell opens its value editor. When ON, a double click is required, so a single click only selects the cell without opening the editor. This avoids opening the editor by accident when clicking in the array.

hint

Hint text displayed on mouse over.

matrix

Matrix design settings.

global

items margin

Space in pixels, from 0 to 20, left between the cells, between the headers and the cells, and between the grid and the panel border. When mouse over effect is ON, the highlight of the hovered line and column also extends by this margin.

adjust client size

When ON, items width and items height are recomputed automatically each time the number of lines or columns changes, so that all the cells fill the panel (the line headers width, the column headers height and the items margin are subtracted from the available space). When OFF, the cells keep their fixed items width and items height and the cells that do not fit are reached with the scrollers.

mouse over effect

When ON, the whole line and the whole column of the cell under the mouse are highlighted with the mouse over color. When OFF, nothing is drawn when the mouse moves over the cells.

mouse over color

Color of the line and column highlight drawn under the mouse when mouse over effect is ON.

cursor color

Color of the 1 pixel outline drawn around the cell, the whole line or the whole column pointed by the cursor, when the module drives a cursor position (for example the cursor of the Panel Array Editor Data module). Nothing is drawn when no cursor is set.

cells

items width

Width of the cells in pixels, from 0 to 400 (default 50). Ignored and recomputed automatically when adjust client size is ON.

items height

Height of the cells in pixels, from 0 to 400 (default 14). The line headers share this height, and the font size of the cells text is derived from it (see items font size factor). Ignored and recomputed automatically when adjust client size is ON.

items round size

Radius in pixels, from 0 to 40 (default 0), of the rounded corners of the cells. 0 gives square corners.

items align

Horizontal alignment of the text displayed inside the cells (value, string or caption):

• center: text centered in the cell
• left: text aligned on the left edge of the cell
• right: text aligned on the right edge of the cell

items font color

Color of the text displayed inside the cells.

items font size factor

Font size of the cells text, as a factor from 0 to 3 (default 0.9) of the items height: 1 gives a text as high as the cell.

items background color

Fill color of the cells (for the Panel Matrix module, the color of the empty part of a cell). It is replaced by the module's cells color array when the module's cells color mode is set to color the cells by line, column or cell.

items foreground color

Color of the value part of the cells; only available for the Panel Matrix module (the Data and String array editors do not have it). In squares draw mode the cell is filled with this color with an opacity equal to its value (0 = invisible, 1 = fully opaque); in circles draw mode the circle outline is drawn with it. It is replaced by the module's cells color array when the module's cells color mode is set by line, column or cell.

items draw mode

Shape used to draw the value of the cells of the Panel Matrix module. It has no effect on the Data and String array editors, whose cells are always rectangles containing text.

• squares: each cell is a rectangle filled with the items background color, over which the items foreground color is drawn with an opacity proportional to the cell value.
• circles: each cell is drawn as a circle outline in the items foreground color whose diameter grows with the cell value (a small dot when the value is 0).

items circle line width

Thickness of the circle outline when items draw mode is set to circles, as a factor from 0 to 1 (default 0.6) of the cell width (the thickness is factor x items width x 0.3, never less than 1 pixel). Not used in squares mode.

headers

show line headers

When ON, a header column is displayed on the left of the grid, with one header cell per line showing the line name provided by the module. When OFF, the cells start directly at the left border.

line headers width

Width in pixels, from 0 to 400 (default 50), of the header column displayed when show line headers is ON. The height of the line headers is the items height. This width is subtracted from the space available for the cells when adjust client size is ON.

line headers round size

Radius in pixels, from 0 to 40 (default 0), of the rounded corners of the line header cells.

line headers align

Horizontal alignment of the text in the line headers:

• center: text centered in the header cell
• left: text aligned on the left edge
• right: text aligned on the right edge

line headers font color

Color of the text of the line headers.

line headers font size factor

Font size of the line headers text, as a factor from 0 to 3 (default 0.9) of the header cell height (the items height).

line headers font bold

When ON, the text of the line headers is drawn in bold. When OFF, it uses the regular style.

line headers background color

Fill color of the line header cells. It is replaced by the module's line headers color array when the module's line headers color mode is enabled.

show column headers

When ON, a header line is displayed on top of the grid, with one header cell per column showing the column name provided by the module. When OFF, the cells start directly under the panel caption.

column headers height

Height in pixels, from 0 to 400 (default 14), of the header line displayed when show column headers is ON. The width of the column headers is the items width. This height is subtracted from the space available for the cells when adjust client size is ON.

column headers round size

Radius in pixels, from 0 to 40 (default 0), of the rounded corners of the column header cells.

column headers align

Horizontal alignment of the text in the column headers (when column headers vertical caption is ON, the alignment applies along the rotated text):

• center: text centered in the header cell
• left: text aligned on the left edge
• right: text aligned on the right edge

column headers font color

Color of the text of the column headers.

column headers font size factor

Font size of the column headers text, as a factor from 0 to 3 (default 0.9) of the column headers height. When column headers vertical caption is ON, the factor applies to the items width instead.

column header font bold

When ON, the text of the column headers is drawn in bold. When OFF, it uses the regular style.

column headers vertical caption

When ON, the text of the column headers is rotated by 90 degrees and drawn vertically, reading from bottom to top, which allows long column names on narrow columns (increase the column headers height to make room for the text). When OFF, the text is drawn horizontally.

column headers background color

Fill color of the column header cells. It is replaced by the module's column headers color array when the module's column headers color mode is enabled.

Other Settings

hint

Hint text displayed on mouse over.

background

background color

Background color of the control, used to fill its whole surface behind the caption, the value and the drawing of the control. When the control is disabled the color is dimmed, and when the mouse is over it (with the mouse over effect ON) a slightly lighter shade is drawn.

Blue background color example.

transparent

When ON, the background of the control is not painted at all, so the controls or the patch located behind it remain visible. The background color is ignored and the mouse over highlight uses the global mouse-over color instead of a lighter shade of the background.

Example, the first module is transparent.

remote highlight color

Color of the contour flashed around the control when its value is modified by a remote source (MIDI, OSC, keyboard, etc.). The contour is drawn for about 100 ms after each remote change. By default it is a lighter shade of the module's quick color. The flash can be disabled globally by the disable remote highlight expert policy.

image file

Optional image drawn as the background of the control, behind the control drawing. Click to choose the file. The image is drawn with the image fit mode and the control opacity.

Example on an panel-xy-pad.

image fit mode

Determines how the image file is resized to the size of the control:

• proportional left aligned: the image is scaled to the height of the control, keeps its aspect ratio and is aligned on the left,
• scaled: the image is stretched to the full size of the control (default),
• original: the image keeps its original pixel size and is drawn from the top left corner,
• clipped: the image keeps its aspect ratio and is fitted entirely inside the control,
• scaled with borders: the image is stretched to the size of the control minus its border width,
• centered: the image keeps its aspect ratio, covers the whole control and is centered, the parts outside the control are cropped.

svg filename

Name of an SVG vector file drawn in the background of the control, above the image file. The path is scaled to the size of the control, so the drawing stays sharp at any size.

svg fill color

Color used to fill the shapes of the SVG. Use a fully transparent color to draw the contour only.

svg stroke color

Color used to draw the contour of the SVG shapes. Use a fully transparent color to disable the contour.

svg stroke width

Width of the contour of the SVG shapes, as a fraction of the smallest dimension of the control (0 to 1, default 0.1). The drawn thickness is one third of that fraction, so 0.1 on a 60 pixels wide control gives a 2 pixels contour.

svg margin

Space left between the border of the control and the SVG drawing, as a fraction of half the smallest dimension of the control (0 to 1, default 0.1). At 1 the drawing collapses to the center of the control.

svg keep aspect ratio

When ON (default), the SVG is scaled uniformly so it keeps its proportions and is centered in the available area. When OFF, the SVG is stretched independently in width and height to fill the whole area inside the svg margin.

border

show border

Displays or not the border of the control. When OFF, the border width is still used to compute the inner drawing area, but no border is painted.

8 pixels border on an panel-xy-pad.

border width

Width of the border in pixels, from 0 to 100 (default 0). The border is drawn inside the control, so a large border reduces the area available for the drawing of the control.

8 pixels border on an panel-xy-pad.

border color

Color of the border of the control.

a yellow border on an panel-xy-pad.

border OFF color

Border color of a switch when its state is OFF. For switches this color replaces the generic border color.

a black OFF border on a switch.

border ON color

Border color of a switch when its state is ON.

a white ON border on a switch.

round size

Radius of the rounded corners of the control in pixels, from 0 to 800 (default 2). Applies to the background, the border and the header of the control.

Example on a panel-shape.

don't draw selection border

When ON, the highlighted contour normally drawn around a control selected with the mouse in edit mode is not drawn for this control. Useful on decorative controls where the selection contour disturbs the design. The selection contour can also be disabled globally by the disable draw selected expert policy.

caption

show caption

Displays or not the caption (the name) of the control. When OFF, the whole surface of the control is available for its drawing and its value.

Example on a fader.

caption horizontal align

Horizontal alignment of the caption inside the control: center, left or right.

caption vertical align

Vertical alignment of the caption inside the control: center, top or bottom.

Example on knob: Center, top and bottom.

Example on switch.

caption font size factor

Multiplier applied to the size of the caption font, from 0 to 2 (default 0.6). The base size depends on the height of the control, so the caption follows the size of the control and this factor makes it bigger or smaller.

Example on switch.

caption font

Font family used to draw the caption, chosen in the list of the fonts installed on the system. The first item is the default Usine font.

Example with 3 different fonts on switch.

caption font color

Color of the caption text.

Example on switch.

caption font italic

When ON, the caption is drawn in italic.

Example on switch.

caption font bold

When ON, the caption is drawn in bold.

Example on switch.

caption font underline

When ON, the caption is underlined.

Example on switch.

frames

frames count

Number of frames contained in the background image file, from 1 to 256 (default 1). When greater than 1, the image is treated as a sprite sheet: it is split into equal frames and the frame displayed depends on the current value of the control. This allows custom knobs, faders and switches drawn as a sequence of images. See create your own knobs and faders.

frames alignment

Determines how the frames are stacked in the background image: vertical (frames one below the other, the image is split in height) or horizontal (frames side by side, the image is split in width). See create your own knobs and faders.

global

mouse editing enabled

Determines if the value of the control can be modified by the user with the mouse or the touch screen. When OFF, the control still displays its value and can be modified by its inlets, remotes and presets, but clicks and drags on it are ignored. Useful to build read-only displays.

receive mouse info

When ON, the control receives mouse information (often called hit-test). When OFF, the control is transparent to the mouse: clicks pass through it to the control located behind. This is useful when controls overlap, only the topmost control with receive mouse info ON gets the mouse events.

is visible

Sets or gets the visibility of the control. When OFF the control is hidden but keeps processing its value. Typically exposed as an inlet to show or hide parts of an interface from the patch.

global color

Main color of the control. When changed, Usine recomputes all the other colors of the control (background, border, caption, cursor, etc.) with contrasted shades derived from this color, and propagates the change to the child controls of a panel unless they are ignored in parent global color.

ignored in parent global color

When ON, the global color of this control is not modified when the global color of its parent panel, patch or rack changes. Use it to keep a specific color on one control inside a recolored group.

design template name

Name of the design template (a snapshot of the design tab settings) applied when the control is created. The template files are searched in /Resources/Templates/Design and /Config/Templates/Design. Setting a new name reloads the design settings from that file.

z order

Determines the drawing order of the control relatively to the other controls of the same container:

• normal: the control is drawn in its creation order,
• front: the control is always brought to the front, above all the other controls,
• back: the control is always sent to the back, behind all the other controls.

Example with the first knob on top.

opacity

Opacity of the whole control from 0 to 1 (default 1), applied to its background, border, caption and drawing. The opacity is multiplied with the opacity of the parent containers.

blur softness

Amount of blur applied to the drawing of the control, from 0 (no blur) to 5.

Example of blur.

location

display location

Determines where the control panel of the module is displayed. Default control panel.

• invisible: the object is not displayed.
• control panel: in the control-panel of the current patch.
• parent control panel: in the control-panel of the parent patch.
• top parent control panel: in the control-panel of the top parent patch (main patch).
• container: in the container of the current patch.
• parent container: in the container of the parent patch of the current patch.
• top parent container: in the container of the top parent patch of the current patch.
• popup window: in the popup of the current patch.
• top header: in the top-header-panel.
• toolbox: in the toolbox-panel.
• ib only: in the interface-builder-panel only.
• workspace: in the workspace-panel design panel.
• current rack: in the rack containing the top parent patch.
• main menu: in the main menu panel on the left of the window.
• container 1 to container 32: in the additional container with that number, wherever it is (see additional container). If the container does not exist, a warning is displayed.

Some modules only offer the first eight options. Top header, toolbox, ib only, popup and main menu are exclusive with also visible in interface builder: choosing one of them resets it to no with a warning.

additional container

Declares the control as an additional container, identified by a number from 1 to 32 (no = not a container, default), so that any other control of the workspace can be placed into it with display location set to the same container number. Each number can be used by only one container at a time: choosing a number already in use shows a warning and resets the setting to no.

a button inside a listbox

also visible in interface builder

Determines if the control is also displayed in the interface-builder-panel in addition to its display location. Default no. Not saved in design templates.

• no: not shown in the interface builder.
• always: always shown in the interface builder.
• if patch ON: shown only while the parent patch is running (for a rack, this option reads if rack is ON).

Cannot be combined with a display location set to top header, toolbox, ib only, popup or main menu: the setting is reset to no with a warning.

mouse tab settings

Settings related to mouse, touch screen and drag&drop.

mouse & gesture

mouse dwn

Outlet giving the mouse button state on the control:

• 1 while the left mouse button is pressed on the control
• 0 otherwise (the value goes back to 0 a few milliseconds after the button is released).

Read only, not saved with the patch.

mouse wheel

Outlet giving the last mouse wheel movement as a number of wheel notches (positive when the wheel is rolled forward, negative when rolled backward, following the operating system convention), limited to the [-4..4] range. The value goes back to 0 about 25 ms after each wheel event, so it is 0 while the wheel is idle. Not saved with the patch.

mouse wheel enabled

When ON, the value of the control can be changed with the mouse wheel; when OFF, the wheel is ignored by this control. Default ON. Unless the disable click to use mouse wheel expert setting is active, the control must first be clicked (selected) before the wheel acts on it. On faders, the wheel step is reduced by the precision factor when touch hi precision applies or when SHIFT is held, and the value wraps around when circular mouse is ON.

dbl click

Trigger outlet flashed (value 1) when the user double-clicks on the control.

mouse active

When ON, the fader can be moved by dragging it with the mouse; when OFF, dragging no longer changes the value (the control still reports its mouse events, and the value can still be changed by other means such as the mouse wheel or the value editing). Default ON.

mouse x

Outlet giving the mouse X position on the control in relative coordinates from 0=most-left to 1=most-right, updated on mouse down, mouse move and mouse up. Read only, not saved with the patch.

mouse y

Outlet giving the mouse Y position on the control in relative coordinates from 0=top to 1=bottom, updated on mouse down, mouse move and mouse up. Read only, not saved with the patch.

bitmap

bitmap in

Bitmap pointer input. When connected, the received bitmap replaces the background image of the panel of the module, so any video or bitmap flow can be drawn behind the control.

bitmap out

Bitmap pointer output giving access to the current drawing of the panel of the module, updated each time the panel is repainted. Connect it to a video or bitmap module to reuse the rendering of the control.

touch pressure

Outlet giving an estimation of the finger pressure on a multi-touch screen, in the [0..1] range, computed from the size of the contact area of the finger relative to the size of the control. Always 0 when the control is used with the mouse. Read only, not saved with the patch.

gesture

Array outlet updated each time a touch gesture is recognized on the control. It contains 6 values: [gesture ID, initial X, initial Y, final X, final Y, speed], X and Y being relative coordinates on the control. Gesture IDs: 1=pan left, 2=pan right, 3=pan up, 4=pan down with one finger, 5 to 8=the same pans with two fingers, 100=short hold and 101=long hold with one finger, 102=short hold and 103=long hold with two fingers. For hold gestures only the initial position is filled, the other values are 0. Not saved with the patch.

reset

auto reset

When ON, the control is reset (same action as the reset command of the module) as soon as the mouse button is released on it. Default OFF.

drag & drop

drag enabled

When ON, the content of the listbox can be dragged with the mouse and dropped on another control: the drag starts as soon as the mouse moves a few pixels with the button held down. When OFF, no drag is started from this control, except when CTRL+SHIFT are held while dragging. Default OFF. Only on listboxes (not on comboboxes).

allow drop

When ON, files and other draggable items can be dropped on this control; when OFF, the control refuses any drop.

drop file name

Text outlet receiving the full path of the last file dropped on the control. The same path is also stored in the DRAG_FILENAME global variable. Read only, not saved with the patch.

clear drop file name

Button that empties the drop file name outlet.

vertical mouse

When ON, the knob value follows the vertical movements of the mouse: drag up to increase, drag down to decrease. When OFF, it follows the horizontal movements: drag right to increase, drag left to decrease. Default ON. Only on knobs.

touch screen

touch hi precision

Determines when the high precision mode (see precision factor) is applied to mouse and touch movements:

• disabled: never applied automatically, it can still be obtained by holding SHIFT while dragging.
• touch screen: applied only while the control is touched on a touch screen.
• always: applied with the mouse as well as with a touch screen. Default disabled.

precision factor

Divider applied to the mouse or touch movements in high precision mode: the cursor moves N times slower than the pointer, so with a factor of 8 the pointer must travel 8 times the width of the control to cover the whole range. Range [1..100], default 8. Used when touch hi precision applies or when SHIFT is held while dragging; also slows down the mouse wheel steps (by the square root of the factor).

mouse mode

Behavior of the fader when the mouse button is pressed on it:

• relative: the value changes relatively to its current value by the amount of the mouse drag, the cursor does not jump on click.
• absolute: the value is directly given by the position of the mouse on the fader, the cursor jumps to the click position. Default relative.

circular mouse

When ON, the value wraps around when the mouse drag or the mouse wheel goes beyond the range: past the maximum, the value continues from the minimum and vice versa. When OFF, the value is clamped to its range. Default OFF.

keyboard arrows

keyboard arrows enabled

When ON, the value of the control can be modified with the UP and DOWN arrow keys of the keyboard when the control has the focus: each key press adds or subtracts the inc-dec value of the module (one tenth of it while SHIFT is held, at least 1 for integer values), and comboboxes jump to the previous or next item. Default OFF.

focus & cursor

mouse over

Read only outlet: 1 while the mouse pointer is over the control, 0 otherwise. Not saved with the patch.

mouse cursor

Shape of the mouse pointer when it hovers over the control. Default arrow. During a resize or a point edit, the pointer temporarily takes the shape of the current operation.

• default: default pointer of the system
• none: the pointer is hidden
• arrow: standard arrow
• cross: cross-hair
• beam: text I-beam
• size NESW: diagonal resize arrow (north-east / south-west)
• size NS: vertical resize arrow
• size NWSE: diagonal resize arrow (north-west / south-east)
• size WE: horizontal resize arrow
• up arrow: vertical arrow
• hour glass: busy pointer
• drag: drag pointer
• no drop: forbidden drop pointer
• H split: horizontal splitter
• V split: vertical splitter
• multi drag: multiple items drag pointer
• SQL wait: wait pointer
• no: forbidden pointer
• app start: arrow with busy indicator
• help: arrow with question mark
• hand point: pointing hand
• size all: move (four arrows) pointer

  selection

  selected

  Read only outlet: 1 while the control is selected, 0 otherwise. A control becomes selected when it is clicked and is deselected when another control is clicked; SHIFT+click adds a control to the current selection or removes it from it. Not saved with the patch.

remote tab settings

Settings related to remote control assignation and learn.

general

clear all learn

Button. Resets the whole remote configuration of the control to its defaults: MIDI, key, OSC, timecode, bind bus, bind control, VCA, cluster, DMX and mapping assignations are all cleared and the control is removed from the remote lists. To clear only one part, use clear bind bus or clear bind control.

remote active

ON/OFF switch, default ON. When OFF, all the remote assignations of the control (MIDI, key, OSC, timecode, DMX, binds) are ignored, even if they stay stored in the control. When ON, the assignations are processed according to active mode.

inverse

ON/OFF switch, default OFF. When ON, the received value is inverted before being applied to the control: MIDI values become 127 - value (16129 - value for pitch bend), OSC and bind values in the [0..1] range become 1 - value, relative MIDI moves go in the opposite direction and a sysex learn sends 0 instead of 127.

quantize

Delays the application of a received remote value until the next synchronisation event of the master synchro. The quantization is only applied when the master synchro is playing; otherwise the value is applied immediately. Only available on controls that can be quantized. Default none.

• none: no quantization, the value is applied immediately.
• cycle: the value is applied on the next cycle start.
• bar: the value is applied on the next bar.
• beat: the value is applied on the next beat.
• eight: the value is applied on the next eighth note.
• sixteen: the value is applied on the next sixteenth note.

active mode

Determines when the remote assignations of the control are processed. Has no effect if remote active is OFF. Default always.

• always: the remote is always processed.
• if rack is ON: only when the parent rack is enabled.
• if rack is selected: only when the parent rack is selected.
• if patch is ON: only when the root patch is running (its control panel is enabled).
• if patch is selected: only when the control panel of the root patch is selected.
• if mouse editing enabled: only when the mouse editing enabled setting of the control is ON.

bind buses

clear bind bus

Button. Removes the bind bus assignation of the control: binding is emptied and the control is removed from the bind bus remote list.

binding

Name of the bind bus the control listens to (empty = no bind). Each time the bus value changes, it is applied to the control (in the [0..1] range, scaled to the control range, after inverse and the mapping settings). On a panel, the bus enables it when the value is above 0.5; on a button, it triggers it. The control is highlighted with the color of the bus while it receives values.

bind controls

bind ID

Unique ID of the source control this control is bound to (empty = no bind). The source is looked up by this ID; if it no longer exists, the bind is cleared automatically. The value of the source control is copied to this control each time it changes, scaled from the source range to the target range (switches and data values follow inverse; listbox, trigger and color values are copied as they are).

bind caption

Read-only. Caption of the source control identified by bind ID, refreshed automatically when the bind is processed. Also available as an outlet on modules.

clear bind control

Removes the bind control assignation: bind ID and bind caption are emptied and the control is removed from the bind control remote list.

MIDI

start midi learn

Button. Arms the MIDI learn: move a control on your MIDI device and the first message received is assigned to the control (channel, control type, control num, device name and, if the device is declared as motorized in the devices panel, motorized are filled automatically).

device name

Name of the MIDI device the assignation is restricted to. Filled during the learn when the memorize device name in learn setting of the setup panel is ON. When empty, the assignation reacts to all connected MIDI input devices; MIDI feedback (motorized) is also sent only to the device with this name unless MIDI feedback to all is ON in the setup.

channel

MIDI channel used for the MIDI assignation, from 1 to 16. Only messages received on this channel are taken into account.

control num

Data number of the assigned MIDI message, from 0 to 127: note number for notes and poly aftertouch, controller number for control changes. Ignored for program change, channel aftertouch and pitch bend, which match any number.

control type

Type of MIDI message assigned to the control (the MIDI status value is shown in parentheses).

• none: no MIDI assignation.
• note OFF (128).
• note ON (144): a note OFF of the same note also sets the control to its minimum (except in toggle mode).
• poly aftertouch (160).
• control change (176).
• program change (192): the program number is used as value.
• chan aftertouch (208): the pressure is used as value.
• pitch bend (224): the 14-bit value (0 to 16129) is used.

midi mode

Choose between the 3 MIDI assignation modes in Usine. Default absolute.

• absolute: the received value (0 to 127) is scaled to the control range. For a switch or a panel, the control is ON while the value is not 0 and OFF on a value of 0 (or on the note OFF). For a button, any non-zero value triggers it. For a listbox, the value selects the item proportionally.
• relative: for endless encoders. The received value is interpreted as a signed increment around 64 (APC style values below 32 or above 96 are also supported): a float fader moves by (value - 64) / 127, an integer fader or a listbox goes to the next or previous item, a button is triggered on each message.
• toggle: each received message with a non-zero value toggles a switch or a panel between ON and OFF, or triggers a button. On listboxes and integer faders, each message increases the current value by one until the maximum is reached, then restarts from the minimum.

mackie mode

ON/OFF switch, default OFF. Only used together with motorized. When ON, the MIDI feedback is always sent back to the controller, including for the value just received (as required by the Mackie Control protocol to update displays, leds and fader positions). When OFF, the value just received from MIDI is not sent back, to avoid MIDI loops.

motorized

ON/OFF switch, default OFF (set automatically during the learn when the device is declared as motorized). When ON, each time the value of the control changes Usine sends the corresponding MIDI message (same channel, control type and control num) to the MIDI output devices so that motorized faders, leds or displays follow the on-screen value. The message is sent to the output device named in device name only, unless MIDI feedback to all is ON in the setup or the name is empty.

soft take over

ON/OFF switch, default OFF. When ON, an incoming MIDI (or DMX, bind bus) value is ignored as long as it differs from the current position of the control by more than 4%, unless the control was already moved by the remote during the last second. Once the hardware control matches the on-screen value, the control latches on and follows it again.

sysex

System exclusive string assigned to the control (hexadecimal bytes, filled by the MIDI learn when a sysex message is received). Each time the same sysex is received, the control is set to its maximum (or toggled, depending on the control type and midi mode); with inverse ON it is set to its minimum.

Key

start key learn

Click on this button and press a key (or a key combination ie. [ALT+E]) on your keyboard to assign it. Only available on controls that accept key learn. [Esc] cancels the learn.

key

Text of the key or key combination assigned to the control, as displayed in the settings (for example A or ALT+E). You can also type it by hand: in that case shortcut is 0 and the text is compared, in uppercase, with the typed character. Empty means no key assignation.

key mode

Determines how the key affects a switch. Default toggle. Only available on controls that allow changing the key mode.

• absolute: the switch is ON while the key is held down and goes back to OFF when the key is released.
• toggle: each key press toggles the switch between ON and OFF.

Buttons are triggered and panels are enabled/disabled on each key press whatever the mode.

shortcut

Numeric key code of the assigned key (0 to 65535, ex: A=65), including the modifier bits, filled automatically by the key learn. 0 means the key text is used as a user key.

mapping

mapping curve

Curve applied to the received value (in the [0..1] range) before it is scaled to the control range, for MIDI, DMX, bind bus and OSC in in [0..1] mode. Default linear.

• log or exp: power curve x^(1/coeff); a mapping curve coeff below 1 gives an exponential-like curve, above 1 a logarithmic-like curve.
• S curve: S-shaped curve whose strength depends on mapping curve coeff.
• linear: no curve, the value is used as is.

The resulting curve is drawn below the settings.

mapping curve coeff

Coefficient of the mapping curve, from 0.001 to 100 (logarithmic scale), default 1. Has no effect when mapping curve is linear.

mapping range max

Upper limit of the mapped value in the [0..1] range, default 1. The received value (after the mapping curve) is rescaled between mapping range min and mapping range max before being applied to the control range. If it is lower than mapping range min, the control stays at mapping range min.

mapping range min

Lower limit of the mapped value in the [0..1] range, default 0. See mapping range max.

OSC

start OSC learn

Click on this button and use a control of your OSC device to assign it. The address of the first OSC message received is stored in OSC message and OSC tag order is reset to 1.

OSC message

OSC address assigned to the control (for example /1/fader1). Each message received with exactly this address sets the control (buttons ignore messages with a 0 value, panels are enabled when the value is above 0.5). Empty means no OSC assignation.

OSC mode

Determines how the received OSC value is interpreted. Default real value.

• real value: the value is applied to the control as it is received, without scaling.
• in [0..1]: the value is considered to be in the [0..1] range and is scaled to the control range, after the mapping settings.

OSC tag order

Index (1 to 256, default 1) of the argument used when the OSC message carries several values at once (for example the X and Y of an XY pad): 1 uses the first argument, 2 the second, etc. Reset to 1 by the OSC learn.

timecode

Timecode position at which the control is triggered (buttons and other trigger controls). The trigger happens once, when the incoming timecode passes this position. 0 means no timecode assignation.

timecode OFF

Timecode position at which a switch control is set to its minimum (OFF). Only checked if the timecode ON position was not reached at the same time.

timecode ON

Timecode position at which a switch control is set to its maximum (ON). 0 means no timecode assignation.

VCA

vca

Name(s) of sources VCA's. One control can be controlled by several VCA at the same time so the VCA values are multiplied together.
To enter several names use comma separated string like VCA1,VCA2,VCA3. Names are converted to uppercase and trimmed when applied.
See use-vca for more info.

clusters

cluster name

Name(s) of the owner cluster(s). One control can be in many clusters at the same time, but be aware that you could have conflicts (different value sent at the same time).
To enter several names use comma separated string like CLUSTER1,CLUSTER2,CLUSTER3.
See use-clusters for more info.

DMX

DMX universe

Art-Net universe number (0 to 32767, default 0) the control listens to. Only DMX packets received on this universe are taken into account.

DMX channel

DMX channel (1 to 512) assigned to the control in the universe, 0 (default) means no DMX assignation. The received byte (0 to 255) is scaled to [0..1] then applied: faders follow the value (through the mapping settings and soft take over), switches and panels are ON when the value is above or equal to 0.5, buttons are triggered when the value rises above 0.5, listboxes select the item proportionally.

size tab settings

settings related to size and position of controls.

orientation

rotation angle

Rotation of the control around its center, expressed as a fraction of a full turn in the range [0..1] (0.25 = 90 degrees, 0.5 = 180 degrees, 0.75 = 270 degrees). Default 0. A value of 0.75 also switches is vertical ON, any other value switches it OFF. Only available on controls that can be rotated (faders, modules...).

is vertical

When ON, the control is displayed vertically, which is the same as a rotation angle of 0.75 (270 degrees). When OFF, the rotation angle is reset to 0. Changing it also triggers the auto resize and the reorganization of the parent panel.

zoom

zoom scale

Scale factor applied to the whole control: its visual is drawn scaled by this factor. Range [0.2..5] (logarithmic scale), default 1. Changing it triggers the auto resize and auto reorganize of the parent panel. This value is not saved in design templates.

can zoom

When ON, the control can be zoomed with the mouse wheel or a pinch gesture. On most controls this changes the zoom scale; on XY/XYZ style panels it changes the inner zoom factor instead. When OFF, wheel and gesture zooms are ignored by the control.

zoom at mouse position

Only available on XY/XYZ style panels. When ON, zooming with the mouse wheel keeps the point under the mouse cursor fixed, by moving the zoom center accordingly. When OFF, the zoom is centered on the current zoom center (the center of the panel by default).

Size & positions

top

Position of the top edge of the control in pixels, relative to its parent panel. Range [-5 x screen height..5 x screen height].

left

Position of the left edge of the control in pixels, relative to its parent panel. Range [-5 x screen width..5 x screen width].

height

Height of the control in pixels. Range [0..5 x screen height].

width

Width of the control in pixels. Range [0..5 x screen width].

percent

position percent x

Horizontal position of the control in the range [0..1], relative to the free horizontal space of the parent panel (parent width minus the control width and the borders): 0 = against the left border, 1 = against the right border. This value is computed from left and is not saved.

position percent y

Vertical position of the control in the range [0..1], relative to the free vertical space of the parent panel (parent height minus the control height, the borders and the caption area): 0 = just below the caption, 1 = against the bottom border. This value is computed from top and is not saved.

height percent

Height of the control in the range [0..1], relative to the parent panel height. This value is computed from height and is not saved.

width percent

Width of the control in the range [0..1], relative to the parent panel width. This value is computed from width and is not saved.

resize grip

resize grip enabled

When ON (default for modules), the control displays selection handles when the patch is unlocked and can be moved or resized with the mouse or the arrow keys. When OFF, the control cannot be unlocked, moved nor resized in the patch. On XY/XYZ style panels this setting is named resize grip enabled (global).

Interface Builder position

interface builder top

Position of the top edge of the control in pixels when it is displayed in the interface builder panel. Memorized automatically when the control is moved in the interface builder and restored the next time it is displayed there; the position in the patch is kept separately. Only available on controls that can be also visible in the interface builder.

interface builder left

Position of the left edge of the control in pixels when it is displayed in the interface builder panel. Memorized automatically when the control is moved in the interface builder and restored the next time it is displayed there; the position in the patch is kept separately.

interface builder width

Width of the control in pixels when it is displayed in the interface builder panel. Memorized automatically when the control is resized in the interface builder and restored the next time it is displayed there; the size in the patch is kept separately.

interface builder height

Height of the control in pixels when it is displayed in the interface builder panel. Memorized automatically when the control is resized in the interface builder and restored the next time it is displayed there; the size in the patch is kept separately.

floating panel

floating x

When ON, the control can be dragged horizontally with the mouse inside its parent panel (the cursor becomes a horizontal move cursor when only this axis is enabled). Floating controls are also the moving bodies of the parent's physics engine (see physics enabled): a control with both floating x and floating y OFF is a static obstacle.

floating y

When ON, the control can be dragged vertically with the mouse inside its parent panel (the cursor becomes a vertical move cursor when only this axis is enabled). Floating controls are also the moving bodies of the parent's physics engine (see physics enabled).

floating constrain to parent x

When ON (default), a control dragged along the X axis (floating x) is kept entirely inside the borders of its parent panel. When OFF, it can be dragged partly outside the parent, as long as at least 10 pixels remain visible.

floating constrain to parent y

When ON (default), a control dragged along the Y axis (floating y) is kept entirely inside the borders of its parent panel. When OFF, it can be dragged partly outside the parent, as long as at least 10 pixels remain visible.

resizable panel

resizable left

When ON, the control can be resized with the mouse by dragging its left edge (the cursor changes to a resize cursor near the edge). When OFF, the left edge cannot be dragged.

resizable right

When ON, the control can be resized with the mouse by dragging its right edge (the cursor changes to a resize cursor near the edge). When OFF, the right edge cannot be dragged.

resizable top

When ON, the control can be resized with the mouse by dragging its top edge (the cursor changes to a resize cursor near the edge). When OFF, the top edge cannot be dragged.

resizable bottom

When ON, the control can be resized with the mouse by dragging its bottom edge (the cursor changes to a resize cursor near the edge). When OFF, the bottom edge cannot be dragged.

physics

physics enabled

When ON, the physics engine of the panel is started: the child controls with floating x or floating y ON become moving bodies subject to gravity x, gravity y, friction and elasticity, and they collide with each other and with the panel borders; the other child controls are static obstacles. The simulation runs only while the main ON/OFF switch is on, the patch is running and the main lock switch is off. Available on XY/XYZ style panels, container panels and popup panels.

physics speed

Speed of the simulation: the number of physics iterations computed at each refresh is multiplied by this value. Range [0..100] (logarithmic scale), default 1; 0 freezes the engine. It also scales the speed x, speed y and angular speed values reported by the child controls.

init with random speed

When ON (default), every moving body gets a random initial velocity and rotation speed when the physics engine is (re)started, for example after reset positions. When OFF, the bodies start at rest.

same masses

When ON (default), all moving bodies have the same mass. When OFF, the mass of each body is proportional to its area (width x height), so bigger controls push smaller ones on collision.

ignored in physical engine

Setting of a child control. When ON, the control is excluded from the physics engine of its parent panel: it is neither moved nor used as an obstacle, and it is not affected by reset positions.

friction

Friction coefficient applied to the moving bodies, in the range [0..10] (logarithmic scale), default 0 (no friction). Higher values slow the controls down faster.

elasticity

Energy conservation coefficient on collision, in the range [0..1], default 1: 1 = fully elastic bounce (no energy lost), 0 = the body stops on collision.

gravity x

Horizontal gravity applied to the moving bodies, in the range [-5..5], default 0. Positive values pull the controls to the right, negative values to the left.

gravity y

Vertical gravity applied to the moving bodies, in the range [-5..5], default 0. Positive values pull the controls downward, negative values upward.

reset pos x

Horizontal position, in the range [0..1] of the parent panel width, where the child controls with floating x ON are placed by reset positions. Default 0.

reset pos y

Vertical position, in the range [0..1] of the parent panel height, where the child controls with floating y ON are placed by reset positions. Default 0.

reset positions

Button which moves all the child controls managed by the physics engine (see ignored in physical engine) to reset pos x / reset pos y and restarts the simulation (with random speeds if init with random speed is ON). Only effective when physics enabled is ON.

angular speed

Read-only, not saved. Rotation speed of the control computed by the physics engine of its parent panel (scaled by physics speed). Range [-10..10].

collide

Read-only trigger, not saved. Sends a trigger each time the control collides with another child control or with a border of its parent panel in the physics engine. On the panel itself, it is triggered when one of its child controls hits a border.

collide info

Read-only, not saved, in the range [0..1004]. Identifies what the control collided with during the last collide:

• 0 to 999: index of the other child control (in the order of the panel's children managed by the physics engine),
• 1001: top border of the parent,
• 1002: bottom border of the parent,
• 1003: left border of the parent,
• 1004: right border of the parent.

On the panel itself, it gives the index of the child control which hit a border.

speed x

Read-only, not saved. Horizontal speed of the control in the range [-10..10], computed by the physics engine of its parent panel (scaled by physics speed), or from the mouse movement while the control is being dragged.

speed y

Read-only, not saved. Vertical speed of the control in the range [-10..10], computed by the physics engine of its parent panel (scaled by physics speed), or from the mouse movement while the control is being dragged.

minimize

minimized

When ON, the panel is minimized: only its header is displayed, its size is memorized and restored when the setting is switched OFF. Only available on panels having the minimize button in their toolbar. Not saved in design templates.

reorganization

auto reorganize

When ON, the child controls of the panel are automatically laid out one after the other (in rows and columns) each time a control is added, removed, moved or resized, using reorganize margin, reorganize interspace H and reorganize interspace V. When OFF, the controls keep the positions given by the user.

reorganize margin

Left and top margin in pixels, in the range [0..20], between the panel border and the first control when the panel is reorganized. Default 4.

reorganize interspace H

Horizontal space in pixels, in the range [0..20], between two columns of controls when the panel is reorganized. Default 4.

reorganize interspace V

Vertical space in pixels, in the range [0..20], between two rows of controls when the panel is reorganized. Default 4.

auto resize options

auto resize

When ON, the panel automatically adjusts its width and height to its content each time child controls are moved or resized, keeping auto resize margin around them. Switch it OFF if you use floating panels inside.

auto resize margin

Margin in pixels, in the range [0..20], kept between the child controls and the panel borders when auto resize is ON. Default 4.

force reorganize

Button which lays out the child controls immediately (as auto reorganize does), even if auto reorganize is OFF, then applies the auto resize. It can also be exposed as an inlet.

align to grid

snap to grid

When ON, in unlock mode, the position and the size of the child controls are snapped to a grid of grid size pixels when they are moved or resized with the mouse. Floating controls dragged inside the panel are snapped too.

grid size

Step of the grid in pixels, in the range [1..40], used when snap to grid is ON. Default 2.

curve tab settings

Settings related to automation curve recording and playback.

curve

auto record on click

When ON, the recording of the automation curve of the control starts automatically when the user presses the mouse on the control, and stops when the mouse button is released, without using the global record switch. Each click therefore replaces the previous recording of the control.

delete curve

Deletes the recorded automation curve of the control. The control keeps its current value.

is playing record

Read-only output which sends 1 while the control is playing a recorded automation curve and 0 otherwise. Not saved with the patch, typically exposed as an outlet to know when the control is driven by its curve.

header toolbar

show toolbar

When ON, the toolbar icons (close, enable, and the other commands of the panel) are displayed in the header of the panel; when OFF, the toolbar is removed and the header only shows the caption. Default ON. Only available when the header is enabled (show header ON).

Example ON and OFF

toolbar size factor

Size of the toolbar icons, expressed as a factor of the header height: 1 gives icons as high as the header, 0.5 gives icons half the header height. Range [0..4], default 1.

Example toolbar size on a panel.

header

show header

Displays or not the header bar at the top of the panel. The header holds the caption of the panel and, when enabled, its toolbar buttons (minimize, close, etc.). When OFF, the caption and the toolbar are hidden and the whole height of the panel is available for its content.

Example on sequenced-lines.

header height

Height of the header in pixels, from 0 to 50. The toolbar buttons and the caption are scaled to this height.

header color

Background color of the header. When the panel is being MIDI learned, the header takes the MIDI learn color instead.

solid header color

When ON, the header is drawn as a solid bar spanning the whole width of the panel (HH5 style), with the rounded corners of the panel. When OFF, only a small bar is drawn in the upper left corner of the panel and the rest of the header area shows the panel background.

plain ON

plain OFF

saved in preset

Determines if parameters of this object are saved in the preset-panel.

fade preset

Parameters of the this object can cross faded when you recall a preset in the grid.

can be randomized

When ON, this object will be randomized when using the randomize command.

can be reset

When ON, this object will be reset to its default value when using the reset command of its patch.

horizontal scroller

show horizontal scroller

Allows or not the horizontal scroller to be displayed at the bottom of the container. Default ON. When ON, the scroller appears automatically as soon as the content of the container is wider than the container itself and disappears when the content fits again; when OFF, it is never displayed and the content is scrolled back to its origin.

Example of horizontal scroller

horizontal scroller height

Height of the scroller bar in pixels, from 0 to 100, default 14.

horizontal scroller color

Color of the scroller thumb (the moving part whose length represents the visible portion of the content).

horizontal scroller back color

Background color of the scroller track. Default is fully transparent, so only the thumb is visible.

horizontal scroller opacity

Opacity of the scroller, from 0.2 to 1, default 1.

vertical scroller

show vertical scroller

Shows or hides the vertical scroller drawn along the right edge of the container. Default ON. Even when ON, the scroller is only drawn when the content of the container is taller than its visible area.

vertical scroller width

Width of the scroller in pixels, from 0 to 100, default 14.

vertical scroller color

Color of the scroller thumb (the moving part whose height represents the visible portion of the content).

vertical scroller back color

Background color of the scroller track. Default is fully transparent, so only the thumb is visible.

vertical scroller opacity

Opacity of the scroller, from 0.2 to 1, default 1. It is multiplied by the opacity of the container itself.

Common Settings

info

show manual

Button. Opens the manual page of the selected object (or of its parent module for a control) in the web browser. If no page exists for this object, an error is traced in the trace panel.

For more details about information/help creation, see create-help-file.

description

Free multi-line text attached to the module, saved with the patch. It is only meant as an internal note for the patch designer: it is not displayed in the interface.

ID's

visible only in god mode, see setup-panel-tab-expert.

unique ID

Read-only, not saved. Current private numeric ID of the object, used internally to identify it (for example as the target of a bind ID).

preset ID

Read-only, not saved. Private ID used to store and recall the values of this control in presets.

recreate ID

Button. Generates a new unique ID, original ID and preset ID for the object. Use it if you experience difficulties in Polyphonic mode or if two objects share the same ID. Preset values and binds referring to the old IDs are lost.

Object Remote Address

absolute

Read-only, not saved. Absolute address of the object in the Usine objects tree, built from the workspace root. This is the address to use to reach the object from scripts, the objects panel or remote messages. Only shown for objects that are registered in the objects list. See objects-address.

local

Read-only, not saved. Address of the object relative to the current patch, valid inside that patch only. See objects-address.

user addr

Free user-defined address for the object (empty by default). When set, the object is also registered in the objects tree under this name, so it can be reached independently of its position in the workspace (the value is also reported in the mouse-over and mouse-down chunks). Changing it rebuilds the objects list. Only available on objects that support a user address. See objects-address.

See also

• MIDI Mix Matrix
• Panel Array Editor String
• Panel Matrix
• Panel Array Editor Data
• Audio Mix Matrix
• Point3D Matrix Array to 3D Points
• Points3D Points to Matrix Array