pyux.set_on_left_dragstart_handler

Sets the on_left_dragstart handler for mouse dragging in the graphics area.

pyux.set_on_left_dragstart_handler(function)

Parameters

	Type	Description
function	function	A lua function that is invoked when dragging is started. nil will remove the handler.

Callback

The parameters to the handler function are as follows:

function on_click_handler(info)

	Type	Description
info	{...}	A table containing the following key-value pairs:
info.coos_vp	{u, v}	Normalized viewport coordinates of the mouse cursor. Can be nil.
info.ctrl_key	boolean	Status of the virtual CTRL key.
info.shift_key	boolean	Status of the virtual SHIFT key.
info.alt_key	boolean	Status of the virtual ALT key.

Note:

This handler is specific to the current modal environment / dialog and can only be set within a dialog.

In order to retreive on_left_dragmove and on_left_dragend events, the on_left_dragstart handler has to be set.

Version Support:

Minimum PYTHA Version: V26

See also

Control Gallery, set_on_left_dragmove_handler, set_on_left_dragend_handler, set_on_left_click_handler, set_on_right_click_handler, show_cursor_crosshair