set_drawSetDrawSetDrawset_drawT_set_draw

HALCON ScriptCpp++.NETPythonC

Short description

set_drawSetDrawSetDrawset_drawT_set_draw — Define the region fill mode.

Signature

set_draw( window WindowHandle, string Mode )void SetDraw( const HTuple& WindowHandle, const HTuple& Mode )static void HOperatorSet.SetDraw( HTuple windowHandle, HTuple mode )def set_draw( window_handle: HHandle, mode: str ) -> None

Herror T_set_draw( 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)

void HWindow.SetDraw( string mode )

Description

set_drawSetDraw defines the region fill mode. If Modemodemode is set to ‘fill’, output regions are filled, if set to ‘margin’, only contours are displayed. Setting Modemodemode only affects the valid window. It is used by operators with region output like disp_regionDispRegion, disp_circleDispCircle, disp_rectangle1DispRectangle1, disp_rectangle2DispRectangle2, disp_arrowDispArrow 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_widthSetLineWidth and set_line_styleSetLineStyle.

Attention

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

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

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

Window handle.

Modemodemode (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Fill mode for region output.

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

Result

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

Combinations with other operators

Combinations

Possible predecessors

get_drawGetDraw

Possible successors

disp_regionDispRegion

See also

get_drawGetDraw, disp_regionDispRegion, set_paintSetPaint, disp_imageDispImage, set_line_widthSetLineWidth, set_line_styleSetLineStyle

Module

Foundation