disp_line (Operator)

Name

disp_line — Draws lines in a window.

Synopsis

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

Description

disp_line displays one or several lines in the output window. A line is described by the coordinates of the start (Row1,Column1) and the coordinates of the end (Row2,Column2). The procedures used to control the display of regions (e.g. set_color, set_gray, set_draw, set_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_color.

Attention

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

Parameters

WindowHandle (input_control)	window → (integer)
Window identifier.

Row1 (input_control)	line.begin.y(-array) → (real)
Row index of the start.
Default value: 32.0
Suggested values: 0.0, 64.0, 128.0, 256.0, 511.0
Typical range of values: 0 ≤ Row1 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Column1 (input_control)	line.begin.x(-array) → (real)
Column index of the start.
Default value: 32.0
Suggested values: 0.0, 64.0, 128.0, 256.0, 511.0
Typical range of values: 0 ≤ Column1 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Row2 (input_control)	line.end.y(-array) → (real)
Row index of end.
Default value: 64.0
Suggested values: 0.0, 64.0, 128.0, 256.0, 511.0
Typical range of values: 0 ≤ Row2 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Column2 (input_control)	line.end.x(-array) → (real)
Column index of end.
Default value: 64.0
Suggested values: 0.0, 64.0, 128.0, 256.0, 511.0
Typical range of values: 0 ≤ Column2 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Example

* 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_line returns 2 (H_MSG_TRUE).

Parallelization Information

disp_line is reentrant, local, and processed without parallelization.

Possible Predecessors

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

Alternatives

disp_arrow, disp_rectangle1, disp_rectangle2, disp_region, gen_region_polygon, gen_region_points

See also

open_window, open_textwindow, set_color, set_rgb, set_hsi, set_insert, set_line_width

Module

Foundation