Documentation Center

Viz Plug-ins User Guide

Version 5.1 | Published December 12, 2023 ©

DataMouseAction

images/download/attachments/95401949/plugins_datamouseaction-icon.png
The DataMouseAction plug-in receives mouse events from the DataMouseSensor plug-in and runs Viz actions accordingly. This plug-in is not registered to a DataField. It is attached to a container and it is triggered by the mouse actions when the cursor is within the container area in the render window.

Note: This plug-in is located in: Plugins -> Container plug-ins -> Data

Information: DataPool plug-ins only work properly on a single channel on the same machine.

Note: DataPool commands cannot be used.

DataMouseAction Properties

  • Click To Activate: Determines whether the user has to select the container in order to activate the actions. If set to On, it is selected when the first action that is executed (the Mouse Down action).

  • Mouse Threshold: Determines the minimum number of pixels that the mouse arrow has to be moved before a movement is recognized.

  • Mouse Down: Calls a Viz action as soon as a mouse button is pressed on top of the container the plug-in is attached to.

  • Mouse Up: Calls a Viz action when a mouse button is released and the container the plug-in is attached to is the previously selected container.

  • Drag Left: Calls a Viz action when the selected container is dragged (moved) to the left and the movement is larger then the Mouse Threshold value.

  • Drag Right: Calls a Viz action when the selected container is dragged (moved) to the right and the movement is larger then the Mouse Threshold value.

  • Stop Horizontal Drag: Calls a Viz action when a horizontal mouse dragging movement stops or the mouse button that started all the drag movement stops.

  • Drag Down: Calls a Viz action when the selected container is dragged (moved) down and the movement is larger then the Mouse Threshold value.

  • Drag Up: Calls a Viz action when the selected container is dragged (moved) up and the movement is larger then the Mouse Threshold value.

  • Stop Vertical Drag: Calls a Viz action when a vertical mouse dragging movement stops or the mouse button that started all the drag movements stop.