add_scene_3d_light — Add a light source to a 3D scene.
add_scene_3d_light adds a new light source to the scene Scene3D and returns its index in LightIndex. The kind of the the light source must be specified in LightKind. For LightKind = 'point_light', LightPosition is interpreted as the position of the light source. For LightKind = 'directional_light', LightPosition is interpreted as the vector of the directional light source.
Currently only one light source is supported, such that add_scene_3d_light overwrites the existing light source. This may be changed in future versions.
If no light source is set, a point light source at [-100.0, -100.0, 0.0] is used.
Handle of the 3D scene.
Position of the new light source.
Default value: [-100.0,-100.0,0.0]
Type of the new light source.
Default value: 'point_light'
List of values: 'directional_light', 'point_light'
Index of the new light source in the 3D scene.
add_scene_3d_light returns 2 (H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.