set_line_widthT_set_line_widthSetLineWidthSetLineWidthset_line_width (Operator)
Name
set_line_widthT_set_line_widthSetLineWidthSetLineWidthset_line_width — Define the line width for region contour output.
Signature
Description
set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidthset_line_width defines the line width (in pixel) in
which a region contour is displayed (e.g. with
disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region, disp_linedisp_lineDispLineDispLineDispLinedisp_line,
disp_polygondisp_polygonDispPolygonDispPolygonDispPolygondisp_polygon, etc.) The operator
get_line_widthget_line_widthGetLineWidthGetLineWidthGetLineWidthget_line_width returns the current value for the
window. Some output devices may not allow to change the contour
width. If it is possible for the current device, it can be queried with
query_line_widthquery_line_widthQueryLineWidthQueryLineWidthQueryLineWidthquery_line_width.
Attention
The line width is important if the output mode was set to 'margin'
(see set_drawset_drawSetDrawSetDrawSetDrawset_draw). If the line width is greater than one,
regions may not always be displayed correctly.
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
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
WidthWidthWidthWidthwidthwidth (input_control) real → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Line width for region output in contour mode.
Default value: 1.0
Restriction: Width >= 1.0 && Width <= 2000.0
Result
set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidthset_line_width returns 2 (H_MSG_TRUE) if the parameter is
correct and the window is valid. Otherwise an exception is raised.
Possible Predecessors
query_line_widthquery_line_widthQueryLineWidthQueryLineWidthQueryLineWidthquery_line_width,
get_line_widthget_line_widthGetLineWidthGetLineWidthGetLineWidthget_line_width
Possible Successors
disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region
See also
get_line_widthget_line_widthGetLineWidthGetLineWidthGetLineWidthget_line_width,
query_line_widthquery_line_widthQueryLineWidthQueryLineWidthQueryLineWidthquery_line_width,
set_drawset_drawSetDrawSetDrawSetDrawset_draw,
disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region
Module
Foundation