disp_lineDispLineDispLinedisp_lineT_disp_line

HALCON ScriptCpp++.NETPythonC

Short description

disp_lineDispLineDispLinedisp_lineT_disp_line — Draws lines in a window.

Signature

disp_line( window WindowHandle, line.begin.y Row1, line.begin.x Column1, line.end.y Row2, line.end.x Column2 )void DispLine( const HTuple& WindowHandle, const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2 )static void HOperatorSet.DispLine( HTuple windowHandle, HTuple row1, HTuple column1, HTuple row2, HTuple column2 )def disp_line( window_handle: HHandle, row_1: MaybeSequence[float], column_1: MaybeSequence[float], row_2: MaybeSequence[float], column_2: MaybeSequence[float] ) -> None

Herror T_disp_line( const Htuple WindowHandle, const Htuple Row1, const Htuple Column1, const Htuple Row2, const Htuple Column2 )

void HWindow::DispLine( const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2 ) const

void HWindow::DispLine( double Row1, double Column1, double Row2, double Column2 ) const

void HWindow.DispLine( HTuple row1, HTuple column1, HTuple row2, HTuple column2 )

void HWindow.DispLine( double row1, double column1, double row2, double column2 )

Description

disp_lineDispLine displays one or several lines in the output window. A line is described by the coordinates of the start (Row1row1row_1,Column1column1column_1) and the coordinates of the end (Row2row2row_2,Column2column2column_2). The operators used to control the display of regions (e.g., set_colorSetColor, set_graySetGray, set_drawSetDraw, set_line_widthSetLineWidth) can also be used with lines. Several lines can be displayed with one call by using tuple parameters. For the use of colors with several lines, see set_colorSetColor.

Attention

The starting points and the ending points of the lines must be in the window.

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.

Row1row1row_1 (input_control) line.begin.y(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Row index of the start.

Default: 32.032.0
Suggested values: 0.0, 64.0, 128.0, 256.0, 511.00.0, 64.0, 128.0, 256.0, 511.0
Value range: 0 ≤ Row1 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Column1column1column_1 (input_control) line.begin.x(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Column index of the start.

Default: 32.032.0
Suggested values: 0.0, 64.0, 128.0, 256.0, 511.00.0, 64.0, 128.0, 256.0, 511.0
Value range: 0 ≤ Column1 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Row2row2row_2 (input_control) line.end.y(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Row index of end.

Default: 64.064.0
Suggested values: 0.0, 64.0, 128.0, 256.0, 511.00.0, 64.0, 128.0, 256.0, 511.0
Value range: 0 ≤ Row2 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Column2column2column_2 (input_control) line.end.x(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Column index of end.

Default: 64.064.0
Suggested values: 0.0, 64.0, 128.0, 256.0, 511.00.0, 64.0, 128.0, 256.0, 511.0
Value range: 0 ≤ Column2 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Example

(HDevelop)

* Display contour of a rectangle
disp_line(WindowHandle,Row1,Column1,Row1,Column2)
disp_line(WindowHandle,Row1,Column2,Row2,Column2)
disp_line(WindowHandle,Row2,Column2,Row2,Column1)
disp_line(WindowHandle,Row2,Column1,Row1,Column1)

Result

disp_lineDispLine returns 2 (H_MSG_TRUE).

Combinations with other operators

Combinations

Possible predecessors

open_windowOpenWindow, set_rgbSetRgb, set_lutSetLut, set_hsiSetHsi, set_drawSetDraw, set_colorSetColor, set_coloredSetColored, set_line_widthSetLineWidth

Alternatives

disp_arrowDispArrow, disp_rectangle1DispRectangle1, disp_rectangle2DispRectangle2, disp_regionDispRegion, gen_region_polygonGenRegionPolygon, gen_region_pointsGenRegionPoints

See also

open_windowOpenWindow, set_colorSetColor, set_rgbSetRgb, set_hsiSetHsi, set_line_widthSetLineWidth

Module

Foundation