set_scene_3d_light_paramT_set_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParamset_scene_3d_light_param (Operator)
Name
set_scene_3d_light_paramT_set_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParamset_scene_3d_light_param — Set parameters of a light in a 3D scene.
Signature
void SetScene3dLightParam(const HTuple& Scene3D, const HTuple& LightIndex, const HTuple& GenParamName, const HTuple& GenParamValue)
void HScene3D::SetScene3dLightParam(Hlong LightIndex, const HTuple& GenParamName, const HTuple& GenParamValue) const
void HScene3D::SetScene3dLightParam(Hlong LightIndex, const HString& GenParamName, const HString& GenParamValue) const
void HScene3D::SetScene3dLightParam(Hlong LightIndex, const char* GenParamName, const char* GenParamValue) const
void HScene3D::SetScene3dLightParam(Hlong LightIndex, const wchar_t* GenParamName, const wchar_t* GenParamValue) const
(Windows only)
Description
set_scene_3d_light_paramset_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParamSetScene3dLightParamset_scene_3d_light_param sets parameters of a light source in the
3D scene Scene3DScene3DScene3DScene3Dscene3Dscene_3d. The name and value of a parameter must be given
in GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. The following
parameters can be set:
- 'ambient'"ambient""ambient""ambient""ambient""ambient":
-
Ambient part of the light source. Must be given as a tuple of
three numbers.
Default value: [0.2, 0.2, 0.2]
- 'diffuse'"diffuse""diffuse""diffuse""diffuse""diffuse":
-
Diffuse part of the light source. Must be given as a tuple of
three numbers.
Default value: [0.8, 0.8, 0.8]
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
Scene3DScene3DScene3DScene3Dscene3Dscene_3d (input_control) scene_3d → HScene3D, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the 3D scene.
LightIndexLightIndexLightIndexLightIndexlightIndexlight_index (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Index of the light source.
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Names of the generic parameters.
Default value:
'ambient'
"ambient"
"ambient"
"ambient"
"ambient"
"ambient"
List of values: 'ambient'"ambient""ambient""ambient""ambient""ambient", 'diffuse'"diffuse""diffuse""diffuse""diffuse""diffuse"
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) string(-array) → HTupleMaybeSequence[Union[str, int, float]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)
Values of the generic parameters.
Default value: [0.2,0.2,0.2]
Suggested values: [0.2,0.2,0.2]
Result
set_scene_3d_light_paramset_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParamSetScene3dLightParamset_scene_3d_light_param returns 2 (H_MSG_TRUE) if all parameters are
correct. If necessary, an exception is raised.
Possible Predecessors
add_scene_3d_instanceadd_scene_3d_instanceAddScene3dInstanceAddScene3dInstanceAddScene3dInstanceadd_scene_3d_instance
Module
3D Metrology