create_drawing_object_textT_create_drawing_object_textCreateDrawingObjectTextCreateDrawingObjectTextcreate_drawing_object_text (Operator)
Name
create_drawing_object_textT_create_drawing_object_textCreateDrawingObjectTextCreateDrawingObjectTextcreate_drawing_object_text — Create a text object which can be moved interactively.
Signature
Herror T_create_drawing_object_text(const Htuple Row, const Htuple Column, const Htuple String, Htuple* DrawID)
def create_drawing_object_text(row: int, column: int, string: str) -> HHandle
Description
create_drawing_object_textcreate_drawing_object_textCreateDrawingObjectTextCreateDrawingObjectTextCreateDrawingObjectTextcreate_drawing_object_text creates a text object which can be moved
interactively across a HALCON window. The coordinates RowRowRowRowrowrow and
ColumnColumnColumnColumncolumncolumn define the position of the text.
These parameters can be queried any time with get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params,
as well as its corresponding HALCON object with get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicGetDrawingObjectIconicget_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_paramsSetDrawingObjectParamsSetDrawingObjectParamsSetDrawingObjectParamsset_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_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_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_paramsSetDrawingObjectParamsSetDrawingObjectParamsSetDrawingObjectParamsset_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
RowRowRowRowrowrow (input_control) point.y → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Row coordinate of the text position.
Default value: 12
ColumnColumnColumnColumncolumncolumn (input_control) point.x → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Column coordinate of the text position.
Default value: 12
StringStringStringStringstringValstring (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Character string to be displayed.
Default value:
'Text'
"Text"
"Text"
"Text"
"Text"
"Text"
DrawIDDrawIDDrawIDDrawIDdrawIDdraw_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_textCreateDrawingObjectTextCreateDrawingObjectTextCreateDrawingObjectTextcreate_drawing_object_text returns the value 2 (H_MSG_TRUE).
Otherwise an exception is raised.
Possible Predecessors
open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window
Possible Successors
attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window,
get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params,
set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParamsSetDrawingObjectParamsset_drawing_object_params
Alternatives
write_stringwrite_stringWriteStringWriteStringWriteStringwrite_string
See also
write_stringwrite_stringWriteStringWriteStringWriteStringwrite_string,
attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window
Module
Foundation