Operator Reference

HALCON Operator Reference / Graphics / Drawing
ClassesClasses | | Operators

draw_xldT_draw_xldDrawXldDrawXlddraw_xld (Operator)

draw_xldT_draw_xldDrawXldDrawXlddraw_xld — Interactive drawing of a contour.

Signature

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

Herror T_draw_xld(Hobject* ContOut, const Htuple WindowHandle, const Htuple Rotate, const Htuple Move, const Htuple Scale, const Htuple KeepRatio)

void DrawXld(HObject* ContOut, const HTuple& WindowHandle, const HTuple& Rotate, const HTuple& Move, const HTuple& Scale, const HTuple& KeepRatio)

void HXLDCont::DrawXld(const HWindow& WindowHandle, const HString& Rotate, const HString& Move, const HString& Scale, const HString& KeepRatio)

void HXLDCont::DrawXld(const HWindow& WindowHandle, const char* Rotate, const char* Move, const char* Scale, const char* KeepRatio)

void HXLDCont::DrawXld(const HWindow& WindowHandle, const wchar_t* Rotate, const wchar_t* Move, const wchar_t* Scale, const wchar_t* KeepRatio)   ( Windows only)

HXLDCont HWindow::DrawXld(const HString& Rotate, const HString& Move, const HString& Scale, const HString& KeepRatio) const

HXLDCont HWindow::DrawXld(const char* Rotate, const char* Move, const char* Scale, const char* KeepRatio) const

HXLDCont HWindow::DrawXld(const wchar_t* Rotate, const wchar_t* Move, const wchar_t* Scale, const wchar_t* KeepRatio) const   ( Windows only)

static void HOperatorSet.DrawXld(out HObject contOut, HTuple windowHandle, HTuple rotate, HTuple move, HTuple scale, HTuple keepRatio)

void HXLDCont.DrawXld(HWindow windowHandle, string rotate, string move, string scale, string keepRatio)

HXLDCont HWindow.DrawXld(string rotate, string move, string scale, string keepRatio)

def draw_xld(window_handle: HHandle, rotate: str, move: str, scale: str, keep_ratio: str) -> HObject

Description

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

Directly after calling draw_xlddraw_xldDrawXldDrawXlddraw_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 RotateRotateRotaterotaterotate, MoveMoveMovemovemove, and ScaleScaleScalescalescale, respectively, to '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 RotateRotateRotaterotaterotate is set to 'true'"true""true""true""true", and a double-headed arrow to the upper right if ScaleScaleScalescalescale is set to '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 KeepRatioKeepRatioKeepRatiokeepRatiokeep_ratio has to be set to 'true'"true""true""true""true".

Pressing the right mouse button terminates the procedure.

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

ContOutContOutContOutcontOutcont_out (output_object)  xld_cont → objectHXLDContHObjectHObjectHobject *

Modified contour.

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

RotateRotateRotaterotaterotate (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Enable rotation?

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

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

MoveMoveMovemovemove (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Enable moving?

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

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

ScaleScaleScalescalescale (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Enable scaling?

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

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

KeepRatioKeepRatioKeepRatiokeepRatiokeep_ratio (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Keep ratio while scaling?

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

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

Result

draw_xlddraw_xldDrawXldDrawXlddraw_xld 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

ClassesClasses | | Operators