HALCON 18.05 / HALCON Operator Reference / Graphics / 3D Scene
ClassesClasses | | Operators

set_scene_3d_light_paramT_set_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParam (Operator)

Name

set_scene_3d_light_paramT_set_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParam — 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

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)

Description

set_scene_3d_light_paramset_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParamSetScene3dLightParam sets parameters of a light source in the 3D scene Scene3DScene3DScene3DScene3Dscene3D. The name and value of a parameter must be given in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName and GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. 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 value: [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 value: [0.8, 0.8, 0.8]

Execution Information

Parameters

Scene3DScene3DScene3DScene3Dscene3D (input_control)  scene_3d → HScene3D, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the 3D scene.

LightIndexLightIndexLightIndexLightIndexlightIndex (input_control)  integer → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Index of the light source.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  string(-array) → HTupleHTupleHtuple (string) (string) (HString) (char*)

Names of the generic parameters.

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

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

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (input_control)  string(-array) → HTupleHTupleHtuple (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_paramSetScene3dLightParamSetScene3dLightParamSetScene3dLightParam returns 2 (H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Possible Predecessors

add_scene_3d_instanceadd_scene_3d_instanceAddScene3dInstanceAddScene3dInstanceAddScene3dInstance

Module

3D Metrology

ClassesClasses | | Operators
HALCON Operator Reference 18.05 Copyright © 1996-2018 MVTec Software GmbH