clear_rectangleClearRectangleClearRectangleclear_rectangleT_clear_rectangle

HALCON ScriptCpp++.NETPythonC

Short description

clear_rectangleClearRectangleClearRectangleclear_rectangleT_clear_rectangle — Delete a rectangle on the output window.

Warning

clear_rectangleClearRectangle is obsolete and is only provided for reasons of backward compatibility.

Signature

clear_rectangle( window WindowHandle, rectangle.origin.y Row1, rectangle.origin.x Column1, rectangle.corner.y Row2, rectangle.corner.x Column2 )void ClearRectangle( const HTuple& WindowHandle, const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2 )static void HOperatorSet.ClearRectangle( HTuple windowHandle, HTuple row1, HTuple column1, HTuple row2, HTuple column2 )def clear_rectangle( window_handle: HHandle, row_1: MaybeSequence[int], column_1: MaybeSequence[int], row_2: MaybeSequence[int], column_2: MaybeSequence[int] ) -> None

Herror T_clear_rectangle( const Htuple WindowHandle, const Htuple Row1, const Htuple Column1, const Htuple Row2, const Htuple Column2 )

void HWindow::ClearRectangle( const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2 ) const

void HWindow::ClearRectangle( Hlong Row1, Hlong Column1, Hlong Row2, Hlong Column2 ) const

void HWindow.ClearRectangle( HTuple row1, HTuple column1, HTuple row2, HTuple column2 )

void HWindow.ClearRectangle( int row1, int column1, int row2, int column2 )

Description

clear_rectangleClearRectangle deletes all entries in the rectangle which is defined through the upper left corner (Row1row1row_1,Column1column1column_1) and the lower right corner (Row2row2row_2,Column2column2column_2). Deletion means that the specified rectangle is set to the background color (see open_windowOpenWindow).

If you want to delete more than one rectangle, you may pass several rectangles, i.e., the parameters Row1row1row_1, Column1column1column_1, Row2row2row_2 and Column2column2column_2 are tuples.

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) rectangle.origin.y(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Line index of upper left corner.

Default: 1010
Value range: 0 ≤ Row1 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 1

Column1column1column_1 (input_control) rectangle.origin.x(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Column index of upper left corner.

Default: 1010
Value range: 0 ≤ Column1 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 1

Row2row2row_2 (input_control) rectangle.corner.y(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Row index of lower right corner.

Default: 118118
Value range: 0 ≤ Row2 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 1
Restriction: Row2 > Row1

Column2column2column_2 (input_control) rectangle.corner.x(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Column index of lower right corner.

Default: 118118
Value range: 0 ≤ Column2 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 1
Restriction: Column2 >= Column1

Example

(HDevelop)

* Erase a rectangle in the output window interactively:
draw_rectangle1(WindowHandle,L1,C1,L2,C2)

(C)

/* Erase a rectangle in the output window interactively: */
draw_rectangle1(WindowHandle,&L1,&C1,&L2,&C2)\;

Result

If an output window exists and the specified parameters are correct clear_rectangleClearRectangle returns 2 (H_MSG_TRUE). If necessary an exception is raised.

Combinations with other operators

Combinations

Possible predecessors

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

Alternatives

clear_windowClearWindow, disp_rectangle1DispRectangle1

See also

open_windowOpenWindow

Module

Foundation