Operator Reference

remove_objremove_objRemoveObjRemoveObjremove_obj (Operator)

remove_objremove_objRemoveObjRemoveObjremove_obj — Remove objects from an iconic object tuple.

Signature

remove_obj(Objects : ObjectsReduced : Index : )

Herror remove_obj(const Hobject Objects, Hobject* ObjectsReduced, const Hlong Index)

Herror T_remove_obj(const Hobject Objects, Hobject* ObjectsReduced, const Htuple Index)

void RemoveObj(const HObject& Objects, HObject* ObjectsReduced, const HTuple& Index)

HObject HObject::RemoveObj(const HTuple& Index) const

HObject HObject::RemoveObj(Hlong Index) const

HImage HImage::RemoveObj(const HTuple& Index) const

HImage HImage::RemoveObj(Hlong Index) const

HRegion HRegion::RemoveObj(const HTuple& Index) const

HRegion HRegion::RemoveObj(Hlong Index) const

HXLD HXLD::RemoveObj(const HTuple& Index) const

HXLD HXLD::RemoveObj(Hlong Index) const

HXLDCont HXLDCont::RemoveObj(const HTuple& Index) const

HXLDCont HXLDCont::RemoveObj(Hlong Index) const

HXLDPoly HXLDPoly::RemoveObj(const HTuple& Index) const

HXLDPoly HXLDPoly::RemoveObj(Hlong Index) const

HXLDPara HXLDPara::RemoveObj(const HTuple& Index) const

HXLDPara HXLDPara::RemoveObj(Hlong Index) const

HXLDModPara HXLDModPara::RemoveObj(const HTuple& Index) const

HXLDModPara HXLDModPara::RemoveObj(Hlong Index) const

HXLDExtPara HXLDExtPara::RemoveObj(const HTuple& Index) const

HXLDExtPara HXLDExtPara::RemoveObj(Hlong Index) const

static void HOperatorSet.RemoveObj(HObject objects, out HObject objectsReduced, HTuple index)

HObject HObject.RemoveObj(HTuple index)

HObject HObject.RemoveObj(int index)

HImage HImage.RemoveObj(HTuple index)

HImage HImage.RemoveObj(int index)

HRegion HRegion.RemoveObj(HTuple index)

HRegion HRegion.RemoveObj(int index)

HXLD HXLD.RemoveObj(HTuple index)

HXLD HXLD.RemoveObj(int index)

HXLDCont HXLDCont.RemoveObj(HTuple index)

HXLDCont HXLDCont.RemoveObj(int index)

HXLDPoly HXLDPoly.RemoveObj(HTuple index)

HXLDPoly HXLDPoly.RemoveObj(int index)

HXLDPara HXLDPara.RemoveObj(HTuple index)

HXLDPara HXLDPara.RemoveObj(int index)

HXLDModPara HXLDModPara.RemoveObj(HTuple index)

HXLDModPara HXLDModPara.RemoveObj(int index)

HXLDExtPara HXLDExtPara.RemoveObj(HTuple index)

HXLDExtPara HXLDExtPara.RemoveObj(int index)

def remove_obj(objects: HObject, index: MaybeSequence[int]) -> HObject

Description

remove_objremove_objRemoveObjRemoveObjremove_obj removes the elements referred by IndexIndexIndexindexindex from the tuple ObjectsObjectsObjectsobjectsobjects and returns the rest in the tuple ObjectsReducedObjectsReducedObjectsReducedobjectsReducedobjects_reduced. IndexIndexIndexindexindex determines the index of the elements to remove. Note that, in contrast to control tuples, indices for the object tuple elements start at 1, i.e. the first tuple element has got the index 1. Duplicates and indices out of range are ignored.

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

ObjectsObjectsObjectsobjectsobjects (input_object)  object(-array) objectHObjectHObjectHObjectHobject

Input object tuple.

ObjectsReducedObjectsReducedObjectsReducedobjectsReducedobjects_reduced (output_object)  object(-array) objectHObjectHObjectHObjectHobject *

Remaining object tuple.

IndexIndexIndexindexindex (input_control)  number(-array) HTupleMaybeSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Indices of the objects to be removed.

Example (HDevelop)

gen_empty_obj (Images)
for Index := 1 to 10 by 1
  gen_image_const (Image, 'byte', Index, Index)
  concat_obj (Images, Image, Images)
endfor

remove_obj (Images, Images, [7, 4])

Alternatives

select_objselect_objSelectObjSelectObjselect_obj

See also

count_objcount_objCountObjCountObjcount_obj, select_objselect_objSelectObjSelectObjselect_obj, copy_objcopy_objCopyObjCopyObjcopy_obj, insert_objinsert_objInsertObjInsertObjinsert_obj

Module

Foundation