Skip to content

remove_scene_3d_lightRemoveScene3dLightRemoveScene3dLightremove_scene_3d_lightT_remove_scene_3d_light🔗

Short description🔗

remove_scene_3d_lightRemoveScene3dLightRemoveScene3dLightremove_scene_3d_lightT_remove_scene_3d_light — Remove a light from a 3D scene.

Signature🔗

remove_scene_3d_light( scene_3d Scene3D, integer LightIndex )void RemoveScene3dLight( const HTuple& Scene3D, const HTuple& LightIndex )static void HOperatorSet.RemoveScene3dLight( HTuple scene3D, HTuple lightIndex )def remove_scene_3d_light( scene_3d: HHandle, light_index: int ) -> None

Herror T_remove_scene_3d_light( const Htuple Scene3D, const Htuple LightIndex )

void HScene3D::RemoveScene3dLight( Hlong LightIndex ) const

void HScene3D.RemoveScene3dLight( int lightIndex )

Description🔗

remove_scene_3d_lightRemoveScene3dLight removes the light LightIndexlightIndexlight_index from the 3D scene Scene3Dscene3Dscene_3d in future versions. Currently only one light source is supported.

Execution information🔗

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🔗

Scene3Dscene3Dscene_3d (input_control) scene_3d → (handle)HTuple (HHandle)HScene3D, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the 3D scene.

LightIndexlightIndexlight_index (input_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Light to remove.

Result🔗

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

Combinations with other operators🔗

Combinations

See also

add_scene_3d_lightAddScene3dLight

Module🔗

3D Metrology