draw_lineT_draw_lineDrawLineDrawLinedraw_line (Operator)
Name
draw_lineT_draw_lineDrawLineDrawLinedraw_line — Draw a line.
Signature
def draw_line(window_handle: HHandle) -> Tuple[float, float, float, float]
Description
draw_linedraw_lineDrawLineDrawLineDrawLinedraw_line returns the parameter for a line, which has been
created interactively by the user in the window.
To create a line you have to press the left mouse button determining a start point
of the line. While keeping the button pressed you may “drag” the line in
any direction. After another mouse click in the middle of the created line
you can move it.
If you click on one end point of the created line, you may move this point.
Pressing the right mouse button terminates the procedure. On macOS
draw_linedraw_lineDrawLineDrawLineDrawLinedraw_line can also be terminated by pressing the escape key.
After terminating the procedure the line 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
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
Row1Row1Row1Row1row1row_1 (output_control) line.begin.y → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Row index of the first point of the line.
Column1Column1Column1Column1column1column_1 (output_control) line.begin.x → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Column index of the first point of the line.
Row2Row2Row2Row2row2row_2 (output_control) line.end.y → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Row index of the second point of the line.
Column2Column2Column2Column2column2column_2 (output_control) line.end.x → HTuplefloatHTupleHtuple (real) (double) (double) (double)
Column index of the second point of the line.
Example (HDevelop)
draw_line(WindowHandle,Row1,Column1,Row2,Column2)
gen_contour_polygon_xld (Line, [Row1,Row2], [Column1,Column2])
dev_display (Line)
Example (C)
draw_line(WindowHandle,&Row1,&Column1,&Row2,&Column2);
disp_line(WindowHandle,Row1,Column1,Row2,Column2);
Example (HDevelop)
draw_line(WindowHandle,Row1,Column1,Row2,Column2)
gen_contour_polygon_xld (Line, [Row1,Row2], [Column1,Column2])
dev_display (Line)
Example (HDevelop)
draw_line(WindowHandle,Row1,Column1,Row2,Column2)
gen_contour_polygon_xld (Line, [Row1,Row2], [Column1,Column2])
dev_display (Line)
Example (HDevelop)
draw_line(WindowHandle,Row1,Column1,Row2,Column2)
gen_contour_polygon_xld (Line, [Row1,Row2], [Column1,Column2])
dev_display (Line)
Result
draw_linedraw_lineDrawLineDrawLineDrawLinedraw_line returns 2 (H_MSG_TRUE), if the window is valid and the
needed drawing mode (see set_insertset_insertSetInsertSetInsertSetInsertset_insert) is available.
If necessary, an exception is raised.
Possible Predecessors
open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window
Possible Successors
reduce_domainreduce_domainReduceDomainReduceDomainReduceDomainreduce_domain,
disp_linedisp_lineDispLineDispLineDispLinedisp_line,
set_coloredset_coloredSetColoredSetColoredSetColoredset_colored,
set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidthset_line_width,
set_drawset_drawSetDrawSetDrawSetDrawset_draw,
set_insertset_insertSetInsertSetInsertSetInsertset_insert
See also
draw_line_moddraw_line_modDrawLineModDrawLineModDrawLineModdraw_line_mod,
gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1GenRectangle1gen_rectangle1,
draw_circledraw_circleDrawCircleDrawCircleDrawCircledraw_circle,
draw_ellipsedraw_ellipseDrawEllipseDrawEllipseDrawEllipsedraw_ellipse,
set_insertset_insertSetInsertSetInsertSetInsertset_insert
Module
Foundation