Skip to content

set_line_widthSetLineWidthSetLineWidthset_line_widthT_set_line_width🔗

Short description🔗

set_line_widthSetLineWidthSetLineWidthset_line_widthT_set_line_width — Define the line width for region contour output.

Signature🔗

set_line_width( window WindowHandle, real Width )void SetLineWidth( const HTuple& WindowHandle, const HTuple& Width )static void HOperatorSet.SetLineWidth( HTuple windowHandle, HTuple width )def set_line_width( window_handle: HHandle, width: float ) -> None

Herror T_set_line_width( const Htuple WindowHandle, const Htuple Width )

void HWindow::SetLineWidth( double Width ) const

void HWindow.SetLineWidth( double width )

Description🔗

set_line_widthSetLineWidth defines the line width (in pixel) in which a region contour is displayed (e.g., with disp_regionDispRegion, disp_lineDispLine, disp_polygonDispPolygon, etc.) The operator get_line_widthGetLineWidth 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_widthQueryLineWidth.

Attention🔗

The line width is important if the output mode was set to ‘margin’ (see set_drawSetDraw). If the line width is greater than one, regions may not always be displayed correctly.

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.

Widthwidthwidth (input_control) real → (real)HTuple (double)HTuple (double)floatHtuple (double)

Line width for region output in contour mode.

Default: 1.01.0
Restriction: (Width >= 1.0) && (Width <= 2000.0)

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

query_line_widthQueryLineWidth, get_line_widthGetLineWidth

Possible successors

disp_regionDispRegion

See also

get_line_widthGetLineWidth, query_line_widthQueryLineWidth, set_drawSetDraw, disp_regionDispRegion

Module🔗

Foundation