Operator Reference

HALCON Operator Reference / Graphics / 3D Scene
ClassesClasses | | Operators

remove_scene_3d_lightT_remove_scene_3d_lightRemoveScene3dLightRemoveScene3dLightremove_scene_3d_light (Operator)

remove_scene_3d_lightT_remove_scene_3d_lightRemoveScene3dLightRemoveScene3dLightremove_scene_3d_light — Remove a light from a 3D scene.

Signature

remove_scene_3d_light( : : Scene3D, LightIndex : )

Herror T_remove_scene_3d_light(const Htuple Scene3D, const Htuple LightIndex)

void RemoveScene3dLight(const HTuple& Scene3D, const HTuple& LightIndex)

void HScene3D::RemoveScene3dLight(Hlong LightIndex) const

static void HOperatorSet.RemoveScene3dLight(HTuple scene3D, HTuple lightIndex)

void HScene3D.RemoveScene3dLight(int lightIndex)

def remove_scene_3d_light(scene_3d: HHandle, light_index: int) -> None

Description

remove_scene_3d_lightremove_scene_3d_lightRemoveScene3dLightRemoveScene3dLightremove_scene_3d_light removes the light LightIndexLightIndexLightIndexlightIndexlight_index from the 3D scene Scene3DScene3DScene3Dscene3Dscene_3d in future versions. Currently only one light source is supported.

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.

LightIndexLightIndexLightIndexlightIndexlight_index (input_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Light to remove.

Result

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

See also

add_scene_3d_lightadd_scene_3d_lightAddScene3dLightAddScene3dLightadd_scene_3d_light

Module

3D Metrology

ClassesClasses | | Operators