Operator Reference

HALCON Operator Reference / Graphics / Object
ClassesClasses | | Operators

create_drawing_object_textT_create_drawing_object_textCreateDrawingObjectTextCreateDrawingObjectTextcreate_drawing_object_text (Operator)

create_drawing_object_textT_create_drawing_object_textCreateDrawingObjectTextCreateDrawingObjectTextcreate_drawing_object_text — Create a text object which can be moved interactively.

Signature

create_drawing_object_text( : : Row, Column, String : DrawID)

Herror T_create_drawing_object_text(const Htuple Row, const Htuple Column, const Htuple String, Htuple* DrawID)

void CreateDrawingObjectText(const HTuple& Row, const HTuple& Column, const HTuple& String, HTuple* DrawID)

void HDrawingObject::CreateDrawingObjectText(Hlong Row, Hlong Column, const HString& String)

void HDrawingObject::CreateDrawingObjectText(Hlong Row, Hlong Column, const char* String)

void HDrawingObject::CreateDrawingObjectText(Hlong Row, Hlong Column, const wchar_t* String)   ( Windows only)

static void HOperatorSet.CreateDrawingObjectText(HTuple row, HTuple column, HTuple stringVal, out HTuple drawID)

void HDrawingObject.CreateDrawingObjectText(int row, int column, string stringVal)

def create_drawing_object_text(row: int, column: int, string: str) -> HHandle

Description

create_drawing_object_textcreate_drawing_object_textCreateDrawingObjectTextCreateDrawingObjectTextcreate_drawing_object_text creates a text object which can be moved interactively across a HALCON window. The coordinates RowRowRowrowrow and ColumnColumnColumncolumncolumn define the position of the text.

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 text 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. The text will be displayed with the current font settings of the HALCON window by default. However, the font setting can be adjusted with set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParamsset_drawing_object_params. Once attached, the text can be moved by the user through interaction with the window.

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)  point.y → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Row coordinate of the text position.

Default: 12

ColumnColumnColumncolumncolumn (input_control)  point.x → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Column coordinate of the text position.

Default: 12

StringStringStringstringValstring (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Character string to be displayed.

Default: 'Text' "Text" "Text" "Text" "Text"

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_textcreate_drawing_object_textCreateDrawingObjectTextCreateDrawingObjectTextcreate_drawing_object_text 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, set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParamsset_drawing_object_params

Alternatives

write_stringwrite_stringWriteStringWriteStringwrite_string

See also

write_stringwrite_stringWriteStringWriteStringwrite_string, attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window

Module

Foundation

ClassesClasses | | Operators