Operator Reference

HALCON Operator Reference / Graphics / 3D Scene

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

set_scene_3d_light_paramT_set_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParamset_scene_3d_light_param (Operator)

set_scene_3d_light_paramT_set_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParamset_scene_3d_light_param — Set parameters of a light in a 3D scene.

Signature

set_scene_3d_light_param( : : Scene3D, LightIndex, GenParamName, GenParamValue : )

Herror T_set_scene_3d_light_param(const Htuple Scene3D, const Htuple LightIndex, const Htuple GenParamName, const Htuple GenParamValue)

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)

static void HOperatorSet.SetScene3dLightParam(HTuple scene3D, HTuple lightIndex, HTuple genParamName, HTuple genParamValue)

void HScene3D.SetScene3dLightParam(int lightIndex, HTuple genParamName, HTuple genParamValue)

void HScene3D.SetScene3dLightParam(int lightIndex, string genParamName, string genParamValue)

def set_scene_3d_light_param(scene_3d: HHandle, light_index: int, gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[Union[str, int, float]]) -> None

Description

set_scene_3d_light_paramset_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParamset_scene_3d_light_param sets parameters of a light source in the 3D scene Scene3DScene3DScene3Dscene3Dscene_3d. The name and value of a parameter must be given in GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. The following parameters can be set:

'ambient'"ambient""ambient""ambient""ambient":

Ambient part of the light source. Must be given as a tuple of three numbers.

Default: [0.2, 0.2, 0.2].

'diffuse'"diffuse""diffuse""diffuse""diffuse":

Diffuse part of the light source. Must be given as a tuple of three numbers.

Default: [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

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)

Index of the light source.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the generic parameters.

Default: 'ambient' "ambient" "ambient" "ambient" "ambient"

List of values: 'ambient'"ambient""ambient""ambient""ambient", 'diffuse'"diffuse""diffuse""diffuse""diffuse"

GenParamValueGenParamValueGenParamValuegenParamValuegen_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: [0.2,0.2,0.2]

Suggested values: [0.2,0.2,0.2]

Result

set_scene_3d_light_paramset_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParamset_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_instanceAddScene3dInstanceAddScene3dInstanceadd_scene_3d_instance

Module

3D Metrology

---

ClassesClasses | | Operators