HALCON Website / HALCON Operator Reference / Graphics / 3D Scene
ClassesClassesClassesClasses | | | | Operators

add_scene_3d_lightT_add_scene_3d_lightAddScene3dLightadd_scene_3d_lightAddScene3dLightAddScene3dLight (Operator)

Name

add_scene_3d_lightT_add_scene_3d_lightAddScene3dLightadd_scene_3d_lightAddScene3dLightAddScene3dLight — Add a light source to a 3D scene.

Signature

add_scene_3d_light( : : Scene3D, LightPosition, LightKind : LightIndex)

Herror T_add_scene_3d_light(const Htuple Scene3D, const Htuple LightPosition, const Htuple LightKind, Htuple* LightIndex)

Herror add_scene_3d_light(const HTuple& Scene3D, const HTuple& LightPosition, const HTuple& LightKind, Hlong* LightIndex)

Hlong HScene3D::AddScene3dLight(const HTuple& LightPosition, const HTuple& LightKind) const

void AddScene3dLight(const HTuple& Scene3D, const HTuple& LightPosition, const HTuple& LightKind, HTuple* LightIndex)

Hlong HScene3D::AddScene3dLight(const HTuple& LightPosition, const HString& LightKind) const

Hlong HScene3D::AddScene3dLight(const HTuple& LightPosition, const char* LightKind) const

void HOperatorSetX.AddScene3dLight(
[in] VARIANT Scene3D, [in] VARIANT LightPosition, [in] VARIANT LightKind, [out] VARIANT* LightIndex)

Hlong HScene3DX.AddScene3dLight(
[in] VARIANT LightPosition, [in] BSTR LightKind)

static void HOperatorSet.AddScene3dLight(HTuple scene3D, HTuple lightPosition, HTuple lightKind, out HTuple lightIndex)

int HScene3D.AddScene3dLight(HTuple lightPosition, string lightKind)

Description

add_scene_3d_lightadd_scene_3d_lightAddScene3dLightadd_scene_3d_lightAddScene3dLightAddScene3dLight adds a new light source to the scene Scene3DScene3DScene3DScene3DScene3Dscene3D and returns its index in LightIndexLightIndexLightIndexLightIndexLightIndexlightIndex. The kind of the the light source must be specified in LightKindLightKindLightKindLightKindLightKindlightKind. For LightKindLightKindLightKindLightKindLightKindlightKind = 'point_light'"point_light""point_light""point_light""point_light""point_light", LightPositionLightPositionLightPositionLightPositionLightPositionlightPosition is interpreted as the position of the light source. For LightKindLightKindLightKindLightKindLightKindlightKind = 'directional_light'"directional_light""directional_light""directional_light""directional_light""directional_light", LightPositionLightPositionLightPositionLightPositionLightPositionlightPosition is interpreted as the vector of the directional light source.

Currently only one light source is supported, such that add_scene_3d_lightadd_scene_3d_lightAddScene3dLightadd_scene_3d_lightAddScene3dLightAddScene3dLight 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.

Parallelization

Parameters

Scene3DScene3DScene3DScene3DScene3Dscene3D (input_control)  scene_3d → HScene3D, HTupleHTupleHScene3D, HTupleHScene3DX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the 3D scene.

LightPositionLightPositionLightPositionLightPositionLightPositionlightPosition (input_control)  real-array → HTupleHTupleHTupleVARIANTHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong) (double / Hlong) (double / Hlong)

Position of the new light source.

Default value: [-100.0,-100.0,0.0]

LightKindLightKindLightKindLightKindLightKindlightKind (input_control)  string → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Type of the new light source.

Default value: 'point_light' "point_light" "point_light" "point_light" "point_light" "point_light"

List of values: 'directional_light'"directional_light""directional_light""directional_light""directional_light""directional_light", 'point_light'"point_light""point_light""point_light""point_light""point_light"

LightIndexLightIndexLightIndexLightIndexLightIndexlightIndex (output_control)  integer → HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Index of the new light source in the 3D scene.

Result

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

Possible Predecessors

create_scene_3dcreate_scene_3dCreateScene3dcreate_scene_3dCreateScene3dCreateScene3d

Possible Successors

set_scene_3d_light_paramset_scene_3d_light_paramSetScene3dLightParamset_scene_3d_light_paramSetScene3dLightParamSetScene3dLightParam

See also

remove_scene_3d_lightremove_scene_3d_lightRemoveScene3dLightremove_scene_3d_lightRemoveScene3dLightRemoveScene3dLight

Module

3D Metrology

ClassesClassesClassesClasses | | | | Operators
HALCON Operator Reference 12.0.2 Copyright © 1996-2016 MVTec Software GmbH