Light

Inherits: VisualInstance < Spatial < Node < Object

Inherited By: SpotLight, OmniLight, DirectionalLight

Category: Core

Brief Description

Provides a base class for different kinds of light nodes.

Member Functions

int	get_bake_mode ( ) const
Color	get_color ( int color ) const
int	get_operator ( ) const
float	get_parameter ( int variable ) const
Texture	get_projector ( ) const
bool	has_project_shadows ( ) const
bool	is_editor_only ( ) const
bool	is_enabled ( ) const
void	set_bake_mode ( int bake_mode )
void	set_color ( int color, Color value )
void	set_editor_only ( bool editor_only )
void	set_enabled ( bool enabled )
void	set_operator ( int operator )
void	set_parameter ( int variable, float value )
void	set_project_shadows ( bool enable )
void	set_projector ( Texture projector )

Numeric Constants

• PARAM_RADIUS = 2
• PARAM_ENERGY = 3
• PARAM_ATTENUATION = 4
• PARAM_SPOT_ANGLE = 1
• PARAM_SPOT_ATTENUATION = 0
• PARAM_SHADOW_DARKENING = 5
• PARAM_SHADOW_Z_OFFSET = 6
• COLOR_DIFFUSE = 0
• COLOR_SPECULAR = 1
• BAKE_MODE_DISABLED = 0
• BAKE_MODE_INDIRECT = 1
• BAKE_MODE_INDIRECT_AND_SHADOWS = 2
• BAKE_MODE_FULL = 3

Description

Light is the abstract base class for light nodes, so it shouldn’t be used directly (It can’t be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting.

Member Function Description

int get_bake_mode ( ) const

Color get_color ( int color ) const

int get_operator ( ) const

float get_parameter ( int variable ) const

Texture get_projector ( ) const

bool has_project_shadows ( ) const

bool is_editor_only ( ) const

bool is_enabled ( ) const

void set_bake_mode ( int bake_mode )

void set_color ( int color, Color value )

void set_editor_only ( bool editor_only )

void set_enabled ( bool enabled )

void set_operator ( int operator )

void set_parameter ( int variable, float value )

void set_project_shadows ( bool enable )

void set_projector ( Texture projector )