DH_MouseDetector

The DH_MouseDetector SynthEdit module provides a transparent rectangle on the GUI panel that detects a variety of mouse gestures.

Inputs: Auto Reset - Controls the click reset mode:

When TRUE, the "Clicked" or "Double Clicked" outputs are TRUE for an instant after a click or double click is detected, then are automatically reset to FALSE. This can be used to trigger events on a click or double click. The "Clicked" output sends only one TRUE trigger whether the click is double or single, i.e., it does not trigger on the 2nd click of a double click.

When FALSE, the "Clicked" or "Double Clicked" outputs are set to TRUE when a click or double click is detected, and remain TRUE until reset using the Reset input. The modifier key outputs "+Shift Key" and "+Ctrl Key" also remain TRUE until Reset when they accompany a click or double click

Reset - Resets the "Clicked", "Double Clicked", "+Shift Key" and "+Ctrl Key" outputs to FALSE, and the numeric outputs to 0.

Outputs: Mouse Over - TRUE when the mouse is hovered over the rectangle, FALSE otherwise. Clicked - TRUE when a left mouse button click has been detected. Reset behavior depends on the click reset mode as described above.

Double Clicked - TRUE when a left mouse button double click has been detected. Reset behavior depends on the click reset mode as described above.

Mouse Down - TRUE when the left mouse button is held down with the cursor inside of the rectangle. Remains TRUE until the button is released, even if the mouse cursor is moved outside of the rectangle. +Shift Key - TRUE if the Shift key was pressed at the time the left mouse button was pressed. If a left mouse button click is detected while the Shift key is pressed, reset behavior depends on the click reset mode as described above. If the mouse cursor is dragged while the Shift key is pressed, this pin is reset to FALSE when the button is released.

+Ctrl Key - TRUE if the Ctrl key was pressed at the time the left mouse button was pressed. If a left mouse button click is detected while the Ctrl key is pressed, reset behavior depends on the click reset mode as described above. If the mouse cursor is dragged while the Ctrl key is pressed, this pin is reset to FALSE when the button is released.

X Position - the mouse cursor's horizontal coordinate relative to the rectangle. The rectangle's left edge is 0, and its right edge is 1.0.

Y Position - the mouse cursor's vertical coordinate relative to the rectangle. The rectangle's bottom edge is 0, and its top edge is 1.0. X Drag Dist - The horizontal component of the distance the mouse cursor has been dragged. Distance is measured relative to the cursor position at the time the left mouse button was pressed. Left-to-right movements are positive, and right-to-left movements are negative. The width of the rectangle is 1.0. The drag distance remains available after the mouse button has been released.

Y Drag Dist - The vertical component of the distance the mouse cursor has been dragged. Distance is measured relative to the cursor position at the time the left mouse button was pressed. Upward movements are positive, and downward movements are negative. The height of the rectangle is 1.0. The drag distance remains available after the mouse button has been released.

Note It is not possible to detect right mouse button clicks, because SynthEdit captures these for its own use, and does not pass them to the module.