Operator Reference

remove_scene_3d_labelT_remove_scene_3d_labelRemoveScene3dLabelRemoveScene3dLabelremove_scene_3d_label (Operator)

remove_scene_3d_labelT_remove_scene_3d_labelRemoveScene3dLabelRemoveScene3dLabelremove_scene_3d_label — Remove a text label from a 3D scene.

Signature

remove_scene_3d_label( : : Scene3D, LabelIndex : )

Herror T_remove_scene_3d_label(const Htuple Scene3D, const Htuple LabelIndex)

void RemoveScene3dLabel(const HTuple& Scene3D, const HTuple& LabelIndex)

void HScene3D::RemoveScene3dLabel(const HTuple& LabelIndex) const

void HScene3D::RemoveScene3dLabel(Hlong LabelIndex) const

static void HOperatorSet.RemoveScene3dLabel(HTuple scene3D, HTuple labelIndex)

void HScene3D.RemoveScene3dLabel(HTuple labelIndex)

void HScene3D.RemoveScene3dLabel(int labelIndex)

def remove_scene_3d_label(scene_3d: HHandle, label_index: MaybeSequence[int]) -> None

Description

remove_scene_3d_labelremove_scene_3d_labelRemoveScene3dLabelRemoveScene3dLabelremove_scene_3d_label removes the text label LabelIndexLabelIndexLabelIndexlabelIndexlabel_index from the 3D scene Scene3DScene3DScene3Dscene3Dscene_3d.

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

Scene3DScene3DScene3Dscene3Dscene_3d (input_control)  scene_3d HScene3D, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the 3D scene.

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

Index of the text label to remove.

Result

remove_scene_3d_labelremove_scene_3d_labelRemoveScene3dLabelRemoveScene3dLabelremove_scene_3d_label returns 2 ( H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

See also

add_scene_3d_labeladd_scene_3d_labelAddScene3dLabelAddScene3dLabeladd_scene_3d_label

Module

3D Metrology