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 mode for exclusion, used if you want to allow only one cell activated per line or column.

• disabled : no exclusive mode
• per line : only one cell activated per line.
• per column : only one cell activated per columns.
• all : only one cell activated in all the 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.

line headers captions

Captions of the cells as a comma-text.

line headers captions

Captions of the lines headers as a comma-text.

columns headers

Captions of the columns headers as a comma-text.

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

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.

hint

Hint text displayed on mouse over.

Other Settings

hint

Hint text displayed on mouse over.

background

background color

Background color of the control.

Blue background color example.

transparent

Determines if the background of the control is transparent or not.

Example, the first module is transparent.

hilited color

Background color when the control is modified by a remote (MIDI,OSC,etc.).

image file

Optional Filename of the background image.

Example on an panel-xy-pad.

fit size

Force the image file to adapt its displayed size to the size of the object.

• proportional: the image keeps its proportion ratio and is left aligned,
• scaled: the image is scaled to the object size,
• original: keeps the original size
• clipped: the image is clipped to the object size, and centered,
• scaled: the image is scaled to the object size taking into account the border-size of the control.

Bitmaps

bitmap in

Background bitmap input.

bitmap out

Background bitmap output.

border

show border

Displays or not the border of the control.

8 pixels border on an panel-xy-pad.

border width

Sets the border width of the control in pixel.

8 pixels border on an panel-xy-pad.

border color

Border color of the control.

a yellow border on an panel-xy-pad.

border OFF color

Border color when the control is OFF.

a black OFF border on a switch.

border ON color

Border color when the control is ON.

a white ON border on a switch.

round size

Thickness of rounded corners.

Example on a panel-shape.

don't draw selection border

Enables or disables the drawing of a border when the control is selected with the mouse.

caption

show caption

Displays or not the caption.

Example on a fader.

caption align

Caption alignment of the control, left, center or right.

caption V align

Vertical alignment of the caption, center, top or bottom.

Example on knob: Center, top and bottom.

Example on switch.

caption font size factor

Size multiplication factor applied to the caption font.

Example on switch.

caption font

Font name of the control caption.

Example with 3 different fonts on switch.

caption font color

Color of the caption font.

Example on switch.

caption font italic

Italic style for caption font.

Example on switch.

caption font bold

Bold style for caption font.

Example on switch.

caption font underline

Underline style for the caption font.

Example on switch.

drag & drop

drag enabled

Enables the drag on this control.

allow drop

Enables or disables the drag&drop possibilities on this control.

drop file name

Name of the dropped file.

clear drop file name

Clears the latest dropped file name.

global

edition enabled

Determines if the control can be modified by the user. When OFF, the mouse interaction and modifications are disabled so the user can't change the value.

is visible

Sets or get the visibility of the control.

global color

Global color of the control. Usine will choose the best contrasted colors according the global color.

ignored in parent global color

When ON the global color of the control is not affected (is isolated) when the parent control global color changes.

snapshot name

Name of the snapshot (which contains the visual properties) loaded when the object is created. By default the snapshots files are located in /Resources/Snapshots/ or /Config/Snapshots.

on top

Determines the Z-order of the control

• normal: the Z-order is the control creation order
• on top: the control appears always on top of all other controls
• backward: the control appears always behind all other controls

Example with the first knob on top.

opacity

Opacity value of the control.

blur softness

Blur amount applied to the object.

Example of blur.

header

show header

Displays or not the header on the panel.

Example on sequenced-lines.

header height

Height of the header in pixels.

header color

Background color of the header.

plain header

Determines if the header is drawn as a plain bar (HH5 style) or as small bar in the upper left corner.

plain ON

plain OFF

horizontal-scroller

show H scroller

Determines if the horizontal scroller is visible or not.

Example of horizontal scroller

h scroller height

Height of the scroller in pixels.

h scroller color

Scroller color.

h scroller opacity

Scroller opacity.

ID's

unique ID

Current private id for this control.

recreate ID

If you experience difficulties in Polyphonic mode, try to recreate new id(s) with this button.

repair ID s

Each Patch shared on the local network uses its own ID (identification number). If you experience issues of Patches that don't send information to the good target, this button will rebuild all these id's.

info

show info

Opens the web browser to display information's or help about the selected object, if it exists.

location

where

Determines where the object is visible.

• invisible: the object is invisible.
• ctrl panel: in the control-panel.
• parent ctrl panel: in the control-panel of the parent patch if it exists.
• top ctrl panel : in the control-panel of the top parent patch (main patch) if it exists.
• 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.
• pop up window: visible in the popup.
• top header: visible in the top top-header-panel.
• toolbox: visible in the toolbox-panel.
• workspace: visible in the workspace-panel.
• additional container: visible in an additional container, identified by a number. See bellow.

is additional container

Sets the control as an additional container so any other control can be placed into that container. The additional container is identified by a number.

a button inside a listbox

also visible in IB

When ON, will also be visible in the interface-builder-panel.

Mouse

mouse dwn

Gives the mouse state of the control:

• 1 if the mouse is pressed
• 0 otherwise.

mouse wheel

Gives the mouse wheel speed and direction, -1,-2,-3,...=forward, 1,2,3,...=backward.

mouse wheel enabled

Enables or disable the mouse wheel action.

dbl click

Sends a 1 value if the user has [dbl-clicked] on the control.

mouse active

Determines if the mouse is active on the control.

mouse y

Gives the mouse X position on the control in relative coordinates from 0=most-left to 1=most-right.

mouse x

Gives the mouse Y position on the control in relative coordinates form 0=top to 1=bottom.

touch pressure

Pressure value on touch-screens.

gesture

Gesture information's.

auto reset

When ON, the value of the control is reset automatically on mouse up.

vertical mouse

When ON, move up-down to rotate a knob, left-right when OFF.

mouse over

Sends a 1 value when the control is hovered with the mouse.

mouse over

Sends 1 when the control is mouse overed.

selected

Sends 1 when the control is selected.

Size, positions

top

Top position of the control in pixels.

left

Left position of the control in pixels.

height

Height of the control in pixels.

width

Width of the control in pixels.

position x

Horizontal position in % [0..1] relative to the parent panel.

position y

Vertical position in % [0..1] relative to the parent panel.

heightpc

Height in % [0..1] relative to the parent panel.

widthpc

Width in % [0..1] relative to the parent panel.

iB top

Top position in pixels in the interface-builder-panel.

iB left

Left position in pixels in the interface-builder-panel.

iB width

Width in pixels in the interface-builder-panel.

iB height

Height in pixels in the interface-builder-panel.

rotation angle

Rotation angle of the control.

vertical

Rotates this control in vertical position.

zoom scale

Zoom scale of the control.

can zoom

Determines is the control can be zoomed with the wheel mouse.

resize grip enabled

Determines if the control can be resized with the resize grip.

minimized

Determines if the control is minimized or not.

floating x

Determines if the control is movable on X axis.

floating y

Determines if the control is movable on Y axis.

floating content parent x

When ON the control stays inside the parent on X axis.

floating content parent y

When ON the control stays inside the parent on Y axis.

TpgControl_Button.floating content parent y

resizable left

Determines if the control can be resized on its left hand.

resizable right

Determines if the control can be resized on its right hand.

resizable top

Determines if the control can be resized on its top hand.

resizable bottom

Determines if the control can be resized on its bottom hand.

Physics-engine

physics enabled

Enables physics-engine in this panel.

physics speed

The physics speed of the control in physics-engine.

init with random speed

When ON, the physics-engine starts with a random speed for each child controls.

same masses

When ON, all controls have the same masses in the physics-engine.

ignored in physical engine

The position control is not affected by the physics-engine.

friction

Friction factor in the physics-engine.

elasticity

Energy conservation coefficient on collision.

gravity x

Gravity factor on the X axis.

gravity y

Gravity factor on the Y axis.

reset pos x

Position of the object when the physics engine is reset on X axis.

reset pos y

Position of the object when the physics engine is reset on Y axis.

angular speed

Angular speed of the control in the physical engine.

collide

Sends a 1 value when the control collides with another control or a border.

collide info

Gives information about the collide state in the physics-engine.

• 1001: top of the parent,
• 1002: right side of the parent,
• 1003: left side of the parent,
• 1004: bottom of the parent.

speed x

Speed vector value on the X axis in the physics-engine.

speed y

Speed vector value on the Y axis in the physics-engine.

Layouts

auto reorganize

Automatically reorganize positions of controls in the panel.

reorganize margin

Left margin used in reorganization, in pixels.

reorganize interspace

Interspace between controls used in reorganization, in pixels.

auto resize

Resizes panels automatically when child controls are moved or resized. Switch it OFF if you use floating panels inside.

auto resize margin

Margin in pixel used for the auto resize option.

fit standard size

Adjust the panel width to a multiple of the default rack width.

snap to grid

In unlock mode, snap the control to a grid.

grid size

Grid size in pixels when snap to grid is ON.

Toolbar

show toolbar

Displays the toolbar with its icons.

Example ON and OFF

toolbar size factor

Height of the toolbar % of the global height.

Example toolbar size on a panel.

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.

See also

• 3D Points to Matrix Array
• 3D Matrix Array to 3D Points
• MIDI Mix Matrix
• Panel Array Editor String
• Panel Matrix
• Panel Array Editor Data
• Audio Mix Matrix
• Matrix Exclusive Mode (SCRIPT)
• Matrix MIDI Mix [Legacy] (USER MODULE)
• Matrix Data Mix (USER MODULE)