Operator Reference

set_drawing_object_xldT_set_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldset_drawing_object_xld (Operator)

set_drawing_object_xldT_set_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldset_drawing_object_xld — Set the contour of an interactive draw XLD.

Signature

set_drawing_object_xld(Contour : : DrawID : )

Herror T_set_drawing_object_xld(const Hobject Contour, const Htuple DrawID)

void SetDrawingObjectXld(const HObject& Contour, const HTuple& DrawID)

void HDrawingObject::SetDrawingObjectXld(const HXLDCont& Contour) const

static void HOperatorSet.SetDrawingObjectXld(HObject contour, HTuple drawID)

void HDrawingObject.SetDrawingObjectXld(HXLDCont contour)

def set_drawing_object_xld(contour: HObject, draw_id: HHandle) -> None

Description

set_drawing_object_xldset_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldset_drawing_object_xld substitutes the XLD currently contained in the draw object by the new ContourContourContourcontourcontour. The contour must contain at least two points, so that the interaction as described in create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXldcreate_drawing_object_xld is possible.

In addition, if the drawing object DrawIDDrawIDDrawIDdrawIDdraw_id is currently attached to a HALCON window, the window will be redrawn with each call of set_drawing_object_xldset_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldset_drawing_object_xld.

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

ContourContourContourcontourcontour (input_object)  xld_cont objectHXLDContHObjectHObjectHobject

XLD contour.

DrawIDDrawIDDrawIDdrawIDdraw_id (input_control)  drawing_object HDrawingObject, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the drawing object.

Result

set_drawing_object_xldset_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldset_drawing_object_xld returns 2 ( H_MSG_TRUE) , if the DrawIDDrawIDDrawIDdrawIDdraw_id is valid and ContourContourContourcontourcontour is a contour consisting of at least two points. If necessary, an exception is raised.

Possible Predecessors

create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXldcreate_drawing_object_xld

Possible Successors

attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window, clear_drawing_objectclear_drawing_objectClearDrawingObjectClearDrawingObjectclear_drawing_object

Alternatives

create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXldcreate_drawing_object_xld

See also

attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window

Module

Foundation