get_drawing_object_iconicT_get_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicget_drawing_object_iconic (Operator)
get_drawing_object_iconicT_get_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicget_drawing_object_iconic — Return the iconic object of a drawing object.
Signature
Herror T_get_drawing_object_iconic(Hobject* Object, const Htuple DrawID)
def get_drawing_object_iconic(draw_id: HHandle) -> HObject
Description
get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicget_drawing_object_iconic returns the iconic object ObjectObjectObjectobjectValobject
that corresponds to the drawing object DrawIDDrawIDDrawIDdrawIDdraw_id.
In addition, the parameters that define the drawing object can be queried
with the operator get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
ObjectObjectObjectobjectValobject (output_object) object(-array) → objectHObjectHObjectHObjectHobject *
Copy of the iconic object represented by the drawing object.
DrawIDDrawIDDrawIDdrawIDdraw_id (input_control) drawing_object → HDrawingObject, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the drawing object.
Result
clear_drawing_objectclear_drawing_objectClearDrawingObjectClearDrawingObjectclear_drawing_object returns 2 (
H_MSG_TRUE)
, if the DrawIDDrawIDDrawIDdrawIDdraw_id is valid.
Otherwise an exception is raised.
Possible Predecessors
create_drawing_object_rectangle1create_drawing_object_rectangle1CreateDrawingObjectRectangle1CreateDrawingObjectRectangle1create_drawing_object_rectangle1,
create_drawing_object_rectangle2create_drawing_object_rectangle2CreateDrawingObjectRectangle2CreateDrawingObjectRectangle2create_drawing_object_rectangle2,
create_drawing_object_ellipsecreate_drawing_object_ellipseCreateDrawingObjectEllipseCreateDrawingObjectEllipsecreate_drawing_object_ellipse,
create_drawing_object_circlecreate_drawing_object_circleCreateDrawingObjectCircleCreateDrawingObjectCirclecreate_drawing_object_circle,
create_drawing_object_linecreate_drawing_object_lineCreateDrawingObjectLineCreateDrawingObjectLinecreate_drawing_object_line,
create_drawing_object_ellipse_sectorcreate_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSectorCreateDrawingObjectEllipseSectorcreate_drawing_object_ellipse_sector,
create_drawing_object_circle_sectorcreate_drawing_object_circle_sectorCreateDrawingObjectCircleSectorCreateDrawingObjectCircleSectorcreate_drawing_object_circle_sector,
create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXldcreate_drawing_object_xld
Possible Successors
reduce_domainreduce_domainReduceDomainReduceDomainreduce_domain,
gen_region_contour_xldgen_region_contour_xldGenRegionContourXldGenRegionContourXldgen_region_contour_xld,
attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window
Alternatives
get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params
See also
get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params,
attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window
Module
Foundation