HALCON 17.12 / HALCON Operator Reference / Graphics / Object
ClassesClasses | | Operators

get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParams (Operator)

Name

get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParams — Get the parameters of a drawing object.

Signature

get_drawing_object_params( : : DrawID, GenParamName : GenParamValue)

Herror get_drawing_object_params(const Hlong DrawID, const char* GenParamName, double* GenParamValue)

Herror T_get_drawing_object_params(const Htuple DrawID, const Htuple GenParamName, Htuple* GenParamValue)

void GetDrawingObjectParams(const HTuple& DrawID, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HDrawingObject::GetDrawingObjectParams(const HTuple& GenParamName) const

HTuple HDrawingObject::GetDrawingObjectParams(const HString& GenParamName) const

HTuple HDrawingObject::GetDrawingObjectParams(const char* GenParamName) const

static void HOperatorSet.GetDrawingObjectParams(HTuple drawID, HTuple genParamName, out HTuple genParamValue)

HTuple HDrawingObject.GetDrawingObjectParams(HTuple genParamName)

HTuple HDrawingObject.GetDrawingObjectParams(string genParamName)

Description

get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsGetDrawingObjectParams can be used to query the parameters that describe the drawing object DrawIDDrawIDDrawIDDrawIDdrawID. One may specifiy one or several parameters which will be retrieved in the output tuple GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue, in the same order as specified in the input tuple GenParamNameGenParamNameGenParamNameGenParamNamegenParamName.

In addition to the parameters described in set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParamsSetDrawingObjectParams following parameters are possible for GenParamNameGenParamNameGenParamNameGenParamNamegenParamName:

'type':

Returns the type of the drawing object. Possible return values are: 'circle'"circle""circle""circle""circle", 'circle_sector'"circle_sector""circle_sector""circle_sector""circle_sector", 'ellipse'"ellipse""ellipse""ellipse""ellipse", 'ellipse_sector'"ellipse_sector""ellipse_sector""ellipse_sector""ellipse_sector", 'rectangle1'"rectangle1""rectangle1""rectangle1""rectangle1", 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2", 'line'"line""line""line""line", 'xld'"xld""xld""xld""xld", 'text'"text""text""text""text"

Execution Information

Parameters

DrawIDDrawIDDrawIDDrawIDdrawID (input_control)  drawing_object → HDrawingObject, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handle of the drawing object.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  attribute.name(-array) → HTupleHTupleHtuple (string) (string) (HString) (char*)

Parameter names of the drawing object.

List of values: 'color'"color""color""color""color", 'column'"column""column""column""column", 'column1'"column1""column1""column1""column1", 'column2'"column2""column2""column2""column2", 'end_angle'"end_angle""end_angle""end_angle""end_angle", 'font'"font""font""font""font", 'length1'"length1""length1""length1""length1", 'length2'"length2""length2""length2""length2", 'line_style'"line_style""line_style""line_style""line_style", 'line_width'"line_width""line_width""line_width""line_width", 'phi'"phi""phi""phi""phi", 'radius'"radius""radius""radius""radius", 'radius1'"radius1""radius1""radius1""radius1", 'radius2'"radius2""radius2""radius2""radius2", 'row'"row""row""row""row", 'row1'"row1""row1""row1""row1", 'row2'"row2""row2""row2""row2", 'start_angle'"start_angle""start_angle""start_angle""start_angle", 'string'"string""string""string""string", 'type'"type""type""type""type"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control)  attribute.name(-array) → HTupleHTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)

Parameter values.

Result

get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsGetDrawingObjectParams returns 2 (H_MSG_TRUE), if the DrawIDDrawIDDrawIDDrawIDdrawID is valid. Otherwise an exception is raised.

Possible Predecessors

create_drawing_object_rectangle1create_drawing_object_rectangle1CreateDrawingObjectRectangle1CreateDrawingObjectRectangle1CreateDrawingObjectRectangle1, create_drawing_object_rectangle2create_drawing_object_rectangle2CreateDrawingObjectRectangle2CreateDrawingObjectRectangle2CreateDrawingObjectRectangle2, create_drawing_object_ellipsecreate_drawing_object_ellipseCreateDrawingObjectEllipseCreateDrawingObjectEllipseCreateDrawingObjectEllipse, create_drawing_object_circlecreate_drawing_object_circleCreateDrawingObjectCircleCreateDrawingObjectCircleCreateDrawingObjectCircle, create_drawing_object_linecreate_drawing_object_lineCreateDrawingObjectLineCreateDrawingObjectLineCreateDrawingObjectLine, create_drawing_object_ellipse_sectorcreate_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSectorCreateDrawingObjectEllipseSectorCreateDrawingObjectEllipseSector, create_drawing_object_circle_sectorcreate_drawing_object_circle_sectorCreateDrawingObjectCircleSectorCreateDrawingObjectCircleSectorCreateDrawingObjectCircleSector, create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXldCreateDrawingObjectXld, create_drawing_object_textcreate_drawing_object_textCreateDrawingObjectTextCreateDrawingObjectTextCreateDrawingObjectText, attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindow

Possible Successors

set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParamsSetDrawingObjectParams, attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindow, get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicGetDrawingObjectIconic

Alternatives

get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicGetDrawingObjectIconic

See also

attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowAttachDrawingObjectToWindow, get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicGetDrawingObjectIconic, set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParamsSetDrawingObjectParams

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 17.12 Copyright © 1996-2017 MVTec Software GmbH