Skip to content

insert_objInsertObjInsertObjinsert_objinsert_obj🔗

Short description🔗

insert_objInsertObjInsertObjinsert_objinsert_obj — Insert objects into an iconic object tuple.

Signature🔗

insert_obj( object Objects, object ObjectsInsert, out object ObjectsExtended, number Index )void InsertObj( const HObject& Objects, const HObject& ObjectsInsert, HObject* ObjectsExtended, const HTuple& Index )static void HOperatorSet.InsertObj( HObject objects, HObject objectsInsert, out HObject objectsExtended, HTuple index )def insert_obj( objects: HObject, objects_insert: HObject, index: int ) -> HObject

Herror insert_obj( const Hobject Objects, const Hobject ObjectsInsert, Hobject* ObjectsExtended, const Hlong Index )

Herror T_insert_obj( const Hobject Objects, const Hobject ObjectsInsert, Hobject* ObjectsExtended, const Htuple Index )

HObject HObject::InsertObj( const HObject& ObjectsInsert, Hlong Index ) const

HImage HImage::InsertObj( const HImage& ObjectsInsert, Hlong Index ) const

HRegion HRegion::InsertObj( const HRegion& ObjectsInsert, Hlong Index ) const

HXLD HXLD::InsertObj( const HXLD& ObjectsInsert, Hlong Index ) const

HXLDCont HXLDCont::InsertObj( const HXLDCont& ObjectsInsert, Hlong Index ) const

HXLDPoly HXLDPoly::InsertObj( const HXLDPoly& ObjectsInsert, Hlong Index ) const

HXLDPara HXLDPara::InsertObj( const HXLDPara& ObjectsInsert, Hlong Index ) const

HXLDModPara HXLDModPara::InsertObj( const HXLDModPara& ObjectsInsert, Hlong Index ) const

HXLDExtPara HXLDExtPara::InsertObj( const HXLDExtPara& ObjectsInsert, Hlong Index ) const

HObject HObject.InsertObj( HObject objectsInsert, int index )

HImage HImage.InsertObj( HImage objectsInsert, int index )

HRegion HRegion.InsertObj( HRegion objectsInsert, int index )

HXLD HXLD.InsertObj( HXLD objectsInsert, int index )

HXLDCont HXLDCont.InsertObj( HXLDCont objectsInsert, int index )

HXLDPoly HXLDPoly.InsertObj( HXLDPoly objectsInsert, int index )

HXLDPara HXLDPara.InsertObj( HXLDPara objectsInsert, int index )

HXLDModPara HXLDModPara.InsertObj( HXLDModPara objectsInsert, int index )

HXLDExtPara HXLDExtPara.InsertObj( HXLDExtPara objectsInsert, int index )

Description🔗

insert_objInsertObj inserts the elements of ObjectsInsertobjectsInsertobjects_insert at Indexindexindex into the object tuple Objectsobjectsobjects and returns the result in ObjectsExtendedobjectsExtendedobjects_extended.

Indexindexindex must contain a single integer value. Note that, in contrast to control tuples, indices of object tuple elements start at 1. The length of ObjectsExtendedobjectsExtendedobjects_extended is the sum of the length of Objectsobjectsobjects and ObjectsInsertobjectsInsertobjects_insert. It is allowed to mix images, regions and XLDs in Objectsobjectsobjects and ObjectsInsertobjectsInsertobjects_insert.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

Parameters🔗

Objectsobjectsobjects (input_object) object(-array) → objectHObjectHObjectHObjectHobject

Input object tuple.

ObjectsInsertobjectsInsertobjects_insert (input_object) object(-array) → objectHObjectHObjectHObjectHobject

Object tuple to insert.

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

Extended object tuple.

Indexindexindex (input_control) number → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Index to insert objects.

Example🔗

(HDevelop)

gen_image_const (Image1, 'byte', 1, 1)
gen_image_const (Image3, 'byte', 3, 3)
concat_obj (Image1, Image3, Images)
gen_image_const (Image, 'byte', 2, 2)
insert_obj (Images, Image, Images, 2)

Complexity🔗

Typical runtime complexity: \(O(|\textrm{Objects}| + |\textrm{ObjectsInsert}|)\).

Combinations with other operators🔗

Combinations

Possible predecessors

count_objCountObj

Possible successors

count_objCountObj

Alternatives

concat_objConcatObj

See also

count_objCountObj, select_objSelectObj, copy_objCopyObj, remove_objRemoveObj

Module🔗

Foundation