get_mbuttonT_get_mbuttonGetMbuttonGetMbuttonget_mbutton (Operator)
Name
get_mbuttonT_get_mbuttonGetMbuttonGetMbuttonget_mbutton — Wait until a mouse button is pressed.
Signature
Description
get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbuttonget_mbutton returns the pixel accurate image coordinates of the
mouse pointer in the output window and the mouse button pressed.
In addition the state of the modifier keys is returned. The following
values are assigned to the individual buttons and keys:
- 1:
Left button,
- 2:
Middle button,
- 4:
Right button,
- 8:
Shift key,
- 16:
Ctrl key,
- 32:
Alt key.
The sum of the values for all pressed buttons/keys is returned in
ButtonButtonButtonButtonbuttonbutton.
The operator waits until a mouse button is pressed in the output
window. For graphics windows the coordinates RowRowRowRowrowrow and
ColumnColumnColumnColumncolumncolumn are expressed with consideration of the current
image part (see set_partset_partSetPartSetPartSetPartset_part).
If subpixel accurate image coordinates are required, you can use the
operator get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPixget_mbutton_sub_pix.
Attention
get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbuttonget_mbutton only returns if a mouse button is pressed in
the window.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
RowRowRowRowrowrow (output_control) point.y → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Row coordinate of the mouse cursor in the image coordinate
system.
ColumnColumnColumnColumncolumncolumn (output_control) point.x → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Column coordinate of the mouse cursor in the image coordinate
system.
ButtonButtonButtonButtonbuttonbutton (output_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Mouse button(s) pressed.
Result
get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbuttonget_mbutton returns the value TRUE.
Possible Predecessors
open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window
Alternatives
get_mpositionget_mpositionGetMpositionGetMpositionGetMpositionget_mposition,
get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPixget_mbutton_sub_pix,
get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPixGetMpositionSubPixget_mposition_sub_pix
See also
open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window
Module
Foundation