Operator Reference

HALCON Operator Reference / Graphics / Output
ClassesClasses | | Operators

disp_arrowT_disp_arrowDispArrowDispArrowdisp_arrow (Operator)

disp_arrowT_disp_arrowDispArrowDispArrowdisp_arrow — Displays arrows in a window.

Signature

disp_arrow( : : WindowHandle, Row1, Column1, Row2, Column2, Size : )

Herror T_disp_arrow(const Htuple WindowHandle, const Htuple Row1, const Htuple Column1, const Htuple Row2, const Htuple Column2, const Htuple Size)

void DispArrow(const HTuple& WindowHandle, const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2, const HTuple& Size)

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

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

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

void HWindow.DispArrow(HTuple row1, HTuple column1, HTuple row2, HTuple column2, HTuple size)

void HWindow.DispArrow(double row1, double column1, double row2, double column2, double size)

def disp_arrow(window_handle: HHandle, row_1: MaybeSequence[Union[int, float]], column_1: MaybeSequence[Union[int, float]], row_2: MaybeSequence[Union[int, float]], column_2: MaybeSequence[Union[int, float]], size: Union[int, float]) -> None

Description

disp_arrowdisp_arrowDispArrowDispArrowdisp_arrow displays one or several arrows in the output window. An arrow is described by the coordinates of the start (Row1Row1Row1row1row_1,Column1Column1Column1column1column_1) and the end (Row2Row2Row2row2row_2,Column2Column2Column2column2column_2). An arrowhead is displayed at the end of the arrow. The size of the arrowhead is specified by the parameter SizeSizeSizesizesize. If the arrow consists of just one point (start = end) nothing is displayed. The operators used to control the display of regions (e.g., set_drawset_drawSetDrawSetDrawset_draw, set_colorset_colorSetColorSetColorset_color, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width) can also be used with arrows. Several arrows can be displayed with one call by using tuple parameters. For the use of colors with several arcs, see set_colorset_colorSetColorSetColorset_color.

Attention

The start and the end of the arrows must fall within 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[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Row index of the start.

Default: 10.0

Suggested values: 0.0, 64.0, 128.0, 256.0

Value range: 0.0 ≤ Row1 Row1 Row1 row1 row_1 ≤ 511.0 (lin)

Minimum increment: 1.0

Recommended increment: 1.0

Column1Column1Column1column1column_1 (input_control)  line.begin.x(-array) → HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Column index of the start.

Default: 10.0

Suggested values: 0.0, 64.0, 128.0, 256.0

Value range: 0.0 ≤ Column1 Column1 Column1 column1 column_1 ≤ 511.0 (lin)

Minimum increment: 1.0

Recommended increment: 1.0

Row2Row2Row2row2row_2 (input_control)  line.end.y(-array) → HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Row index of the end.

Default: 118.0

Suggested values: 0.0, 64.0, 128.0, 256.0

Value range: 0.0 ≤ Row2 Row2 Row2 row2 row_2 ≤ 511.0 (lin)

Minimum increment: 1.0

Recommended increment: 1.0

Column2Column2Column2column2column_2 (input_control)  line.end.x(-array) → HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Column index of the end.

Default: 118.0

Suggested values: 0.0, 64.0, 128.0, 256.0

Value range: 0.0 ≤ Column2 Column2 Column2 column2 column_2 ≤ 511.0 (lin)

Minimum increment: 1.0

Recommended increment: 1.0

SizeSizeSizesizesize (input_control)  number → HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Size of the arrowhead.

Default: 1.0

Suggested values: 1.0, 2.0, 3.0, 5.0

Value range: 0.0 ≤ Size Size Size size size ≤ 20.0 (lin)

Minimum increment: 1.0

Recommended increment: 1.0

Restriction: Size > 0.0

Example (HDevelop)

set_color(WindowHandle,['red','green'])
disp_arrow(WindowHandle,[10,10],[10,10],[118,110],[118,118],1.0)

Result

disp_arrowdisp_arrowDispArrowDispArrowdisp_arrow returns 2 ( H_MSG_TRUE) .

Possible Predecessors

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

Alternatives

disp_linedisp_lineDispLineDispLinedisp_line, gen_region_polygongen_region_polygonGenRegionPolygonGenRegionPolygongen_region_polygon, disp_regiondisp_regionDispRegionDispRegiondisp_region

See also

open_windowopen_windowOpenWindowOpenWindowopen_window, set_colorset_colorSetColorSetColorset_color, set_drawset_drawSetDrawSetDrawset_draw, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width

Module

Foundation

ClassesClasses | | Operators