disp_rectangle1

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

Display of rectangles aligned to the coordinate axes.

disp_rectangle1 displays one or several rectangles in the output window. A rectangle is described by the upper left corner (Row1,Column1) and the lower right corner (Row2,Column2). If the given coordinates are not within the boundary of the window the rectangle is clipped accordingly. 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 rectangles. Several rectangles can be displayed with one call by using tuple parameters.

Parameters

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

`Row1` (input_control)	rectangle.origin.y(-array) `->` real / integer
Row index of the upper left corner.
Default value: 16
Suggested values: 0, 64, 128, 256, 511
Typical range of values: `0 <= Row1 <= 511` (lin)
Minimum increment: 1
Recommended increment: 10

`Column1` (input_control)	rectangle.origin.x(-array) `->` real / integer
Column index of the upper left corner.
Default value: 16
Suggested values: 0, 64, 128, 256, 511
Typical range of values: `0 <= Column1 <= 511` (lin)
Minimum increment: 1
Recommended increment: 10

`Row2` (input_control)	rectangle.corner.y(-array) `->` real / integer
Row index of the lower right corner.
Default value: 48
Suggested values: 0, 64, 128, 256, 511
Typical range of values: `0 <= Row2 <= 511` (lin)
Minimum increment: 1
Recommended increment: 10
Restriction: `Row2 >= Row1`

`Column2` (input_control)	rectangle.corner.x(-array) `->` real / integer
Column index of the lower right corner.
Default value: 80
Suggested values: 0, 64, 128, 256, 511
Typical range of values: `0 <= Column2 <= 511` (lin)
Minimum increment: 1
Recommended increment: 10
Restriction: `Column2 >= Column1`

Example

set_color(WindowHandle,'green') 
draw_region(MyRegion,WindowHandle) 
smallest_rectangle1(MyRegion,R1,C1,R2,C2) 
disp_rectangle1(WindowHandle,R1,C1,R2,C2).

Result

disp_rectangle1 returns 2 (H_MSG_TRUE).

Parallelization Information

disp_rectangle1 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_rectangle2, gen_rectangle1, disp_region, disp_line, set_shape

Module

System