get_mpositionget_mpositionget_mpositionGetMpositionGetMposition (Operator)

Name

get_mpositionget_mpositionget_mpositionGetMpositionGetMposition — Query the mouse position.

Signature

Description

get_mpositionget_mpositionget_mpositionGetMpositionGetMposition returns the pixel accurate image coordinates of the mouse pointer in the output window and the mouse button pressed. These values are returned regardless of the state of the mouse buttons (pressed or not pressed). If more than one button is pressed, the sum of the individual buttons' values is returned. The possible values for ButtonButtonButtonButtonbutton are:

0:

No button,

1:

Left button,

2:

Middle button,

4:

Right button.

The origin of the coordinate system is located in the left upper corner of the window. For graphics windows the coordinates RowRowRowRowrow and ColumnColumnColumnColumncolumn are expressed with consideration of the current image part (see set_partset_partset_partSetPartSetPart). For text windows the coordinates of the upper left corner are (0,0), while the coordinates of the lower right corner are (window height-1,window width-1) (see open_textwindowopen_textwindowopen_textwindowOpenTextwindowOpenTextwindow).

If subpixel accurate image coordinates are required, you can use the operator get_mposition_sub_pixget_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPix.

Attention

get_mpositionget_mpositionget_mpositionGetMpositionGetMposition fails (returns FAIL) if the mouse pointer is not located within the window. In this case, no values are returned.

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
• Processed without parallelization.

Parameters

Result

get_mpositionget_mpositionget_mpositionGetMpositionGetMposition returns the value 2 (H_MSG_TRUE). If the mouse pointer is not located within the window, 5 (H_MSG_FAIL) is returned.

Possible Predecessors

open_windowopen_windowopen_windowOpenWindowOpenWindow, open_textwindowopen_textwindowopen_textwindowOpenTextwindowOpenTextwindow

Alternatives

get_mbuttonget_mbuttonget_mbuttonGetMbuttonGetMbutton, get_mposition_sub_pixget_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPix, get_mbutton_sub_pixget_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPix

See also

open_windowopen_windowopen_windowOpenWindowOpenWindow, open_textwindowopen_textwindowopen_textwindowOpenTextwindowOpenTextwindow

Module

Foundation