Operator Reference

HALCON Operator Reference / Graphics / Parameters
ClassesClasses | | Operators

set_iconT_set_iconSetIconSetIconset_icon (Operator)

set_iconT_set_iconSetIconSetIconset_icon — Icon definition for region output.

Signature

set_icon(Icon : : WindowHandle : )

Herror T_set_icon(const Hobject Icon, const Htuple WindowHandle)

void SetIcon(const HObject& Icon, const HTuple& WindowHandle)

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

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

static void HOperatorSet.SetIcon(HObject icon, HTuple windowHandle)

void HRegion.SetIcon(HWindow windowHandle)

void HWindow.SetIcon(HRegion icon)

def set_icon(icon: HObject, window_handle: HHandle) -> None

Description

set_iconset_iconSetIconSetIconset_icon defines an icon for region output (disp_regiondisp_regionDispRegionDispRegiondisp_region). It is displayed in the regions center of gravity. The use of this icon is activated with set_shapeset_shapeSetShapeSetShapeset_shape.

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

IconIconIconiconicon (input_object)  region → objectHRegionHObjectHObjectHobject

Icon for center of gravity.

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (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_iconset_iconSetIconSetIconset_icon returns 2 ( H_MSG_TRUE) , if exactly one region is supplied. Otherwise an exception is raised.

Possible Predecessors

gen_circlegen_circleGenCircleGenCirclegen_circle, gen_ellipsegen_ellipseGenEllipseGenEllipsegen_ellipse, gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1gen_rectangle1, gen_rectangle2gen_rectangle2GenRectangle2GenRectangle2gen_rectangle2, draw_regiondraw_regionDrawRegionDrawRegiondraw_region

Possible Successors

set_shapeset_shapeSetShapeSetShapeset_shape, disp_regiondisp_regionDispRegionDispRegiondisp_region

Module

Foundation

ClassesClasses | | Operators