Operator Reference

create_drawing_object_circleT_create_drawing_object_circleCreateDrawingObjectCircleCreateDrawingObjectCirclecreate_drawing_object_circle (Operator)

create_drawing_object_circleT_create_drawing_object_circleCreateDrawingObjectCircleCreateDrawingObjectCirclecreate_drawing_object_circle — Create a circle which can be modified interactively.

Signature

create_drawing_object_circle( : : Row, Column, Radius : DrawID)

Herror T_create_drawing_object_circle(const Htuple Row, const Htuple Column, const Htuple Radius, Htuple* DrawID)

void CreateDrawingObjectCircle(const HTuple& Row, const HTuple& Column, const HTuple& Radius, HTuple* DrawID)

void HDrawingObject::HDrawingObject(double Row, double Column, double Radius)

void HDrawingObject::CreateDrawingObjectCircle(double Row, double Column, double Radius)

static void HOperatorSet.CreateDrawingObjectCircle(HTuple row, HTuple column, HTuple radius, out HTuple drawID)

public HDrawingObject(double row, double column, double radius)

void HDrawingObject.CreateDrawingObjectCircle(double row, double column, double radius)

def create_drawing_object_circle(row: float, column: float, radius: float) -> HHandle

Description

create_drawing_object_circlecreate_drawing_object_circleCreateDrawingObjectCircleCreateDrawingObjectCirclecreate_drawing_object_circle creates a circular region which can be interactively modified in a HALCON window by the user. The circle is defined by the coordinates RowRowRowrowrow and ColumnColumnColumncolumncolumn of its center, and by its RadiusRadiusRadiusradiusradius. The created circle is returned in the handle DrawIDDrawIDDrawIDdrawIDdraw_id.

These parameters can be queried any time with get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params, as well as its corresponding HALCON object with get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicget_drawing_object_iconic.

In addition to those parameters, every drawing object has a number of parameters which determine the appearance of the object in the HALCON window. See set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParamsset_drawing_object_params for details on the number and meaning of those parameters.

In order to enable the interactive modification with the drawing object, the object must be attached to an existing window. See attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window for further details. Once attached, the circle is editable by the user through interaction within the window. There are two possible transformations for a circle object: resizing and displacement. By clicking close to the circular arc you can modify the RadiusRadiusRadiusradiusradius of the circle. By clicking on the center, the circle can be dragged across the HALCON window.

In contrast to the operator draw_circledraw_circleDrawCircleDrawCircledraw_circle, this interaction does not block the calling 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.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

RowRowRowrowrow (input_control)  circle.center.y HTuplefloatHTupleHtuple (real) (double) (double) (double)

Row coordinate of the center.

Default: 100

ColumnColumnColumncolumncolumn (input_control)  circle.center.x HTuplefloatHTupleHtuple (real) (double) (double) (double)

Column coordinate of the center.

Default: 100

RadiusRadiusRadiusradiusradius (input_control)  circle.radius HTuplefloatHTupleHtuple (real) (double) (double) (double)

Radius of the circle.

Default: 80

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

Handle of the drawing object.

Result

If the parameter values are correct the operator create_drawing_object_circlecreate_drawing_object_circleCreateDrawingObjectCircleCreateDrawingObjectCirclecreate_drawing_object_circle returns the value 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window

Possible Successors

attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window, get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params, get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicget_drawing_object_iconic

Alternatives

draw_circledraw_circleDrawCircleDrawCircledraw_circle, draw_regiondraw_regionDrawRegionDrawRegiondraw_region, create_drawing_object_circle_sectorcreate_drawing_object_circle_sectorCreateDrawingObjectCircleSectorCreateDrawingObjectCircleSectorcreate_drawing_object_circle_sector, create_drawing_object_ellipsecreate_drawing_object_ellipseCreateDrawingObjectEllipseCreateDrawingObjectEllipsecreate_drawing_object_ellipse, create_drawing_object_ellipse_sectorcreate_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSectorCreateDrawingObjectEllipseSectorcreate_drawing_object_ellipse_sector

See also

create_drawing_object_rectangle1create_drawing_object_rectangle1CreateDrawingObjectRectangle1CreateDrawingObjectRectangle1create_drawing_object_rectangle1, create_drawing_object_rectangle2create_drawing_object_rectangle2CreateDrawingObjectRectangle2CreateDrawingObjectRectangle2create_drawing_object_rectangle2, create_drawing_object_ellipsecreate_drawing_object_ellipseCreateDrawingObjectEllipseCreateDrawingObjectEllipsecreate_drawing_object_ellipse, create_drawing_object_circle_sectorcreate_drawing_object_circle_sectorCreateDrawingObjectCircleSectorCreateDrawingObjectCircleSectorcreate_drawing_object_circle_sector, create_drawing_object_ellipse_sectorcreate_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSectorCreateDrawingObjectEllipseSectorcreate_drawing_object_ellipse_sector, create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXldcreate_drawing_object_xld

Module

Foundation