remove_scene_3d_lightremove_scene_3d_lightRemoveScene3dLightRemoveScene3dLight (Operator)

Name

remove_scene_3d_lightremove_scene_3d_lightRemoveScene3dLightRemoveScene3dLight — Remove a light from a 3D scene.

Signature

remove_scene_3d_light( : : Scene3D, LightIndex : )

remove_scene_3d_lightremove_scene_3d_lightRemoveScene3dLightRemoveScene3dLightRemoveScene3dLight removes the light LightIndexLightIndexLightIndexLightIndexlightIndex from the 3D scene Scene3DScene3DScene3DScene3Dscene3D 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

Scene3DScene3DScene3DScene3Dscene3D (input_control) scene_3d → (integer)

Handle of the 3D scene.

LightIndexLightIndexLightIndexLightIndexlightIndex (input_control) integer → (integer)

Light to remove.

Result

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

Module

3D Metrology

Operators