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_widthSetLineWidthSetLineWidthset_line_width defines the line width (in pixel) in which a region contour is displayed (e.g., with disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_linedisp_lineDispLineDispLinedisp_line, disp_polygondisp_polygonDispPolygonDispPolygondisp_polygon, etc.) The operator get_line_widthget_line_widthGetLineWidthGetLineWidthget_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_widthQueryLineWidthQueryLineWidthquery_line_width.

Attention

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

Result

set_line_widthset_line_widthSetLineWidthSetLineWidthset_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_widthQueryLineWidthQueryLineWidthquery_line_width, get_line_widthget_line_widthGetLineWidthGetLineWidthget_line_width

Possible Successors

disp_regiondisp_regionDispRegionDispRegiondisp_region

See also

get_line_widthget_line_widthGetLineWidthGetLineWidthget_line_width, query_line_widthquery_line_widthQueryLineWidthQueryLineWidthquery_line_width, set_drawset_drawSetDrawSetDrawset_draw, disp_regiondisp_regionDispRegionDispRegiondisp_region

Module

Foundation