disp_arrow

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

Displays arrows in a window.

disp_arrow displays one or several arrows in the output window. An arrow is described by the coordinates of the start (Row1,Column1) and the end (Row2,Column2). An arrowhead is displayed at the end of the arrow. The size of the arrowhead is specified by the parameter Size. If the arrow consists of just one point (start = end) nothing is displayed. The procedures used to control the display of regions (e.g. set_draw, set_color, set_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_color.

Attention

The start and the end of the arrows must fall within the window.

Parameters

`WindowHandle` (input_control)	window `->` integer
Window identifier.

`Row1` (input_control)	line.begin.y(-array) `->` real / integer
Row index of the start.
Default value: 10.0
Suggested values: 0.0, 64.0, 128.0, 256.0
Typical range of values: `0.0 <= Row1 <= 511.0` (lin)
Minimum increment: 1.0
Recommended increment: 1.0

`Column1` (input_control)	line.begin.x(-array) `->` real / integer
Column index of the start.
Default value: 10.0
Suggested values: 0.0, 64.0, 128.0, 256.0
Typical range of values: `0.0 <= Column1 <= 511.0` (lin)
Minimum increment: 1.0
Recommended increment: 1.0

`Row2` (input_control)	line.end.y(-array) `->` real / integer
Row index of the end.
Default value: 118.0
Suggested values: 0.0, 64.0, 128.0, 256.0
Typical range of values: `0.0 <= Row2 <= 511.0` (lin)
Minimum increment: 1.0
Recommended increment: 1.0

`Column2` (input_control)	line.end.x(-array) `->` real / integer
Column index of the end.
Default value: 118.0
Suggested values: 0.0, 64.0, 128.0, 256.0
Typical range of values: `0.0 <= Column2 <= 511.0` (lin)
Minimum increment: 1.0
Recommended increment: 1.0

`Size` (input_control)	number `->` real / integer
Size of the arrowhead.
Default value: 1.0
Suggested values: 1.0, 2.0, 3.0, 5.0
Typical range of values: `0.0 <= Size <= 20.0` (lin)
Minimum increment: 1.0
Recommended increment: 1.0
Restriction: `Size > 0.0`

Example

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

Result

disp_arrow returns 2 (H_MSG_TRUE).

Parallelization Information

disp_arrow is reentrant, local, and processed without parallelization.

Possible Predecessors

open_window, set_draw, set_color, set_colored, set_line_width, set_rgb, set_hsi

Alternatives

disp_line, gen_region_polygon, disp_region

Module

Foundation