attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindow (Operator)

Name

attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindow — Attach a background image to a HALCON window.

Signature

attach_background_to_window(Image : : WindowHandle : )

Description

This operator attaches the background image passed in ImageImageImageImageImageimage to a HALCON window defined in WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle. The input image is copied. Thus it can be freed safely.

The background image is instantly displayed in the HALCON window when calling attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindow. All HALCON objects that were previously displayed in the window will still be displayed when calling this operator. Thus the previous window content will not be overwritten.

The window contents are displayed in the following order: first the background image, then HALCON objects, and finally the drawing objects. Thus, the drawing object is displayed always on top. Note that the window will be redrawn for each user interaction within the window and each call of set_partset_partSetPartset_partSetPartSetPart. HALCON objects can be deleted from the window with clear_windowclear_windowClearWindowclear_windowClearWindowClearWindow.

The background image can be removed from the window with the operator detach_background_from_windowdetach_background_from_windowDetachBackgroundFromWindowdetach_background_from_windowDetachBackgroundFromWindowDetachBackgroundFromWindow.

Attention

Note that using any synchronous operator which actively probe the event queue, e.g., get_mbuttonget_mbuttonGetMbuttonget_mbuttonGetMbuttonGetMbutton or read_charread_charReadCharread_charReadCharReadChar, will conflict with the interaction with the drawing objects. In case the state of the cursor has to be read, please refer to the documentation of your framework of choice for an appropriate, non-invasive alternative.

Furthermore, the event based functionality should not be used together with the former blocking operators draw_rectangle1draw_rectangle1DrawRectangle1draw_rectangle1DrawRectangle1DrawRectangle1, draw_rectangle2draw_rectangle2DrawRectangle2draw_rectangle2DrawRectangle2DrawRectangle2, draw_regiondraw_regionDrawRegiondraw_regionDrawRegionDrawRegion, draw_xlddraw_xldDrawXlddraw_xldDrawXldDrawXld or draw_circledraw_circleDrawCircledraw_circleDrawCircleDrawCircle. They conflict with the event based functionality, since they actively fetch all events sent to the HALCON window.

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

ImageImageImageImageImageimage (input_object) singlechannelimage → object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Background image.

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (integer)

Window handle.

Result

If the window exists and the specified parameters are correct attach_background_to_windowattach_background_to_windowAttachBackgroundToWindowattach_background_to_windowAttachBackgroundToWindowAttachBackgroundToWindow returns 2 (H_MSG_TRUE). If necessary an exception is raised.