Blender V5.3
PointLight Class Reference

#include <light.h>

Inherits Light.

Inherited by SpotLight.

Public Member Functions

 PointLight ()
 PointLight (const NodeType *node_type, const Geometry::Type type)
float area (const Transform &tfm) const override
void copy_to_kernel (KernelLight *klight, const Scene *scene, const Object *object) const override
bool is_traceable () const override
Public Member Functions inherited from Light
 Light (const NodeType *node_type, const Geometry::Type type)
void tag_update (Scene *scene)
bool has_contribution (const Scene *scene, const Object *object)
Shader * get_shader () const
void compute_bounds () override
void apply_transform (const Transform &tfm, const bool apply_to_motion) override
void get_uv_tiles (ustring map, unordered_set< int > &tiles) override
PrimitiveType primitive_type () const override
void copy_to_kernel (KernelLight *klight, const Scene *scene, const Object *object, const uint shader_flags) const
bool is_spot_light () const
bool is_point_light () const
bool is_area_light () const
bool is_sun_light () const
bool is_background_light () const
bool is_distant_light () const
virtual bool is_portal_light () const
Public Member Functions inherited from Geometry
const packed_float3 * get_position () const
packed_float3 * get_position_for_write ()
void tag_position_modified ()
bool position_is_modified () const
const float * get_radius () const
float * get_radius_for_write ()
void tag_radius_modified ()
bool radius_is_modified () const
 Geometry (const NodeType *node_type, const Type type)
 ~Geometry () override
virtual void clear (bool preserve_shaders=false)
bool need_attribute (const Scene *scene, AttributeStandard std)
bool need_attribute (Scene *scene, ustring name)
AttributeRequestSet needed_attributes ()
float motion_time (const int step) const
int motion_step (const float time) const
void compute_bvh (Device *device, DeviceScene *dscene, SceneParams *params, Progress *progress, const size_t n, size_t total)
bool need_build_bvh (BVHLayout layout) const
bool is_instanced () const
bool has_true_displacement () const
virtual bool has_motion_blur () const
bool has_voxel_attributes () const
bool is_mesh () const
bool is_hair () const
bool is_pointcloud () const
bool is_volume () const
bool is_light () const
void tag_update (Scene *scene, bool rebuild)
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, const int value)
void set (const SocketType &input, const uint value)
void set (const SocketType &input, const uint64_t value)
void set (const SocketType &input, const float value)
void set (const SocketType &input, const float2 value)
void set (const SocketType &input, const 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< packed_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< packed_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 &socket) const
void copy_value (const SocketType &socket, const Node &other, const SocketType &other_socket)
void set_value (const SocketType &socket, const Node &other, const SocketType &other_socket)
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

 NODE_DECLARE
Public Attributes inherited from Light
 NODE_ABSTRACT_DECLARE
Public Attributes inherited from Geometry
Type geometry_type
AttributeSet attributes
BoundBox bounds
bool transform_applied
bool transform_negative_scaled
Transform transform_normal
unique_ptr< BVH > bvh
size_t attr_map_offset
size_t prim_offset
bool has_volume
bool has_surface_bssrdf
bool need_update_rebuild
bool need_update_bvh_for_offset
size_t index
Public Attributes inherited from Node
ustring name
const NodeType * type
InternalNode internal
LeafNode leaf

Additional Inherited Members

Public Types inherited from Geometry
enum  Type {
  MESH , HAIR , VOLUME , POINTCLOUD ,
  AREA_LIGHT , BACKGROUND_LIGHT , POINT_LIGHT , SPOT_LIGHT ,
  SUN_LIGHT
}
Static Public Attributes inherited from Geometry
static const uint MAX_MOTION_STEPS = 129
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 89 of file scene/light.h.

Constructor & Destructor Documentation

◆ PointLight() [1/2]

PointLight::PointLight ( )

◆ PointLight() [2/2]

PointLight::PointLight ( const NodeType * node_type,
const Geometry::Type type )
inline

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

References Light::Light(), and Node::type.

Member Function Documentation

◆ area()

float PointLight::area ( const Transform & tfm) const
overridevirtual

Implements Light.

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

References area(), M_PI_F, and sqr.

Referenced by area(), and copy_to_kernel().

◆ copy_to_kernel()

void PointLight::copy_to_kernel ( KernelLight * klight,
const Scene * scene,
const Object * object ) const
overridevirtual

Implements Light.

Reimplemented in SpotLight.

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

References area(), KernelLight::co, Light::copy_to_kernel(), M_1_PI_F, normalize, SHADER_USE_MIS, and transform_get_translation().

Referenced by SpotLight::copy_to_kernel().

◆ is_traceable()

bool PointLight::is_traceable ( ) const
inlineoverridevirtual

Implements Light.

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

Member Data Documentation

◆ NODE_DECLARE

PointLight::NODE_DECLARE

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


The documentation for this class was generated from the following files: