get_mbutton_sub_pixT_get_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixget_mbutton_sub_pix (Operator)

Name

get_mbutton_sub_pixT_get_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixget_mbutton_sub_pix — Wait until a mouse button is pressed and get the subpixel mouse position.

Signature

get_mbutton_sub_pix( : : WindowHandle : Row, Column, Button)

Herror T_get_mbutton_sub_pix(const Htuple WindowHandle, Htuple* Row, Htuple* Column, Htuple* Button)

void GetMbuttonSubPix(const HTuple& WindowHandle, HTuple* Row, HTuple* Column, HTuple* Button)

void HWindow::GetMbuttonSubPix(double* Row, double* Column, Hlong* Button) const

static void HOperatorSet.GetMbuttonSubPix(HTuple windowHandle, out HTuple row, out HTuple column, out HTuple button)

void HWindow.GetMbuttonSubPix(out double row, out double column, out int button)

def get_mbutton_sub_pix(window_handle: HHandle) -> Tuple[float, float, int]

Description

get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPixget_mbutton_sub_pix returns the subpixel 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 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 only pixel accurate image coordinates are required, you can use the operator get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbuttonget_mbutton.

Attention

get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPixget_mbutton_sub_pix only returns if a mouse button is pressed in the window.

Execution Information

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

RowRowRowRowrowrow (output_control)  point.y HTuplefloatHTupleHtuple (real) (double) (double) (double)

Row coordinate of the mouse cursor in the image coordinate system.

ColumnColumnColumnColumncolumncolumn (output_control)  point.x HTuplefloatHTupleHtuple (real) (double) (double) (double)

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_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPixget_mbutton_sub_pix returns the value TRUE.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window

Alternatives

get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbuttonget_mbutton, get_mpositionget_mpositionGetMpositionGetMpositionGetMpositionget_mposition, get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPixGetMpositionSubPixget_mposition_sub_pix

See also

open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window

Module

Foundation