set_iconSetIconSetIconset_iconT_set_icon

HALCON ScriptCpp++.NETPythonC

Short description

set_iconSetIconSetIconset_iconT_set_icon — Icon definition for region output.

Signature

set_icon( region Icon, window WindowHandle )void SetIcon( const HObject& Icon, const HTuple& WindowHandle )static void HOperatorSet.SetIcon( HObject icon, HTuple windowHandle )def set_icon( icon: HObject, window_handle: HHandle ) -> None

Herror T_set_icon( const Hobject Icon, const Htuple WindowHandle )

void HRegion::SetIcon( const HWindow& WindowHandle ) const

void HWindow::SetIcon( const HRegion& Icon ) const

void HRegion.SetIcon( HWindow windowHandle )

void HWindow.SetIcon( HRegion icon )

Description

set_iconSetIcon defines an icon for region output (disp_regionDispRegion). It is displayed in the regions center of gravity. The use of this icon is activated with set_shapeSetShape.

Execution information

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

Iconiconicon (input_object) region → objectHObjectHRegionHObjectHobject

Icon for center of gravity.

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Example

(C)

/* draw a region and an icon */
T_draw_region(&Region,WindowHandle)\;
T_draw_region(&Icon,WindowHandle)\;
set_icon(Icon)\;
create_tuple_s(&icon,"icon")\;
T_set_shape(WindowHandle,icon)\;
destroy_tuple(icon)\;
T_disp_region(Region,WindowHandle)\;

Result

set_iconSetIcon returns 2 (H_MSG_TRUE), if exactly one region is supplied. Otherwise an exception is raised.

Combinations with other operators

Combinations

Possible predecessors

gen_circleGenCircle, gen_ellipseGenEllipse, gen_rectangle1GenRectangle1, gen_rectangle2GenRectangle2, draw_regionDrawRegion

Possible successors

set_shapeSetShape, disp_regionDispRegion

Module

Foundation