mouse

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.

In multi-touch environment, can be an array of [0..1] values, one value per finger touching the control.

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.

In multi-touch environment, can be an array of [0..1] values, one value per finger touching the control.

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.

In multi-touch environment, can be an array of [0..1] values, one value per finger touching the control.

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.

Use [CTRL + Click] to reset the input.

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.

The pressure value is not available on all touch screens.

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.

In touch and multi-touch environment, returns an array of the fingers movements See multi-touch

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.

Only on faders and knobs.

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.

version 7.0.250121

Edit All Pages