Blender V4.3
Public Member Functions | Public Attributes | Friends | List of all members
Light Class Reference

#include <DNA_light_types.h>

Inherits Node.

Public Member Functions

 Light ()
 NODE_SOCKET_API (uint64_t, light_set_membership)
 NODE_SOCKET_API (uint64_t, shadow_set_membership)
void tag_update (Scene *scene)
bool has_contribution (Scene *scene)
bool has_light_linking () const
bool has_shadow_linking () const
float3 get_co () const
float3 get_dir () const
float3 get_axisu () const
float3 get_axisv () const
Public Member Functions inherited from Node
 Node (const NodeType *type, ustring name=ustring())
virtual ~Node ()=0
void set (const SocketType &input, bool value)
void set (const SocketType &input, int value)
void set (const SocketType &input, uint value)
void set (const SocketType &input, uint64_t value)
void set (const SocketType &input, float value)
void set (const SocketType &input, float2 value)
void set (const SocketType &input, float3 value)
void set (const SocketType &input, const char *value)
void set (const SocketType &input, ustring value)
void set (const SocketType &input, const Transform &value)
void set (const SocketType &input, Node *value)
template<class ValueType, std::enable_if_t< std::is_enum_v< ValueType >, bool > = true>
void set (const SocketType &input, const ValueType &value)
void set (const SocketType &input, array< bool > &value)
void set (const SocketType &input, array< int > &value)
void set (const SocketType &input, array< float > &value)
void set (const SocketType &input, array< float2 > &value)
void set (const SocketType &input, array< float3 > &value)
void set (const SocketType &input, array< ustring > &value)
void set (const SocketType &input, array< Transform > &value)
void set (const SocketType &input, array< Node * > &value)
bool get_bool (const SocketType &input) const
int get_int (const SocketType &input) const
uint get_uint (const SocketType &input) const
uint64_t get_uint64 (const SocketType &input) const
float get_float (const SocketType &input) const
float2 get_float2 (const SocketType &input) const
float3 get_float3 (const SocketType &input) const
ustring get_string (const SocketType &input) const
Transform get_transform (const SocketType &input) const
Node * get_node (const SocketType &input) const
const array< bool > & get_bool_array (const SocketType &input) const
const array< int > & get_int_array (const SocketType &input) const
const array< float > & get_float_array (const SocketType &input) const
const array< float2 > & get_float2_array (const SocketType &input) const
const array< float3 > & get_float3_array (const SocketType &input) const
const array< ustring > & get_string_array (const SocketType &input) const
const array< Transform > & get_transform_array (const SocketType &input) const
const array< Node * > & get_node_array (const SocketType &input) const
bool has_default_value (const SocketType &input) const
void set_default_value (const SocketType &input)
bool equals_value (const Node &other, const SocketType &input) const
void copy_value (const SocketType &input, const Node &other, const SocketType &other_input)
void set_value (const SocketType &input, const Node &other, const SocketType &other_input)
bool equals (const Node &other) const
void hash (MD5Hash &md5)
size_t get_total_size_in_bytes () const
bool is_a (const NodeType *type)
bool socket_is_modified (const SocketType &input) const
bool is_modified () const
void tag_modified ()
void clear_modified ()
void print_modified_sockets () const
const NodeOwner * get_owner () const
void set_owner (const NodeOwner *owner_)
int reference_count () const
void reference ()
void dereference ()
void clear_reference_count ()

Public Attributes

ID id
struct AnimData * adt
short type
short flag
int mode
float r
float g
float b
float energy
float radius
float spotsize
float spotblend
short area_shape
short _pad1
float area_size
float area_sizey
float area_sizez
float area_spread
float sun_angle
short pr_texture
short use_nodes
float clipsta
float clipend_deprecated
float cascade_max_dist
float cascade_exponent
float cascade_fade
int cascade_count
float diff_fac
float spec_fac
float transmission_fac
float volume_fac
float att_dist
float shadow_filter_radius
float shadow_maximum_resolution
float shadow_jitter_overblur
struct PreviewImage * preview
struct bNodeTree * nodetree
struct Ipo *ipo DNA_DEPRECATED
float energy_deprecated DNA_DEPRECATED
float _pad2
 NODE_DECLARE
Public Attributes inherited from Node
ustring name
const NodeType * type
InternalNode internal
LeafNode leaf

Friends

class LightManager
class LightTree

Additional Inherited Members

Protected Member Functions inherited from Node
template<typename T>
void set_if_different (const SocketType &input, T value)
void set_if_different (const SocketType &input, Node *value)
template<typename T>
void set_if_different (const SocketType &input, array< T > &value)
void set_if_different (const SocketType &input, array< Node * > &value)
void dereference_all_used_nodes ()
Static Protected Member Functions inherited from Node
template<typename T>
static T & get_socket_value (const Node *node, const SocketType &socket)
Protected Attributes inherited from Node
const NodeOwner * owner
int ref_count {0}
SocketModifiedFlags socket_modified

Detailed Description

Definition at line 22 of file DNA_light_types.h.

Constructor & Destructor Documentation

◆ Light()

Light::Light ( )

Definition at line 147 of file scene/light.cpp.

References Node::dereference_all_used_nodes(), and Node::Node().

Member Function Documentation

◆ get_axisu()

float3 Light::get_axisu ( ) const

Definition at line 203 of file scene/light.cpp.

References transform_get_column().

Referenced by LightManager::device_update_lights(), LightTreeEmitter::LightTreeEmitter(), and NODE_SOCKET_API().

◆ get_axisv()

float3 Light::get_axisv ( ) const

Definition at line 208 of file scene/light.cpp.

References transform_get_column().

Referenced by LightManager::device_update_lights(), LightTreeEmitter::LightTreeEmitter(), and NODE_SOCKET_API().

◆ get_co()

float3 Light::get_co ( ) const

Definition at line 193 of file scene/light.cpp.

References transform_get_column().

Referenced by LightManager::device_update_lights(), LightTreeEmitter::LightTreeEmitter(), and NODE_SOCKET_API().

◆ get_dir()

float3 Light::get_dir ( ) const

Definition at line 198 of file scene/light.cpp.

References transform_get_column().

Referenced by LightManager::device_update_lights(), LightTreeEmitter::LightTreeEmitter(), and NODE_SOCKET_API().

◆ has_contribution()

bool Light::has_contribution ( Scene * scene)

Definition at line 159 of file scene/light.cpp.

References Scene::default_light, Shader::emission_estimate, is_zero(), LIGHT_BACKGROUND, and zero_float3().

Referenced by NODE_SOCKET_API(), and LightManager::test_enabled_lights().

◆ has_light_linking()

bool Light::has_light_linking ( ) const

Definition at line 175 of file scene/light.cpp.

References LIGHT_LINK_MASK_ALL.

Referenced by NODE_SOCKET_API(), and Scene::update_kernel_features().

◆ has_shadow_linking()

bool Light::has_shadow_linking ( ) const

Definition at line 184 of file scene/light.cpp.

References LIGHT_LINK_MASK_ALL.

Referenced by NODE_SOCKET_API(), and Scene::update_kernel_features().

◆ NODE_SOCKET_API() [1/2]

Light::NODE_SOCKET_API ( uint64_t ,
light_set_membership  )

References NODE_SOCKET_API().

Referenced by NODE_SOCKET_API(), and NODE_SOCKET_API().

◆ NODE_SOCKET_API() [2/2]

Light::NODE_SOCKET_API ( uint64_t ,
shadow_set_membership  )

References get_axisu(), get_axisv(), get_co(), get_dir(), has_contribution(), has_light_linking(), has_shadow_linking(), NODE_SOCKET_API(), normalize(), and tag_update().

◆ tag_update()

void Light::tag_update ( Scene * scene)

Definition at line 152 of file scene/light.cpp.

References Node::is_modified(), Scene::light_manager, LightManager::LIGHT_MODIFIED, and LightManager::tag_update().

Referenced by NODE_SOCKET_API().

◆ LightManager

friend class LightManager
friend

Definition at line 95 of file scene/light.h.

References LightManager.

Referenced by LightManager.

◆ LightTree

friend class LightTree
friend

Definition at line 96 of file scene/light.h.

References LightTree.

Referenced by LightTree.

Member Data Documentation

◆ _pad1

short Light::_pad1

Definition at line 46 of file DNA_light_types.h.

◆ _pad2

float Light::_pad2

Definition at line 86 of file DNA_light_types.h.

◆ adt

struct AnimData* Light::adt

Animation data (must be immediately after id for utilities to use it).

Definition at line 27 of file DNA_light_types.h.

Referenced by acf_dslight_setting_ptr(), bc_getSceneLightAnimData(), make_new_animlistelem(), and AnimationImporter::translate_Animations().

◆ area_shape

short Light::area_shape

Definition at line 45 of file DNA_light_types.h.

Referenced by blender::ed::object::apply_objects_internal(), blender::io::usd::USDLightWriter::do_write(), gizmo_area_light_prop_matrix_get(), gizmo_area_light_prop_matrix_set(), blender::io::hydra::LightData::init(), OVERLAY_light_cache_populate(), blender::io::hydra::LightData::prim_type(), blender::io::usd::USDLightReader::read_object_data(), WIDGETGROUP_light_area_refresh(), and DocumentImporter::writeLight().

◆ area_size

float Light::area_size

Definition at line 47 of file DNA_light_types.h.

Referenced by blender::ed::object::apply_objects_internal(), BKE_object_obdata_size_init(), blender::io::usd::USDLightWriter::do_write(), gizmo_area_light_prop_matrix_get(), gizmo_area_light_prop_matrix_set(), blender::io::hydra::LightData::init(), OVERLAY_light_cache_populate(), blender::io::usd::USDLightReader::read_object_data(), and DocumentImporter::writeLight().

◆ area_sizey

float Light::area_sizey

Definition at line 48 of file DNA_light_types.h.

Referenced by blender::ed::object::apply_objects_internal(), BKE_object_obdata_size_init(), blender::io::usd::USDLightWriter::do_write(), gizmo_area_light_prop_matrix_get(), gizmo_area_light_prop_matrix_set(), blender::io::hydra::LightData::init(), OVERLAY_light_cache_populate(), blender::io::usd::USDLightReader::read_object_data(), and DocumentImporter::writeLight().

◆ area_sizez

float Light::area_sizez

Definition at line 49 of file DNA_light_types.h.

Referenced by blender::ed::object::apply_objects_internal(), BKE_object_obdata_size_init(), and DocumentImporter::writeLight().

◆ area_spread

float Light::area_spread

Definition at line 50 of file DNA_light_types.h.

◆ att_dist

float Light::att_dist

Definition at line 72 of file DNA_light_types.h.

Referenced by OVERLAY_light_cache_populate(), and DocumentImporter::writeLight().

◆ b

float Light::b

Definition at line 34 of file DNA_light_types.h.

Referenced by blender::eevee::LightModule::begin_sync(), blender::io::usd::USDLightWriter::do_write(), blender::io::hydra::LightData::init(), LightsExporter::operator()(), blender::io::usd::USDLightReader::read_object_data(), and DocumentImporter::writeLight().

◆ cascade_count

int Light::cascade_count

Definition at line 65 of file DNA_light_types.h.

◆ cascade_exponent

float Light::cascade_exponent

Definition at line 63 of file DNA_light_types.h.

◆ cascade_fade

float Light::cascade_fade

Definition at line 64 of file DNA_light_types.h.

◆ cascade_max_dist

float Light::cascade_max_dist

Definition at line 62 of file DNA_light_types.h.

◆ clipend_deprecated

float Light::clipend_deprecated

Definition at line 60 of file DNA_light_types.h.

◆ clipsta

float Light::clipsta

Definition at line 59 of file DNA_light_types.h.

Referenced by OVERLAY_light_cache_populate(), and DocumentImporter::writeLight().

◆ diff_fac

float Light::diff_fac

Definition at line 67 of file DNA_light_types.h.

Referenced by blender::io::usd::USDLightWriter::do_write(), blender::io::hydra::LightData::init(), and blender::io::usd::USDLightReader::read_object_data().

◆ DNA_DEPRECATED [1/2]

struct Ipo* ipo Light::DNA_DEPRECATED

Definition at line 84 of file DNA_light_types.h.

◆ DNA_DEPRECATED [2/2]

float energy_deprecated Light::DNA_DEPRECATED

Definition at line 85 of file DNA_light_types.h.

◆ energy

float Light::energy

Definition at line 35 of file DNA_light_types.h.

Referenced by blender::eevee::LightModule::begin_sync(), blender::io::usd::USDLightWriter::do_write(), gpencil_light_pool_populate(), blender::io::hydra::LightData::init(), light_blend_write(), blender::ed::object::object_light_add_exec(), LightsExporter::operator()(), blender::io::usd::USDLightReader::read_object_data(), and DocumentImporter::writeLight().

◆ flag

short Light::flag

Definition at line 30 of file DNA_light_types.h.

Referenced by acf_dslight_setting_ptr(), and DocumentImporter::writeLight().

◆ g

float Light::g

Definition at line 34 of file DNA_light_types.h.

Referenced by blender::eevee::LightModule::begin_sync(), blender::io::usd::USDLightWriter::do_write(), blender::io::hydra::LightData::init(), LightsExporter::operator()(), blender::io::usd::USDLightReader::read_object_data(), and DocumentImporter::writeLight().

◆ id

ID Light::id

Definition at line 25 of file DNA_light_types.h.

Referenced by animdata_filter_ds_obdata(), blender::ed::object::apply_objects_internal(), BKE_light_eval(), blender::deg::DepsgraphNodeBuilder::build_light(), blender::deg::DepsgraphRelationBuilder::build_light(), blender::deg::DepsgraphRelationBuilder::build_object_data_light(), do_versions_ipos_to_animato(), blender::io::usd::USDLightWriter::do_write(), gizmo_area_light_prop_matrix_set(), gizmo_light_radius_prop_matrix_set(), gizmo_spot_blend_prop_matrix_set(), image_walk_id_all_users(), lamp_changed(), light_blend_write(), light_copy_data(), light_free_data(), blender::bke::node_tree_iterator_step(), paste_mtex_exec(), AnimationImporter::translate_Animations(), blender::io::hydra::LightData::update(), and WIDGETGROUP_light_spot_refresh().

◆ mode

int Light::mode

Definition at line 31 of file DNA_light_types.h.

Referenced by blender::eevee::LightModule::begin_sync(), blo_do_versions_400(), OVERLAY_light_cache_populate(), and DocumentImporter::writeLight().

◆ NODE_DECLARE

Light::NODE_DECLARE

Definition at line 31 of file scene/light.h.

◆ nodetree

struct bNodeTree* Light::nodetree

Definition at line 81 of file DNA_light_types.h.

Referenced by animdata_filter_ds_obdata(), blender::deg::DepsgraphNodeBuilder::build_light(), blender::deg::DepsgraphRelationBuilder::build_light(), image_walk_id_all_users(), light_blend_write(), light_copy_data(), light_emission_node_to_energy(), light_foreach_id(), light_free_data(), and blender::bke::node_tree_iterator_step().

◆ pr_texture

short Light::pr_texture

Definition at line 56 of file DNA_light_types.h.

◆ preview

struct PreviewImage* Light::preview

Definition at line 78 of file DNA_light_types.h.

Referenced by light_blend_read_data(), light_blend_write(), light_copy_data(), and light_free_data().

◆ r

float Light::r

Definition at line 34 of file DNA_light_types.h.

Referenced by blender::eevee::LightModule::begin_sync(), blender::io::usd::USDLightWriter::do_write(), gpencil_light_pool_populate(), blender::io::hydra::LightData::init(), light_emission_unify(), LightsExporter::operator()(), OVERLAY_light_cache_populate(), blender::io::usd::USDLightReader::read_object_data(), and DocumentImporter::writeLight().

◆ radius

float Light::radius

Definition at line 38 of file DNA_light_types.h.

Referenced by BKE_object_obdata_size_init(), blender::io::usd::USDLightWriter::do_write(), gizmo_light_radius_prop_matrix_get(), blender::io::hydra::LightData::init(), OVERLAY_light_cache_populate(), blender::io::usd::USDLightReader::read_object_data(), and DocumentImporter::writeLight().

◆ shadow_filter_radius

float Light::shadow_filter_radius

Definition at line 73 of file DNA_light_types.h.

Referenced by blender::eevee::LightModule::begin_sync().

◆ shadow_jitter_overblur

float Light::shadow_jitter_overblur

Definition at line 75 of file DNA_light_types.h.

Referenced by blender::eevee::LightModule::begin_sync(), and blo_do_versions_400().

◆ shadow_maximum_resolution

float Light::shadow_maximum_resolution

Definition at line 74 of file DNA_light_types.h.

Referenced by blender::eevee::LightModule::begin_sync().

◆ spec_fac

float Light::spec_fac

Definition at line 68 of file DNA_light_types.h.

Referenced by blender::io::usd::USDLightWriter::do_write(), blender::io::hydra::LightData::init(), and blender::io::usd::USDLightReader::read_object_data().

◆ spotblend

float Light::spotblend

Definition at line 42 of file DNA_light_types.h.

Referenced by blender::io::usd::USDLightWriter::do_write(), gizmo_spot_blend_prop_matrix_get(), blender::io::hydra::LightData::init(), LightsExporter::operator()(), OVERLAY_light_cache_populate(), blender::io::usd::USDLightReader::read_object_data(), and DocumentImporter::writeLight().

◆ spotsize

float Light::spotsize

Definition at line 41 of file DNA_light_types.h.

Referenced by BKE_camera_params_from_object(), blender::io::usd::USDLightWriter::do_write(), gizmo_spot_blend_prop_matrix_get(), gizmo_spot_blend_prop_matrix_set(), blender::io::hydra::LightData::init(), LightsExporter::operator()(), OVERLAY_light_cache_populate(), blender::io::usd::USDLightReader::read_object_data(), WIDGETGROUP_light_spot_refresh(), WIDGETGROUP_light_target_draw_prepare(), and DocumentImporter::writeLight().

◆ sun_angle

float Light::sun_angle

Definition at line 53 of file DNA_light_types.h.

Referenced by blender::eevee::LightModule::begin_sync(), blender::io::usd::USDLightWriter::do_write(), blender::io::hydra::LightData::init(), and blender::io::usd::USDLightReader::read_object_data().

◆ transmission_fac

float Light::transmission_fac

Definition at line 69 of file DNA_light_types.h.

◆ type

short Light::type

Definition at line 30 of file DNA_light_types.h.

Referenced by blender::ed::object::apply_objects_internal(), blender::eevee::LightModule::begin_sync(), blender::io::usd::USDLightWriter::do_write(), gpencil_light_pool_populate(), blender::io::hydra::LightData::init(), light_blend_write(), light_emission_unify(), light_power_get(), lineart_main_try_generate_shadow_v3(), blender::ed::object::object_is_target_compat(), blender::ed::object::object_light_add_exec(), LightsExporter::operator()(), OVERLAY_light_cache_populate(), blender::io::hydra::LightData::prim_type(), blender::io::usd::USDLightReader::read_object_data(), blender::ed::object::select_grouped_lighttype(), blender::ed::outliner::tree_element_get_icon_from_id(), WIDGETGROUP_light_area_poll(), WIDGETGROUP_light_point_poll(), WIDGETGROUP_light_spot_poll(), WIDGETGROUP_light_target_draw_prepare(), WIDGETGROUP_light_target_poll(), and DocumentImporter::writeLight().

◆ use_nodes

short Light::use_nodes

Definition at line 56 of file DNA_light_types.h.

Referenced by image_walk_id_all_users(), light_emission_node_to_energy(), and light_emission_unify().

◆ volume_fac

float Light::volume_fac

Definition at line 70 of file DNA_light_types.h.

The documentation for this class was generated from the following files:
Generated on Sat Oct 4 2025 05:32:23 for Blender by  doxygen 1.14.0