set_line_widthset_line_widthset_line_widthSetLineWidthSetLineWidth (Operator)

Name

set_line_widthset_line_widthset_line_widthSetLineWidthSetLineWidth — Define the line width for region contour output.

Signature

Description

set_line_widthset_line_widthset_line_widthSetLineWidthSetLineWidth defines the line width (in pixel) in which a region contour is displayed (e.g. with disp_regiondisp_regiondisp_regionDispRegionDispRegion, disp_linedisp_linedisp_lineDispLineDispLine, disp_polygondisp_polygondisp_polygonDispPolygonDispPolygon, etc.) The operator get_line_widthget_line_widthget_line_widthGetLineWidthGetLineWidth 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_widthquery_line_widthQueryLineWidthQueryLineWidth.

Attention

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

Parallelization

• 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_widthset_line_widthSetLineWidthSetLineWidth 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_widthquery_line_widthQueryLineWidthQueryLineWidth, get_line_widthget_line_widthget_line_widthGetLineWidthGetLineWidth

Possible Successors

disp_regiondisp_regiondisp_regionDispRegionDispRegion

See also

get_line_widthget_line_widthget_line_widthGetLineWidthGetLineWidth, query_line_widthquery_line_widthquery_line_widthQueryLineWidthQueryLineWidth, set_drawset_drawset_drawSetDrawSetDraw, disp_regiondisp_regiondisp_regionDispRegionDispRegion

Module

Foundation