Skip to content

get_line_widthGetLineWidthGetLineWidthget_line_widthT_get_line_width🔗

Short description🔗

get_line_widthGetLineWidthGetLineWidthget_line_widthT_get_line_width — Get the current line width for contour display.

Signature🔗

get_line_width( window WindowHandle, out real Width )void GetLineWidth( const HTuple& WindowHandle, HTuple* Width )static void HOperatorSet.GetLineWidth( HTuple windowHandle, out HTuple width )def get_line_width( window_handle: HHandle ) -> float

Herror T_get_line_width( const Htuple WindowHandle, Htuple* Width )

double HWindow::GetLineWidth( ) const

double HWindow.GetLineWidth( )

Description🔗

get_line_widthGetLineWidth returns the line width for region display in the window. It is used by operators like disp_regionDispRegion, disp_lineDispLine, disp_polygonDispPolygon, etc. Widthwidthwidth is set with the operator set_line_widthSetLineWidth. Widthwidthwidth is only important for displaying the contour of objects.

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 (output_control) real → (real)HTuple (double)HTuple (double)floatHtuple (double)

Current line width for contour display.

Result🔗

get_line_widthGetLineWidth returns 2 (H_MSG_TRUE) if the window is valid. Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible successors

set_line_widthSetLineWidth, set_line_styleSetLineStyle, disp_regionDispRegion

See also

set_line_widthSetLineWidth, disp_regionDispRegion

Module🔗

Foundation