Operator Reference

HALCON Operator Reference / Graphics / Parameters
ClassesClasses | | Operators

set_drawT_set_drawSetDrawSetDrawset_draw (Operator)

set_drawT_set_drawSetDrawSetDrawset_draw — Define the region fill mode.

Signature

set_draw( : : WindowHandle, Mode : )

Herror T_set_draw(const Htuple WindowHandle, const Htuple Mode)

void SetDraw(const HTuple& WindowHandle, const HTuple& Mode)

void HWindow::SetDraw(const HString& Mode) const

void HWindow::SetDraw(const char* Mode) const

void HWindow::SetDraw(const wchar_t* Mode) const   ( Windows only)

static void HOperatorSet.SetDraw(HTuple windowHandle, HTuple mode)

void HWindow.SetDraw(string mode)

def set_draw(window_handle: HHandle, mode: str) -> None

Description

set_drawset_drawSetDrawSetDrawset_draw defines the region fill mode. If ModeModeModemodemode is set to 'fill', output regions are filled, if set to 'margin', only contours are displayed. Setting ModeModeModemodemode only affects the valid window. It is used by operators with region output like disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_circledisp_circleDispCircleDispCircledisp_circle, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1disp_rectangle1, disp_rectangle2disp_rectangle2DispRectangle2DispRectangle2disp_rectangle2, disp_arrowdisp_arrowDispArrowDispArrowdisp_arrow etc. It is also used by operators with gray value output for some gray value output modes. If the mode is 'margin', the contour can be affected with set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width and set_line_styleset_line_styleSetLineStyleSetLineStyleset_line_style.

Attention

If the output mode is 'margin' and the line width is more than one, objects may not be displayed.

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

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

Window handle.

ModeModeModemodemode (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Fill mode for region output.

Default: 'fill' "fill" "fill" "fill" "fill"

List of values: 'fill'"fill""fill""fill""fill", 'margin'"margin""margin""margin""margin"

Result

set_drawset_drawSetDrawSetDrawset_draw returns 2 ( H_MSG_TRUE) if ModeModeModemodemode is correct and the window is valid. Otherwise an exception is raised.

Possible Predecessors

get_drawget_drawGetDrawGetDrawget_draw

Possible Successors

disp_regiondisp_regionDispRegionDispRegiondisp_region

See also

get_drawget_drawGetDrawGetDrawget_draw, disp_regiondisp_regionDispRegionDispRegiondisp_region, set_paintset_paintSetPaintSetPaintset_paint, disp_imagedisp_imageDispImageDispImagedisp_image, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width, set_line_styleset_line_styleSetLineStyleSetLineStyleset_line_style

Module

Foundation

ClassesClasses | | Operators