Skip to content

set_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldset_drawing_object_xldT_set_drawing_object_xld🔗

Short description🔗

set_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldset_drawing_object_xldT_set_drawing_object_xld — Set the contour of an interactive draw XLD.

Signature🔗

set_drawing_object_xld( xld_cont Contour, drawing_object DrawID )void SetDrawingObjectXld( const HObject& Contour, const HTuple& DrawID )static void HOperatorSet.SetDrawingObjectXld( HObject contour, HTuple drawID )def set_drawing_object_xld( contour: HObject, draw_id: HHandle ) -> None

Herror T_set_drawing_object_xld( const Hobject Contour, const Htuple DrawID )

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

void HDrawingObject.SetDrawingObjectXld( HXLDCont contour )

Description🔗

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

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

Execution information🔗

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🔗

Contourcontourcontour (input_object) xld_cont → objectHObjectHXLDContHObjectHobject

XLD contour.

DrawIDdrawIDdraw_id (input_control) drawing_object → (handle)HTuple (HHandle)HDrawingObject, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the drawing object.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_drawing_object_xldCreateDrawingObjectXld

Possible successors

attach_drawing_object_to_windowAttachDrawingObjectToWindow, clear_drawing_objectClearDrawingObject

Alternatives

create_drawing_object_xldCreateDrawingObjectXld

See also

attach_drawing_object_to_windowAttachDrawingObjectToWindow

Module🔗

Foundation