Skip to content

disp_arrowDispArrowDispArrowdisp_arrowT_disp_arrow🔗

Short description🔗

disp_arrowDispArrowDispArrowdisp_arrowT_disp_arrow — Displays arrows in a window.

Signature🔗

disp_arrow( window WindowHandle, line.begin.y Row1, line.begin.x Column1, line.end.y Row2, line.end.x Column2, number Size )void DispArrow( const HTuple& WindowHandle, const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2, const HTuple& Size )static void HOperatorSet.DispArrow( HTuple windowHandle, HTuple row1, HTuple column1, HTuple row2, HTuple column2, HTuple 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

Herror T_disp_arrow( 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

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 )

Description🔗

disp_arrowDispArrow displays one or several arrows in the output window. An arrow is described by the coordinates of the start (Row1row1row_1,Column1column1column_1) and the end (Row2row2row_2,Column2column2column_2). An arrowhead is displayed at the end of the arrow. The size of the arrowhead is specified by the parameter Sizesizesize. 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_drawSetDraw, set_colorSetColor, set_line_widthSetLineWidth) 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_colorSetColor.

Attention🔗

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

Row index of the start.

Default: 10.010.0
Suggested values: 0.0, 64.0, 128.0, 256.00.0, 64.0, 128.0, 256.0
Value range: 0.0 ≤ Row1 ≤ 511.0 (lin)
Minimum increment: 1.0
Recommended increment: 1.0

Column1column1column_1 (input_control) line.begin.x(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Column index of the start.

Default: 10.010.0
Suggested values: 0.0, 64.0, 128.0, 256.00.0, 64.0, 128.0, 256.0
Value range: 0.0 ≤ Column1 ≤ 511.0 (lin)
Minimum increment: 1.0
Recommended increment: 1.0

Row2row2row_2 (input_control) line.end.y(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Row index of the end.

Default: 118.0118.0
Suggested values: 0.0, 64.0, 128.0, 256.00.0, 64.0, 128.0, 256.0
Value range: 0.0 ≤ Row2 ≤ 511.0 (lin)
Minimum increment: 1.0
Recommended increment: 1.0

Column2column2column_2 (input_control) line.end.x(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Column index of the end.

Default: 118.0118.0
Suggested values: 0.0, 64.0, 128.0, 256.00.0, 64.0, 128.0, 256.0
Value range: 0.0 ≤ Column2 ≤ 511.0 (lin)
Minimum increment: 1.0
Recommended increment: 1.0

Sizesizesize (input_control) number → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)Union[int, float]Htuple (double / Hlong)

Size of the arrowhead.

Default: 1.01.0
Suggested values: 1.0, 2.0, 3.0, 5.01.0, 2.0, 3.0, 5.0
Value range: 0.0 ≤ 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_arrowDispArrow returns 2 (H_MSG_TRUE).

Combinations with other operators🔗

Combinations

Possible predecessors

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

Alternatives

disp_lineDispLine, gen_region_polygonGenRegionPolygon, disp_regionDispRegion

See also

open_windowOpenWindow, set_colorSetColor, set_drawSetDraw, set_line_widthSetLineWidth

Module🔗

Foundation