Operator Reference

HALCON Operator Reference / Graphics / Output
ClassesClasses | | Operators

disp_lineT_disp_lineDispLineDispLinedisp_line (Operator)

disp_lineT_disp_lineDispLineDispLinedisp_line — Draws lines in a window.

Signature

disp_line( : : WindowHandle, Row1, Column1, Row2, Column2 : )

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

void DispLine(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

static void HOperatorSet.DispLine(HTuple windowHandle, HTuple row1, HTuple column1, HTuple row2, HTuple column2)

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

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

def disp_line(window_handle: HHandle, row_1: MaybeSequence[float], column_1: MaybeSequence[float], row_2: MaybeSequence[float], column_2: MaybeSequence[float]) -> None

Description

disp_linedisp_lineDispLineDispLinedisp_line displays one or several lines in the output window. A line is described by the coordinates of the start (Row1Row1Row1row1row_1,Column1Column1Column1column1column_1) and the coordinates of the end (Row2Row2Row2row2row_2,Column2Column2Column2column2column_2). The operators used to control the display of regions (e.g., set_colorset_colorSetColorSetColorset_color, set_grayset_graySetGraySetGrayset_gray, set_drawset_drawSetDrawSetDrawset_draw, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width) 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_colorset_colorSetColorSetColorset_color.

Attention

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

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

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

Row1Row1Row1row1row_1 (input_control)  line.begin.y(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)

Row index of the start.

Default: 32.0

Suggested values: 0.0, 64.0, 128.0, 256.0, 511.0

Value range: 0 ≤ Row1 Row1 Row1 row1 row_1 ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 10

Column1Column1Column1column1column_1 (input_control)  line.begin.x(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)

Column index of the start.

Default: 32.0

Suggested values: 0.0, 64.0, 128.0, 256.0, 511.0

Value range: 0 ≤ Column1 Column1 Column1 column1 column_1 ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 10

Row2Row2Row2row2row_2 (input_control)  line.end.y(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)

Row index of end.

Default: 64.0

Suggested values: 0.0, 64.0, 128.0, 256.0, 511.0

Value range: 0 ≤ Row2 Row2 Row2 row2 row_2 ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 10

Column2Column2Column2column2column_2 (input_control)  line.end.x(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)

Column index of end.

Default: 64.0

Suggested values: 0.0, 64.0, 128.0, 256.0, 511.0

Value range: 0 ≤ Column2 Column2 Column2 column2 column_2 ≤ 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_linedisp_lineDispLineDispLinedisp_line returns 2 ( H_MSG_TRUE) .

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, set_rgbset_rgbSetRgbSetRgbset_rgb, set_lutset_lutSetLutSetLutset_lut, set_hsiset_hsiSetHsiSetHsiset_hsi, set_drawset_drawSetDrawSetDrawset_draw, set_colorset_colorSetColorSetColorset_color, set_coloredset_coloredSetColoredSetColoredset_colored, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width

Alternatives

disp_arrowdisp_arrowDispArrowDispArrowdisp_arrow, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1disp_rectangle1, disp_rectangle2disp_rectangle2DispRectangle2DispRectangle2disp_rectangle2, disp_regiondisp_regionDispRegionDispRegiondisp_region, gen_region_polygongen_region_polygonGenRegionPolygonGenRegionPolygongen_region_polygon, gen_region_pointsgen_region_pointsGenRegionPointsGenRegionPointsgen_region_points

See also

open_windowopen_windowOpenWindowOpenWindowopen_window, set_colorset_colorSetColorSetColorset_color, set_rgbset_rgbSetRgbSetRgbset_rgb, set_hsiset_hsiSetHsiSetHsiset_hsi, set_insertset_insertSetInsertSetInsertset_insert, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width

Module

Foundation

ClassesClasses | | Operators