send_mouse_down_eventT_send_mouse_down_eventSendMouseDownEventSendMouseDownEvent (Operator)

Name

send_mouse_down_eventT_send_mouse_down_eventSendMouseDownEventSendMouseDownEvent — Send an event to a window buffer signaling a mouse down event.

Signature

send_mouse_down_event( : : WindowHandle, Row, Column, Button : Processed)

Description

send_mouse_down_eventsend_mouse_down_eventSendMouseDownEventSendMouseDownEventSendMouseDownEvent sends an event at the position (RowRowRowRowrow, ColumnColumnColumnColumncolumn) to the buffer window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle, signaling that the mouse button encoded by ButtonButtonButtonButtonbutton has been pressed. Please refer to get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbutton to see how to encode ButtonButtonButtonButtonbutton.

The purpose of this operator is to manipulate drawing objects in a buffer window. If the coordinates RowRowRowRowrow and ColumnColumnColumnColumncolumn are pointing on a drawing object, it is activated and can be moved or changed by sending more events with the send_mouse_down_eventsend_mouse_down_eventSendMouseDownEventSendMouseDownEventSendMouseDownEvent operator. To simplify the interaction with the drawing object, the coordinates RowRowRowRowrow and ColumnColumnColumnColumncolumn are given in the image coordinate system. To convert window coordinates into image coordinates, the operator convert_coordinates_window_to_imageconvert_coordinates_window_to_imageConvertCoordinatesWindowToImageConvertCoordinatesWindowToImageConvertCoordinatesWindowToImage can be used.

If the event could be processed, send_mouse_down_eventsend_mouse_down_eventSendMouseDownEventSendMouseDownEventSendMouseDownEvent returns 'true'"true""true""true""true" in ProcessedProcessedProcessedProcessedprocessed. If no action for the event could be determined (e.g., because there is no drawing object below the mouse position), 'false'"false""false""false""false" is returned in ProcessedProcessedProcessedProcessedprocessed. In this case the caller may determine an action for the event.

The operators send_mouse_down_eventsend_mouse_down_eventSendMouseDownEventSendMouseDownEventSendMouseDownEvent, send_mouse_up_eventsend_mouse_up_eventSendMouseUpEventSendMouseUpEventSendMouseUpEvent, send_mouse_drag_eventsend_mouse_drag_eventSendMouseDragEventSendMouseDragEventSendMouseDragEvent and send_mouse_double_click_eventsend_mouse_double_click_eventSendMouseDoubleClickEventSendMouseDoubleClickEventSendMouseDoubleClickEvent are the only means to manipulate drawing objects in buffer windows.

Attention

send_mouse_down_eventsend_mouse_down_eventSendMouseDownEventSendMouseDownEventSendMouseDownEvent depends on the library libcanvas, which might not be available on embedded systems.

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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (handle)

Window handle of the buffer window.

RowRowRowRowrow (input_control) point.y → (integer / real)

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

ColumnColumnColumnColumncolumn (input_control) point.x → (integer / real)

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

ButtonButtonButtonButtonbutton (input_control) integer → (integer)

Mouse button(s) pressed.

ProcessedProcessedProcessedProcessedprocessed (output_control) string → (string)

'true', if HALCON processed the event.

Result

send_mouse_down_eventsend_mouse_down_eventSendMouseDownEventSendMouseDownEventSendMouseDownEvent returns the value 2 (H_MSG_TRUE) if the window handle WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle corresponds to a window of valid type, and the event is properly encoded. Otherwise, an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow

Module

Foundation

Operators