draw_xldT_draw_xldDrawXldDrawXlddraw_xld (Operator)

Name

draw_xldT_draw_xldDrawXldDrawXlddraw_xld — Interactive drawing of a contour.

Signature

draw_xld( : ContOut : WindowHandle, Rotate, Move, Scale, KeepRatio : )

Description

draw_xlddraw_xldDrawXldDrawXldDrawXlddraw_xld returns a contour, which has been created interactively by the user in the window.

Directly after calling draw_xlddraw_xldDrawXldDrawXldDrawXlddraw_xld you can add contour points by clicking with the left mouse button in the window at the desired positions. You delete the point appended last by pressing the Ctrl key. As soon as you add three contour points, 5 so-called pick points are displayed, one in the middle and 4 at the corners of the surrounding rectangle. By clicking on a pick point you can close the contour or open it again. If the contour is closed, the pick points are displayed in form of squares, otherwise they are shaped like a 'u'.

If the contour is closed you can

move contour points by clicking with the left mouse button on a point marked by a rectangle and keep the mouse button pressed while moving the mouse,
insert contour points by clicking with the left mouse button in the vicinity of a line and then move the mouse to the position where you want the new point to be placed, and
delete contour points by selecting the point which should be deleted with the left mouse button and then press the Ctrl key.

By pressing the Shift key, you can switch into the transformation mode. In this mode you can rotate, move, and scale the contour as a whole, but only if you set the parameters RotateRotateRotateRotaterotaterotate, MoveMoveMoveMovemovemove, and ScaleScaleScaleScalescalescale, respectively, to 'true'"true""true""true""true""true". Instead of the pick points, 3 symbols are displayed with the contour: a cross in the middle and an arrow to the right if RotateRotateRotateRotaterotaterotate is set to 'true'"true""true""true""true""true", and a double-headed arrow to the upper right if ScaleScaleScaleScalescalescale is set to 'true'"true""true""true""true""true".

You can

move the contour by clicking the left mouse button on the cross in the center and then dragging it to the new position,
rotate it by clicking with the left mouse button on the arrow and then dragging it, till the contour has the right direction, and
scale it by dragging the double arrow. To keep the ratio the parameter KeepRatioKeepRatioKeepRatioKeepRatiokeepRatiokeep_ratio has to be set to 'true'"true""true""true""true""true".

Pressing the right mouse button terminates the procedure. On macOS draw_xlddraw_xldDrawXldDrawXldDrawXlddraw_xld can also be terminated by pressing the escape key.

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

ContOutContOutContOutContOutcontOutcont_out (output_object) xld_cont → object

Modified contour.

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

RotateRotateRotateRotaterotaterotate (input_control) string → (string)

Enable rotation?

Default value: 'true' "true" "true" "true" "true" "true"

List of values: 'false'"false""false""false""false""false", 'true'"true""true""true""true""true"

MoveMoveMoveMovemovemove (input_control) string → (string)

Enable moving?

Default value: 'true' "true" "true" "true" "true" "true"

List of values: 'false'"false""false""false""false""false", 'true'"true""true""true""true""true"

ScaleScaleScaleScalescalescale (input_control) string → (string)

Enable scaling?

Default value: 'true' "true" "true" "true" "true" "true"

List of values: 'false'"false""false""false""false""false", 'true'"true""true""true""true""true"

KeepRatioKeepRatioKeepRatioKeepRatiokeepRatiokeep_ratio (input_control) string → (string)

Keep ratio while scaling?

Default value: 'true' "true" "true" "true" "true" "true"

List of values: 'false'"false""false""false""false""false", 'true'"true""true""true""true""true"

Result

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