set_line_widthset_line_widthSetLineWidthSetLineWidth (Operator)

Name

set_line_widthset_line_widthSetLineWidthSetLineWidth — Define the line width for region contour output.

Signature

Description

set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth defines the line width (in pixel) in which a region contour is displayed (e.g. with disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_linedisp_lineDispLineDispLineDispLine, disp_polygondisp_polygonDispPolygonDispPolygonDispPolygon, etc.) The operator get_line_widthget_line_widthGetLineWidthGetLineWidthGetLineWidth 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_widthQueryLineWidthQueryLineWidthQueryLineWidth.

Attention

The line width is important if the output mode was set to 'margin' (see set_drawset_drawSetDrawSetDrawSetDraw). 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

Result

set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth 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_widthQueryLineWidthQueryLineWidthQueryLineWidth, get_line_widthget_line_widthGetLineWidthGetLineWidthGetLineWidth

Possible Successors

disp_regiondisp_regionDispRegionDispRegionDispRegion

See also

get_line_widthget_line_widthGetLineWidthGetLineWidthGetLineWidth, query_line_widthquery_line_widthQueryLineWidthQueryLineWidthQueryLineWidth, set_drawset_drawSetDrawSetDrawSetDraw, disp_regiondisp_regionDispRegionDispRegionDispRegion

Module

Foundation