Skip to content

get_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicget_drawing_object_iconicT_get_drawing_object_iconic🔗

Short description🔗

get_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicget_drawing_object_iconicT_get_drawing_object_iconic — Return the iconic object of a drawing object.

Signature🔗

get_drawing_object_iconic( out object Object, drawing_object DrawID )void GetDrawingObjectIconic( HObject* Object, const HTuple& DrawID )static void HOperatorSet.GetDrawingObjectIconic( out HObject objectVal, HTuple drawID )def get_drawing_object_iconic( draw_id: HHandle ) -> HObject

Herror T_get_drawing_object_iconic( Hobject* Object, const Htuple DrawID )

HObject HDrawingObject::GetDrawingObjectIconic( ) const

HObject HDrawingObject.GetDrawingObjectIconic( )

Description🔗

get_drawing_object_iconicGetDrawingObjectIconic returns the iconic object ObjectobjectValobject that corresponds to the drawing object DrawIDdrawIDdraw_id. In addition, the parameters that define the drawing object can be queried with the operator get_drawing_object_paramsGetDrawingObjectParams.

Execution information🔗

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🔗

ObjectobjectValobject (output_object) object(-array) → objectHObjectHObjectHObjectHobject *

Copy of the iconic object represented by the drawing object.

DrawIDdrawIDdraw_id (input_control) drawing_object → (handle)HTuple (HHandle)HDrawingObject, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the drawing object.

Result🔗

clear_drawing_objectClearDrawingObject returns 2 (H_MSG_TRUE) if the DrawIDdrawIDdraw_id is valid. Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_drawing_object_rectangle1CreateDrawingObjectRectangle1, create_drawing_object_rectangle2CreateDrawingObjectRectangle2, create_drawing_object_ellipseCreateDrawingObjectEllipse, create_drawing_object_circleCreateDrawingObjectCircle, create_drawing_object_lineCreateDrawingObjectLine, create_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSector, create_drawing_object_circle_sectorCreateDrawingObjectCircleSector, create_drawing_object_xldCreateDrawingObjectXld

Possible successors

reduce_domainReduceDomain, gen_region_contour_xldGenRegionContourXld, attach_drawing_object_to_windowAttachDrawingObjectToWindow

Alternatives

get_drawing_object_paramsGetDrawingObjectParams

See also

get_drawing_object_paramsGetDrawingObjectParams, attach_drawing_object_to_windowAttachDrawingObjectToWindow

Module🔗

Foundation