set_drawing_object_xldT_set_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldset_drawing_object_xld (Operator)
Name
set_drawing_object_xldT_set_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldset_drawing_object_xld — Set the contour of an interactive draw XLD.
Signature
Herror T_set_drawing_object_xld(const Hobject Contour, const Htuple DrawID)
def set_drawing_object_xld(contour: HObject, draw_id: HHandle) -> None
Description
set_drawing_object_xldset_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldSetDrawingObjectXldset_drawing_object_xld substitutes the XLD currently contained in the draw
object by the new ContourContourContourContourcontourcontour. The contour must contain at least two
points, so that the interaction as described in create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXldCreateDrawingObjectXldcreate_drawing_object_xld is
possible.
In addition, if the drawing object DrawIDDrawIDDrawIDDrawIDdrawIDdraw_id is currently attached to a
HALCON window, the window will be redrawn with each call of set_drawing_object_xldset_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldSetDrawingObjectXldset_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
ContourContourContourContourcontourcontour (input_object) xld_cont → objectHXLDContHObjectHXLDContHobject
XLD contour.
DrawIDDrawIDDrawIDDrawIDdrawIDdraw_id (input_control) drawing_object → HDrawingObject, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the drawing object.
Result
set_drawing_object_xldset_drawing_object_xldSetDrawingObjectXldSetDrawingObjectXldSetDrawingObjectXldset_drawing_object_xld returns 2 (H_MSG_TRUE), if the DrawIDDrawIDDrawIDDrawIDdrawIDdraw_id is valid and
ContourContourContourContourcontourcontour is a contour consisting of at least two points.
If necessary, an exception is raised.
Possible Predecessors
create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXldCreateDrawingObjectXldcreate_drawing_object_xld
Possible Successors
attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window,
clear_drawing_objectclear_drawing_objectClearDrawingObjectClearDrawingObjectClearDrawingObjectclear_drawing_object
Alternatives
create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXldCreateDrawingObjectXldcreate_drawing_object_xld
See also
attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window
Module
Foundation