Operator Reference

draw_rectangle2_modT_draw_rectangle2_modDrawRectangle2ModDrawRectangle2Moddraw_rectangle2_mod (Operator)

draw_rectangle2_modT_draw_rectangle2_modDrawRectangle2ModDrawRectangle2Moddraw_rectangle2_mod — Interactive drawing of any orientated rectangle.

Signature

Herror T_draw_rectangle2_mod(const Htuple WindowHandle, const Htuple RowIn, const Htuple ColumnIn, const Htuple PhiIn, const Htuple Length1In, const Htuple Length2In, Htuple* Row, Htuple* Column, Htuple* Phi, Htuple* Length1, Htuple* Length2)

void DrawRectangle2Mod(const HTuple& WindowHandle, const HTuple& RowIn, const HTuple& ColumnIn, const HTuple& PhiIn, const HTuple& Length1In, const HTuple& Length2In, HTuple* Row, HTuple* Column, HTuple* Phi, HTuple* Length1, HTuple* Length2)

void HWindow::DrawRectangle2Mod(double RowIn, double ColumnIn, double PhiIn, double Length1In, double Length2In, double* Row, double* Column, double* Phi, double* Length1, double* Length2) const

static void HOperatorSet.DrawRectangle2Mod(HTuple windowHandle, HTuple rowIn, HTuple columnIn, HTuple phiIn, HTuple length1In, HTuple length2In, out HTuple row, out HTuple column, out HTuple phi, out HTuple length1, out HTuple length2)

void HWindow.DrawRectangle2Mod(double rowIn, double columnIn, double phiIn, double length1In, double length2In, out double row, out double column, out double phi, out double length1, out double length2)

def draw_rectangle2_mod(window_handle: HHandle, row_in: float, column_in: float, phi_in: float, length_1in: float, length_2in: float) -> Tuple[float, float, float, float, float]

Description

draw_rectangle2_moddraw_rectangle2_modDrawRectangle2ModDrawRectangle2Moddraw_rectangle2_mod 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 are expected the parameters RowInRowInRowInrowInrow_in, ColumnInColumnInColumnIncolumnIncolumn_in,PhiInPhiInPhiInphiInphi_in,Length1InLength1InLength1Inlength1Inlength_1in,Length2InLength2InLength2Inlength2Inlength_2in. A click close to one side “grips” it to modify the rectangle's dimension in perpendicular direction (Length2Length2Length2length2length_2) to this side. You only can modify the orientation (PhiPhiPhiphiphi), if you grip a side perpendicular to the first half axis. After another mouse click in the middle of the created rectangle, you can move it. 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 HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

RowInRowInRowInrowInrow_in (input_control)  rectangle2.center.y HTuplefloatHTupleHtuple (real) (double) (double) (double)

Row index of the center.

ColumnInColumnInColumnIncolumnIncolumn_in (input_control)  rectangle2.center.x HTuplefloatHTupleHtuple (real) (double) (double) (double)

Column index of the center.

PhiInPhiInPhiInphiInphi_in (input_control)  rectangle2.angle.rad HTuplefloatHTupleHtuple (real) (double) (double) (double)

Orientation of the bigger half axis in radians.

Length1InLength1InLength1Inlength1Inlength_1in (input_control)  rectangle2.hwidth HTuplefloatHTupleHtuple (real) (double) (double) (double)

Bigger half axis.

Length2InLength2InLength2Inlength2Inlength_2in (input_control)  rectangle2.hheight HTuplefloatHTupleHtuple (real) (double) (double) (double)

Smaller half axis.

RowRowRowrowrow (output_control)  rectangle2.center.y HTuplefloatHTupleHtuple (real) (double) (double) (double)

Row index of the center.

ColumnColumnColumncolumncolumn (output_control)  rectangle2.center.x HTuplefloatHTupleHtuple (real) (double) (double) (double)

Column index of the center.

PhiPhiPhiphiphi (output_control)  rectangle2.angle.rad HTuplefloatHTupleHtuple (real) (double) (double) (double)

Orientation of the bigger half axis in radians.

Length1Length1Length1length1length_1 (output_control)  rectangle2.hwidth HTuplefloatHTupleHtuple (real) (double) (double) (double)

Bigger half axis.

Length2Length2Length2length2length_2 (output_control)  rectangle2.hheight HTuplefloatHTupleHtuple (real) (double) (double) (double)

Smaller half axis.

Result

draw_rectangle2_moddraw_rectangle2_modDrawRectangle2ModDrawRectangle2Moddraw_rectangle2_mod 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.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window

Possible Successors

reduce_domainreduce_domainReduceDomainReduceDomainreduce_domain, disp_regiondisp_regionDispRegionDispRegiondisp_region, set_coloredset_coloredSetColoredSetColoredset_colored, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width, set_drawset_drawSetDrawSetDrawset_draw, set_insertset_insertSetInsertSetInsertset_insert

Alternatives

draw_rectangle2draw_rectangle2DrawRectangle2DrawRectangle2draw_rectangle2, draw_rectangle1draw_rectangle1DrawRectangle1DrawRectangle1draw_rectangle1, draw_rectangle2draw_rectangle2DrawRectangle2DrawRectangle2draw_rectangle2, draw_regiondraw_regionDrawRegionDrawRegiondraw_region

See also

gen_rectangle2gen_rectangle2GenRectangle2GenRectangle2gen_rectangle2, draw_circledraw_circleDrawCircleDrawCircledraw_circle, draw_ellipsedraw_ellipseDrawEllipseDrawEllipsedraw_ellipse, set_insertset_insertSetInsertSetInsertset_insert

Module

Foundation