create_drawing_object_ellipsecreate_drawing_object_ellipseCreateDrawingObjectEllipseCreateDrawingObjectEllipse (Operator)

Name

create_drawing_object_ellipsecreate_drawing_object_ellipseCreateDrawingObjectEllipseCreateDrawingObjectEllipse — Create an ellipse which can be modified interactively.

Signature

create_drawing_object_ellipse( : : Row, Column, Phi, Radius1, Radius2 : DrawID)

create_drawing_object_ellipsecreate_drawing_object_ellipseCreateDrawingObjectEllipseCreateDrawingObjectEllipseCreateDrawingObjectEllipse creates an ellipse which can be modified interactively in a HALCON window by the user. The ellipse is defined by the coordinates of its centre point, RowRowRowRowrow and ColumnColumnColumnColumncolumn, the lengths of its respective half axis, Radius1Radius1Radius1Radius1radius1 and Radius2Radius2Radius2Radius2radius2, and its orientation PhiPhiPhiPhiphi.

The parameters can be queried with get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsGetDrawingObjectParams, as well as its corresponding HALCON object with get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicGetDrawingObjectIconic.

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_paramsSetDrawingObjectParamsSetDrawingObjectParamsSetDrawingObjectParams 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_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindow for further details. Once attached, the ellipse is editable by the user through interaction with the window. There are three possible transformations for an ellipse object: resizing, displacement and rotation. The ellipse can be resized by clicking close to the vertex handles. The orientation and thus the rotation of the ellipse can be modified by dragging on a vertex of the first half axis. The ellipse can be moved in the HALCON window by dragging the center.

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

Note that since internal structures are allocated during create_drawing_object_ellipsecreate_drawing_object_ellipseCreateDrawingObjectEllipseCreateDrawingObjectEllipseCreateDrawingObjectEllipse and the following operator the resulting drawing object should be explicitly freed if it is no longer needed.

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) ellipse.center.y → (real)

Row index of the center.

Default value: 200

ColumnColumnColumnColumncolumn (input_control) ellipse.center.x → (real)

Column index of the center.

Default value: 200

PhiPhiPhiPhiphi (input_control) ellipse.angle.rad → (real)

Orientation of the first half axis in radians.

Default value: 0

Radius1Radius1Radius1Radius1radius1 (input_control) ellipse.radius1 → (real)

First half axis.

Default value: 100

Radius2Radius2Radius2Radius2radius2 (input_control) ellipse.radius2 → (real)

Second half axis.

Default value: 60

DrawIDDrawIDDrawIDDrawIDdrawID (output_control) drawing_object → (integer)

Handle of the drawing object.

Result

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