set_drawT_set_drawSetDrawSetDraw (Operator)
Name
set_drawT_set_drawSetDrawSetDraw — Define the region fill mode.
Signature
Description
set_drawset_drawSetDrawSetDrawSetDraw 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_regionDispRegionDispRegionDispRegion, disp_circledisp_circleDispCircleDispCircleDispCircle,
disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1DispRectangle1, disp_rectangle2disp_rectangle2DispRectangle2DispRectangle2DispRectangle2,
disp_arrowdisp_arrowDispArrowDispArrowDispArrow etc. It is also used by operators with
gray value output for some gray value output modes (e.g. 'histogram',
see set_paintset_paintSetPaintSetPaintSetPaint). If the mode is 'margin', the contour can
be affected with set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth and set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyle.
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
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
ModeModeModeModemode (input_control) string → HTupleHTupleHtuple (string) (string) (HString) (char*)
Fill mode for region output.
Default value:
'fill'
"fill"
"fill"
"fill"
"fill"
List of values: 'fill'"fill""fill""fill""fill", 'margin'"margin""margin""margin""margin"
Result
set_drawset_drawSetDrawSetDrawSetDraw returns 2 (H_MSG_TRUE) if ModeModeModeModemode
is correct and the window is valid. Otherwise an exception is
raised.
Possible Predecessors
get_drawget_drawGetDrawGetDrawGetDraw
Possible Successors
disp_regiondisp_regionDispRegionDispRegionDispRegion
See also
get_drawget_drawGetDrawGetDrawGetDraw,
disp_regiondisp_regionDispRegionDispRegionDispRegion,
set_paintset_paintSetPaintSetPaintSetPaint,
disp_imagedisp_imageDispImageDispImageDispImage,
set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth,
set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyle
Module
Foundation