draw_rectangle2T_draw_rectangle2DrawRectangle2DrawRectangle2draw_rectangle2 (Operator)

Name

draw_rectangle2T_draw_rectangle2DrawRectangle2DrawRectangle2draw_rectangle2 — Interactive drawing of any orientated rectangle.

Signature

draw_rectangle2( : : WindowHandle : Row, Column, Phi, Length1, Length2)

Description

draw_rectangle2draw_rectangle2DrawRectangle2DrawRectangle2draw_rectangle2 returns the parameter for any orientated rectangle, which has been created interactively by the user in the window.

The created rectangle is described by its center, its two half axes and the angle between the first half axis and the horizontal coordinate axis.

To create a rectangle you have to press the left mouse button for the center of the rectangle. While keeping the button pressed you may dimension the length (Length1Length1Length1length1length_1) and the orientation (PhiPhiPhiphiphi) of the first half axis. In doing so a temporary default length for the second half axis is assumed, which may be modified afterwards on demand. After another mouse click in the middle of the created rectangle, you can move it. A click close to one side “grips” it to modify the rectangle's dimension in perpendicular direction to this side. You only can modify the orientation, if you grip a side perpendicular to the first half axis. Pressing the right mouse button terminates the procedure.

After terminating the procedure the rectangle is not visible in the window any longer.

Attention

If used in a buffer window, mouse events have to be supplied by the application, while the draw operator must be run in another thread.

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 → (handle)

Window handle.

RowRowRowrowrow (output_control) rectangle2.center.y → (real)

Row index of the center.

ColumnColumnColumncolumncolumn (output_control) rectangle2.center.x → (real)

Column index of the center.

PhiPhiPhiphiphi (output_control) rectangle2.angle.rad → (real)

Orientation of the bigger half axis in radians.

Length1Length1Length1length1length_1 (output_control) rectangle2.hwidth → (real)

Bigger half axis.

Length2Length2Length2length2length_2 (output_control) rectangle2.hheight → (real)

Smaller half axis.

Result

draw_rectangle2draw_rectangle2DrawRectangle2DrawRectangle2draw_rectangle2 returns 2 ( H_MSG_TRUE) , if the window is valid and the needed drawing mode (see set_insertset_insertSetInsertSetInsertset_insert) is available. If necessary, an exception is raised.