Operator Reference

HALCON Operator Reference / Graphics / Parameters
ClassesClasses | | Operators

get_iconT_get_iconGetIconGetIconget_icon (Operator)

get_iconT_get_iconGetIconGetIconget_icon — Query the icon for region output

Signature

get_icon( : Icon : WindowHandle : )

Herror T_get_icon(Hobject* Icon, const Htuple WindowHandle)

void GetIcon(HObject* Icon, const HTuple& WindowHandle)

void HRegion::GetIcon(const HWindow& WindowHandle)

HRegion HWindow::GetIcon() const

static void HOperatorSet.GetIcon(out HObject icon, HTuple windowHandle)

void HRegion.GetIcon(HWindow windowHandle)

HRegion HWindow.GetIcon()

def get_icon(window_handle: HHandle) -> HObject

Description

get_iconget_iconGetIconGetIconget_icon queries the icon that was set with set_iconset_iconSetIconSetIconset_icon.

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 (output_object)  region → objectHRegionHObjectHObjectHobject *

Icon for the regions center of gravity.

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

Example (C)

/* draw a region and an icon.  */
/* set it and get it again.    */
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);
get_icon(&OldIcon);
T_disp_region(OldIcon,WindowHandle);

Result

get_iconget_iconGetIconGetIconget_icon always returns 2 ( H_MSG_TRUE) .

Possible Predecessors

set_iconset_iconSetIconSetIconset_icon

Possible Successors

disp_regiondisp_regionDispRegionDispRegiondisp_region

Module

Foundation

ClassesClasses | | Operators