DirectionalLight

Inherits: Light < VisualInstance < Spatial < Node < Object

Category: Core

Brief Description

Directional Light, such as the Sun or the Moon.

Member Functions

int get_shadow_mode ( ) const
float get_shadow_param ( int param ) const
void set_shadow_mode ( int mode )
void set_shadow_param ( int param, float value )

Numeric Constants

  • SHADOW_ORTHOGONAL = 0
  • SHADOW_PERSPECTIVE = 1
  • SHADOW_PARALLEL_2_SPLITS = 2
  • SHADOW_PARALLEL_4_SPLITS = 3
  • SHADOW_PARAM_MAX_DISTANCE = 0
  • SHADOW_PARAM_PSSM_SPLIT_WEIGHT = 1
  • SHADOW_PARAM_PSSM_ZOFFSET_SCALE = 2

Description

A DirectionalLight is a type of Light node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction.

Member Function Description

  • int get_shadow_mode ( ) const
  • float get_shadow_param ( int param ) const
  • void set_shadow_mode ( int mode )
  • void set_shadow_param ( int param, float value )