Skip to content

create_drawing_object_circleCreateDrawingObjectCircleCreateDrawingObjectCirclecreate_drawing_object_circleT_create_drawing_object_circle🔗

Short description🔗

create_drawing_object_circleCreateDrawingObjectCircleCreateDrawingObjectCirclecreate_drawing_object_circleT_create_drawing_object_circle — Create a circle which can be modified interactively.

Signature🔗

create_drawing_object_circle( circle.center.y Row, circle.center.x Column, circle.radius Radius, out drawing_object DrawID )void CreateDrawingObjectCircle( const HTuple& Row, const HTuple& Column, const HTuple& Radius, HTuple* DrawID )static void HOperatorSet.CreateDrawingObjectCircle( HTuple row, HTuple column, HTuple radius, out HTuple drawID )def create_drawing_object_circle( row: float, column: float, radius: float ) -> HHandle

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

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

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

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

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

Description🔗

create_drawing_object_circleCreateDrawingObjectCircle creates a circular region which can be interactively modified in a HALCON window by the user. The circle is defined by the coordinates Rowrowrow and Columncolumncolumn of its center, and by its Radiusradiusradius. The created circle is returned in the handle DrawIDdrawIDdraw_id.

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

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_paramsSetDrawingObjectParams 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_windowAttachDrawingObjectToWindow 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 Radiusradiusradius of the circle. By clicking on the center, the circle can be dragged across the HALCON window.

In contrast to the operator draw_circleDrawCircle, this interaction does not block the calling thread.

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.

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🔗

Rowrowrow (input_control) circle.center.y → (real)HTuple (double)HTuple (double)floatHtuple (double)

Row coordinate of the center.

Default: 100100

Columncolumncolumn (input_control) circle.center.x → (real)HTuple (double)HTuple (double)floatHtuple (double)

Column coordinate of the center.

Default: 100100

Radiusradiusradius (input_control) circle.radius → (real)HTuple (double)HTuple (double)floatHtuple (double)

Radius of the circle.

Default: 8080

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

Handle of the drawing object.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow

Possible successors

attach_drawing_object_to_windowAttachDrawingObjectToWindow, get_drawing_object_paramsGetDrawingObjectParams, get_drawing_object_iconicGetDrawingObjectIconic

Alternatives

draw_circleDrawCircle, draw_regionDrawRegion, create_drawing_object_circle_sectorCreateDrawingObjectCircleSector, create_drawing_object_ellipseCreateDrawingObjectEllipse, create_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSector

See also

create_drawing_object_rectangle1CreateDrawingObjectRectangle1, create_drawing_object_rectangle2CreateDrawingObjectRectangle2, create_drawing_object_ellipseCreateDrawingObjectEllipse, create_drawing_object_circle_sectorCreateDrawingObjectCircleSector, create_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSector, create_drawing_object_xldCreateDrawingObjectXld

Module🔗

Foundation