Operator Reference

replace_objreplace_objReplaceObjReplaceObjreplace_obj (Operator)

replace_objreplace_objReplaceObjReplaceObjreplace_obj — Replaces one or more elements of an iconic object tuple.

Signature

replace_obj(Objects, ObjectsReplace : Replaced : Index : )

Herror replace_obj(const Hobject Objects, const Hobject ObjectsReplace, Hobject* Replaced, const Hlong Index)

Herror T_replace_obj(const Hobject Objects, const Hobject ObjectsReplace, Hobject* Replaced, const Htuple Index)

void ReplaceObj(const HObject& Objects, const HObject& ObjectsReplace, HObject* Replaced, const HTuple& Index)

HObject HObject::ReplaceObj(const HObject& ObjectsReplace, const HTuple& Index) const

HObject HObject::ReplaceObj(const HObject& ObjectsReplace, Hlong Index) const

HImage HImage::ReplaceObj(const HImage& ObjectsReplace, const HTuple& Index) const

HImage HImage::ReplaceObj(const HImage& ObjectsReplace, Hlong Index) const

HRegion HRegion::ReplaceObj(const HRegion& ObjectsReplace, const HTuple& Index) const

HRegion HRegion::ReplaceObj(const HRegion& ObjectsReplace, Hlong Index) const

HXLD HXLD::ReplaceObj(const HXLD& ObjectsReplace, const HTuple& Index) const

HXLD HXLD::ReplaceObj(const HXLD& ObjectsReplace, Hlong Index) const

HXLDCont HXLDCont::ReplaceObj(const HXLDCont& ObjectsReplace, const HTuple& Index) const

HXLDCont HXLDCont::ReplaceObj(const HXLDCont& ObjectsReplace, Hlong Index) const

HXLDPoly HXLDPoly::ReplaceObj(const HXLDPoly& ObjectsReplace, const HTuple& Index) const

HXLDPoly HXLDPoly::ReplaceObj(const HXLDPoly& ObjectsReplace, Hlong Index) const

HXLDPara HXLDPara::ReplaceObj(const HXLDPara& ObjectsReplace, const HTuple& Index) const

HXLDPara HXLDPara::ReplaceObj(const HXLDPara& ObjectsReplace, Hlong Index) const

HXLDModPara HXLDModPara::ReplaceObj(const HXLDModPara& ObjectsReplace, const HTuple& Index) const

HXLDModPara HXLDModPara::ReplaceObj(const HXLDModPara& ObjectsReplace, Hlong Index) const

HXLDExtPara HXLDExtPara::ReplaceObj(const HXLDExtPara& ObjectsReplace, const HTuple& Index) const

HXLDExtPara HXLDExtPara::ReplaceObj(const HXLDExtPara& ObjectsReplace, Hlong Index) const

static void HOperatorSet.ReplaceObj(HObject objects, HObject objectsReplace, out HObject replaced, HTuple index)

HObject HObject.ReplaceObj(HObject objectsReplace, HTuple index)

HObject HObject.ReplaceObj(HObject objectsReplace, int index)

HImage HImage.ReplaceObj(HImage objectsReplace, HTuple index)

HImage HImage.ReplaceObj(HImage objectsReplace, int index)

HRegion HRegion.ReplaceObj(HRegion objectsReplace, HTuple index)

HRegion HRegion.ReplaceObj(HRegion objectsReplace, int index)

HXLD HXLD.ReplaceObj(HXLD objectsReplace, HTuple index)

HXLD HXLD.ReplaceObj(HXLD objectsReplace, int index)

HXLDCont HXLDCont.ReplaceObj(HXLDCont objectsReplace, HTuple index)

HXLDCont HXLDCont.ReplaceObj(HXLDCont objectsReplace, int index)

HXLDPoly HXLDPoly.ReplaceObj(HXLDPoly objectsReplace, HTuple index)

HXLDPoly HXLDPoly.ReplaceObj(HXLDPoly objectsReplace, int index)

HXLDPara HXLDPara.ReplaceObj(HXLDPara objectsReplace, HTuple index)

HXLDPara HXLDPara.ReplaceObj(HXLDPara objectsReplace, int index)

HXLDModPara HXLDModPara.ReplaceObj(HXLDModPara objectsReplace, HTuple index)

HXLDModPara HXLDModPara.ReplaceObj(HXLDModPara objectsReplace, int index)

HXLDExtPara HXLDExtPara.ReplaceObj(HXLDExtPara objectsReplace, HTuple index)

HXLDExtPara HXLDExtPara.ReplaceObj(HXLDExtPara objectsReplace, int index)

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

Description

replace_objreplace_objReplaceObjReplaceObjreplace_obj replaces one or more elements of the iconic input tuple ObjectsObjectsObjectsobjectsobjects and returns them with ReplacedReplacedReplacedreplacedreplaced. At this, IndexIndexIndexindexindex determines the indices of the elements and ObjectsReplaceObjectsReplaceObjectsReplaceobjectsReplaceobjects_replace the corresponding objects to replace. The parameter IndexIndexIndexindexindex must contain one or more integer values (any floating point number must represent an integer value without fraction). Indices of iconic object elements start at 1. If ObjectsReplaceObjectsReplaceObjectsReplaceobjectsReplaceobjects_replace contains only one value, this value will be replaced at all indices of IndexIndexIndexindexindex. If a value of IndexIndexIndexindexindex is greater than the length of the iconic input object tuple ObjectsObjectsObjectsobjectsobjects, ReplacedReplacedReplacedreplacedreplaced will be extended accordingly and initialized with empty regions.

Exception: Empty input object

If either IndexIndexIndexindexindex or ObjectsReplaceObjectsReplaceObjectsReplaceobjectsReplaceobjects_replace is empty and the other is not, an exception is raised. If both are empty, the output object tuple ReplacedReplacedReplacedreplacedreplaced corresponds to the input ObjectsObjectsObjectsobjectsobjects. If both are not empty, but the input ObjectsObjectsObjectsobjectsobjects is, the empty object will be extended as described above.

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

Iconic Input Object.

ObjectsReplaceObjectsReplaceObjectsReplaceobjectsReplaceobjects_replace (input_object)  object(-array) objectHObjectHObjectHObjectHobject

Element(s) to replace.

ReplacedReplacedReplacedreplacedreplaced (output_object)  object(-array) objectHObjectHObjectHObjectHobject *

Tuple with replaced elements.

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

Index/Indices of elements to be replaced.

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
gen_empty_obj (Replace)

replace_obj (Images, Replace, Images, 1)

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