disp_rectangle1T_disp_rectangle1DispRectangle1DispRectangle1disp_rectangle1 (Operator)
Name
disp_rectangle1T_disp_rectangle1DispRectangle1DispRectangle1disp_rectangle1 — Display of rectangles aligned to the coordinate axes.
Signature
void DispRectangle1(const HTuple& WindowHandle, const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2)
void HWindow::DispRectangle1(const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2) const
void HWindow::DispRectangle1(double Row1, double Column1, double Row2, double Column2) const
static void HOperatorSet.DispRectangle1(HTuple windowHandle, HTuple row1, HTuple column1, HTuple row2, HTuple column2)
void HWindow.DispRectangle1(HTuple row1, HTuple column1, HTuple row2, HTuple column2)
void HWindow.DispRectangle1(double row1, double column1, double row2, double column2)
def disp_rectangle1(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]]) -> None
Description
disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1disp_rectangle1 displays one or several rectangles in the
output window. A rectangle is described by the upper left corner
(Row1Row1Row1row1row_1,Column1Column1Column1column1column_1) and the lower right corner
(Row2Row2Row2row2row_2,Column2Column2Column2column2column_2). If the given coordinates are not
within the boundary of the window the rectangle is clipped accordingly.
The operators used to control the display of regions
(e.g., set_colorset_colorSetColorSetColorset_color, set_grayset_graySetGraySetGrayset_gray, set_drawset_drawSetDrawSetDrawset_draw,
set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width) can also be used with rectangles. Several
rectangles can be displayed with one call by using tuple parameters.
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) rectangle.origin.y(-array) → HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Row index of the upper left corner.
Default:
16
Suggested values:
0, 64, 128, 256, 511
Value range:
0
≤
Row1
Row1
Row1
row1
row_1
≤
511 (lin)
Minimum increment:
1
Recommended increment:
10
Column1Column1Column1column1column_1 (input_control) rectangle.origin.x(-array) → HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Column index of the upper left corner.
Default:
16
Suggested values:
0, 64, 128, 256, 511
Value range:
0
≤
Column1
Column1
Column1
column1
column_1
≤
511 (lin)
Minimum increment:
1
Recommended increment:
10
Row2Row2Row2row2row_2 (input_control) rectangle.corner.y(-array) → HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Row index of the lower right corner.
Default:
48
Suggested values:
0, 64, 128, 256, 511
Value range:
0
≤
Row2
Row2
Row2
row2
row_2
≤
511 (lin)
Minimum increment:
1
Recommended increment:
10
Restriction:
Row2 >= Row1
Column2Column2Column2column2column_2 (input_control) rectangle.corner.x(-array) → HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Column index of the lower right corner.
Default:
80
Suggested values:
0, 64, 128, 256, 511
Value range:
0
≤
Column2
Column2
Column2
column2
column_2
≤
511 (lin)
Minimum increment:
1
Recommended increment:
10
Restriction:
Column2 >= Column1
Example (HDevelop)
set_color(WindowHandle,'green')
draw_region(MyRegion,WindowHandle)
smallest_rectangle1(MyRegion,R1,C1,R2,C2)
disp_rectangle1(WindowHandle,R1,C1,R2,C2)
Result
disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1disp_rectangle1 returns 2 (
H_MSG_TRUE)
.
Possible Predecessors
open_windowopen_windowOpenWindowOpenWindowopen_window,
set_rgbset_rgbSetRgbSetRgbset_rgb,
set_lutset_lutSetLutSetLutset_lut,
set_hsiset_hsiSetHsiSetHsiset_hsi,
set_drawset_drawSetDrawSetDrawset_draw,
set_colorset_colorSetColorSetColorset_color,
set_coloredset_coloredSetColoredSetColoredset_colored,
set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width
Alternatives
disp_rectangle2disp_rectangle2DispRectangle2DispRectangle2disp_rectangle2,
gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1gen_rectangle1,
disp_regiondisp_regionDispRegionDispRegiondisp_region,
disp_linedisp_lineDispLineDispLinedisp_line,
set_shapeset_shapeSetShapeSetShapeset_shape
See also
open_windowopen_windowOpenWindowOpenWindowopen_window,
set_colorset_colorSetColorSetColorset_color,
set_drawset_drawSetDrawSetDrawset_draw,
set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width
Module
Foundation