Operator Reference

HALCON Operator Reference / Graphics / Object
ClassesClasses | | Operators

set_drawing_object_callbackT_set_drawing_object_callbackSetDrawingObjectCallbackSetDrawingObjectCallbackset_drawing_object_callback (Operator)

set_drawing_object_callbackT_set_drawing_object_callbackSetDrawingObjectCallbackSetDrawingObjectCallbackset_drawing_object_callback — Add a callback function to a drawing object.

Signature

set_drawing_object_callback( : : DrawHandle, DrawObjectEvent, CallbackFunction : )

Herror T_set_drawing_object_callback(const Htuple DrawHandle, const Htuple DrawObjectEvent, const Htuple CallbackFunction)

void SetDrawingObjectCallback(const HTuple& DrawHandle, const HTuple& DrawObjectEvent, const HTuple& CallbackFunction)

void HDrawingObject::SetDrawingObjectCallback(const HTuple& DrawObjectEvent, const HTuple& CallbackFunction) const

void HDrawingObject::SetDrawingObjectCallback(const HString& DrawObjectEvent, void* CallbackFunction) const

void HDrawingObject::SetDrawingObjectCallback(const char* DrawObjectEvent, void* CallbackFunction) const

void HDrawingObject::SetDrawingObjectCallback(const wchar_t* DrawObjectEvent, void* CallbackFunction) const   ( Windows only)

static void HOperatorSet.SetDrawingObjectCallback(HTuple drawHandle, HTuple drawObjectEvent, HTuple callbackFunction)

void HDrawingObject.SetDrawingObjectCallback(HTuple drawObjectEvent, HTuple callbackFunction)

void HDrawingObject.SetDrawingObjectCallback(string drawObjectEvent, IntPtr callbackFunction)

def set_drawing_object_callback(draw_handle: HHandle, draw_object_event: MaybeSequence[str], callback_function: MaybeSequence[int]) -> None

Description

set_drawing_object_callbackset_drawing_object_callbackSetDrawingObjectCallbackSetDrawingObjectCallbackset_drawing_object_callback adds the callback function CallbackFunctionCallbackFunctionCallbackFunctioncallbackFunctioncallback_function to be called on the event(s) defined in DrawObjectEventDrawObjectEventDrawObjectEventdrawObjectEventdraw_object_event to the drawing object DrawHandleDrawHandleDrawHandledrawHandledraw_handle. An event is an action, i.e., a user interaction with the mouse or a call to a HALCON operator, e.g., attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window), that changes the current state of a given drawing object. The operator set_drawing_object_callbackset_drawing_object_callbackSetDrawingObjectCallbackSetDrawingObjectCallbackset_drawing_object_callback allows to define how to react to those events.

The following predefined events are available:

'on_attach'"on_attach""on_attach""on_attach""on_attach"

The corresponding callback will be called right after the object has been attached to the HALCON window and is ready for interaction.

'on_detach'"on_detach""on_detach""on_detach""on_detach"

The corresponding callback will be called right after the object has been detached from the window and is no longer available for interaction.

'on_drag'"on_drag""on_drag""on_drag""on_drag"

The corresponding callback will be called right after the object has been dragged with mouse interaction.

'on_resize'"on_resize""on_resize""on_resize""on_resize"

The corresponding callback will be called right after the object has been resized with mouse interaction.

'on_select'"on_select""on_select""on_select""on_select"

The corresponding callback will be called right after the object has been selected with mouse interaction.

It is possible to specify a particular callback for each desired event. Then the input parameters DrawObjectEventDrawObjectEventDrawObjectEventdrawObjectEventdraw_object_event and CallbackFunctionCallbackFunctionCallbackFunctioncallbackFunctioncallback_function must have the same length. It is also possible to use the same callback for different events. Then DrawObjectEventDrawObjectEventDrawObjectEventdrawObjectEventdraw_object_event has an arbitrary length and CallbackFunctionCallbackFunctionCallbackFunctioncallbackFunctioncallback_function contains one single value.

The callback is an integer of long type containing a pointer to a C function with the following signature:

Herror HDrawObjectCallback(Hphandle DrawHandle, Hphandle WindowHandle, char* type)

On Windows systems, the __stdcall naming convention is used:

Herror __stdcall HDrawObjectCallback(Hphandle DrawHandle, Hphandle WindowHandle, char* type)

The first parameter of the callback function contains the handle to the draw object that generated the event, the second one contains the handle of the window where the interaction took place. Finally, the third parameter indicates which event occurred.

Attention

No graphical operator should be called within the callback, like for example disp_objdisp_objDispObjDispObjdisp_obj, for otherwise a deadlock may occur.

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

DrawHandleDrawHandleDrawHandledrawHandledraw_handle (input_control)  drawing_object → HDrawingObject, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the drawing object.

DrawObjectEventDrawObjectEventDrawObjectEventdrawObjectEventdraw_object_event (input_control)  string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Events to be captured.

Suggested values: 'on_resize'"on_resize""on_resize""on_resize""on_resize", 'on_drag'"on_drag""on_drag""on_drag""on_drag", 'on_attach'"on_attach""on_attach""on_attach""on_attach", 'on_detach'"on_detach""on_detach""on_detach""on_detach", 'on_select'"on_select""on_select""on_select""on_select"

CallbackFunctionCallbackFunctionCallbackFunctioncallbackFunctioncallback_function (input_control)  pointer(-array) → HTupleMaybeSequence[int]HTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Callback functions.

Result

set_drawing_object_callbackset_drawing_object_callbackSetDrawingObjectCallbackSetDrawingObjectCallbackset_drawing_object_callback returns 2 ( H_MSG_TRUE) , if DrawHandleDrawHandleDrawHandledrawHandledraw_handle is valid. Otherwise an exception is raised.

Possible Predecessors

attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window

Possible Successors

close_windowclose_windowCloseWindowCloseWindowclose_window, clear_drawing_objectclear_drawing_objectClearDrawingObjectClearDrawingObjectclear_drawing_object, detach_drawing_object_from_windowdetach_drawing_object_from_windowDetachDrawingObjectFromWindowDetachDrawingObjectFromWindowdetach_drawing_object_from_window, get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicget_drawing_object_iconic, get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params

See also

create_drawing_object_rectangle1create_drawing_object_rectangle1CreateDrawingObjectRectangle1CreateDrawingObjectRectangle1create_drawing_object_rectangle1, attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window, detach_drawing_object_from_windowdetach_drawing_object_from_windowDetachDrawingObjectFromWindowDetachDrawingObjectFromWindowdetach_drawing_object_from_window

Module

Foundation

ClassesClasses | | Operators