Blender V5.3
Scene Class Reference

#include <scene.h>

Inherits NodeOwner.

Public Types

enum  MotionType { MOTION_NONE = 0 , MOTION_PASS , MOTION_BLUR , MOTION_PASS_INTERACTIVE }

Public Member Functions

 Scene (const SceneParams &params, Device *device)
 ~Scene () override
void device_update (Device *device, Progress &progress)
bool need_global_attribute (AttributeStandard std) const
void need_global_attributes (AttributeRequestSet &attributes)
MotionType need_motion () const
float motion_shutter_time ()
bool need_update ()
bool need_reset (const bool check_camera=true)
void reset ()
void device_free ()
void collect_statistics (RenderStats *stats)
void enable_update_stats ()
bool update (Progress &progress)
bool update_camera_resolution (Progress &progress, int width, int height)
bool has_shadow_catcher ()
void tag_shadow_catcher_modified ()
bool has_volume ()
bool has_volume_modified () const
void tag_has_volume_modified ()
bool use_light_mis () const
template<typename T, typename... Args>
T * create_node (Args &&...)=delete
template<typename T>
void delete_node (T *node)=delete
template<typename T>
void delete_nodes (const set< T * > &nodes)
template<typename T>
void delete_nodes (const set< T * > &nodes, const NodeOwner *owner)
template<class T>
T * create_light_node ()
template<>
PointLight * create_node ()
template<>
SpotLight * create_node ()
template<>
AreaLight * create_node ()
template<>
SunLight * create_node ()
template<>
BackgroundLight * create_node ()
template<>
Mesh * create_node ()
template<>
Hair * create_node ()
template<>
Volume * create_node ()
template<>
PointCloud * create_node ()
template<>
Object * create_node ()
template<>
ParticleSystem * create_node ()
template<>
Shader * create_node ()
template<>
Pass * create_node ()
template<>
Camera * create_node ()
template<>
Integrator * create_node ()
template<>
SceneAttributes * create_node ()
template<>
Background * create_node ()
template<>
Film * create_node ()
template<>
void delete_node (Light *node)
template<>
void delete_node (Mesh *node)
template<>
void delete_node (Hair *node)
template<>
void delete_node (Volume *node)
template<>
void delete_node (PointCloud *node)
template<>
void delete_node (Geometry *node)
template<>
void delete_node (Object *node)
template<>
void delete_node (ParticleSystem *node)
template<>
void delete_node (Shader *node)
template<>
void delete_node (Procedural *node)
template<>
void delete_node (Pass *node)
template<>
void delete_nodes (const set< Geometry * > &nodes, const NodeOwner *owner)
template<>
void delete_nodes (const set< Object * > &nodes, const NodeOwner *owner)
template<>
void delete_nodes (const set< ParticleSystem * > &nodes, const NodeOwner *owner)
template<>
void delete_nodes (const set< Shader * > &nodes, const NodeOwner *)
template<>
void delete_nodes (const set< Procedural * > &nodes, const NodeOwner *owner)
template<>
void delete_nodes (const set< Pass * > &nodes, const NodeOwner *owner)
template<>
PointLight * create_node ()
template<>
SpotLight * create_node ()
template<>
AreaLight * create_node ()
template<>
SunLight * create_node ()
template<>
BackgroundLight * create_node ()
template<>
Mesh * create_node ()
template<>
Object * create_node ()
template<>
Hair * create_node ()
template<>
Volume * create_node ()
template<>
PointCloud * create_node ()
template<>
ParticleSystem * create_node ()
template<>
Shader * create_node ()
template<>
Pass * create_node ()
template<>
Camera * create_node ()
template<>
Background * create_node ()
template<>
Film * create_node ()
template<>
Integrator * create_node ()
template<>
SceneAttributes * create_node ()
template<>
void delete_node (Light *node)
template<>
void delete_node (Mesh *node)
template<>
void delete_node (Volume *node)
template<>
void delete_node (PointCloud *node)
template<>
void delete_node (Hair *node)
template<>
void delete_node (Geometry *node)
template<>
void delete_node (Object *node)
template<>
void delete_node (ParticleSystem *node)
template<>
void delete_node (Shader *node)
template<>
void delete_node (Procedural *node)
template<>
void delete_node (Pass *node)
template<>
void delete_nodes (const set< Geometry * > &nodes, const NodeOwner *owner)
template<>
void delete_nodes (const set< Object * > &nodes, const NodeOwner *owner)
template<>
void delete_nodes (const set< ParticleSystem * > &nodes, const NodeOwner *owner)
template<>
void delete_nodes (const set< Shader * > &nodes, const NodeOwner *owner)
template<>
void delete_nodes (const set< Procedural * > &nodes, const NodeOwner *owner)
template<>
void delete_nodes (const set< Pass * > &nodes, const NodeOwner *owner)
Public Member Functions inherited from NodeOwner
virtual ~NodeOwner ()

Public Attributes

string name
map< ustring, int > lightgroups
unique_ptr< BVH > bvh
unique_ptr< LookupTables > lookup_tables
Camera * camera
Camera * dicing_camera
Film * film
Background * background
Integrator * integrator
SceneAttributes * scene_attribute
unique_ptr_vector< Background > backgrounds
unique_ptr_vector< Film > films
unique_ptr_vector< Integrator > integrators
unique_ptr_vector< SceneAttributes > scene_attributes
unique_ptr_vector< Camera > cameras
unique_ptr_vector< Shader > shaders
unique_ptr_vector< Pass > passes
unique_ptr_vector< ParticleSystem > particle_systems
unique_ptr_vector< Geometry > geometry
unique_ptr_vector< Object > objects
unique_ptr_vector< Procedural > procedurals
unique_ptr< ImageManager > image_manager
unique_ptr< LightManager > light_manager
unique_ptr< OSLManager > osl_manager
unique_ptr< ShaderManager > shader_manager
unique_ptr< GeometryManager > geometry_manager
unique_ptr< ObjectManager > object_manager
unique_ptr< ParticleSystemManager > particle_system_manager
unique_ptr< BakeManager > bake_manager
unique_ptr< ProceduralManager > procedural_manager
unique_ptr< VolumeManager > volume_manager
Shader * default_surface
Shader * default_volume
Shader * default_light
Shader * default_background
Shader * default_empty
Shader * default_gsplat
Device * device
DeviceScene dscene
SceneParams params
thread_mutex mutex
bool scene_updated_while_loading_kernels = false
unique_ptr< SceneUpdateStats > update_stats

Protected Member Functions

bool need_data_update ()
void free_memory (bool final)
void update_kernel_features ()
int get_max_closure_count ()
int get_volume_stack_size () const
bool load_kernels (Progress &progress)

Protected Attributes

bool kernels_loaded
uint64_t loaded_kernel_features
bool has_shadow_catcher_ = false
bool shadow_catcher_modified_ = true
bool has_volume_modified_ = true
int max_closure_global

Detailed Description

Member Enumeration Documentation

◆ MotionType

Enumerator
MOTION_NONE 
MOTION_PASS 
MOTION_BLUR 
MOTION_PASS_INTERACTIVE 

Definition at line 207 of file scene.h.

Constructor & Destructor Documentation

◆ Scene()

◆ ~Scene()

Scene::~Scene ( )
override

Definition at line 85 of file scene.cpp.

References free_memory().

Member Function Documentation

◆ collect_statistics()

void Scene::collect_statistics ( RenderStats * stats)

Definition at line 528 of file scene.cpp.

References geometry_manager, and image_manager.

◆ create_light_node()

template<class T>
template BackgroundLight * Scene::create_light_node< BackgroundLight > ( )

◆ create_node() [1/37]

template<>
Film * Scene::create_node ( )

Definition at line 1026 of file scene.cpp.

References films, node, and unique_ptr_vector< T >::push_back().

◆ create_node() [2/37]

template<>
Background * Scene::create_node ( )

Definition at line 1017 of file scene.cpp.

References backgrounds, node, and unique_ptr_vector< T >::push_back().

◆ create_node() [3/37]

template<>
SceneAttributes * Scene::create_node ( )

Definition at line 1008 of file scene.cpp.

References node, unique_ptr_vector< T >::push_back(), and scene_attributes.

◆ create_node() [4/37]

template<>
Integrator * Scene::create_node ( )

Definition at line 999 of file scene.cpp.

References integrators, node, and unique_ptr_vector< T >::push_back().

◆ create_node() [5/37]

template<>
Camera * Scene::create_node ( )

Definition at line 990 of file scene.cpp.

References cameras, node, and unique_ptr_vector< T >::push_back().

◆ create_node() [6/37]

template<>
Pass * Scene::create_node ( )

Definition at line 980 of file scene.cpp.

References film, node, passes, unique_ptr_vector< T >::push_back(), and Node::tag_modified().

◆ create_node() [7/37]

template<>
Shader * Scene::create_node ( )

◆ create_node() [8/37]

template<>
ParticleSystem * Scene::create_node ( )

◆ create_node() [9/37]

template<>
Object * Scene::create_node ( )

◆ create_node() [10/37]

template<>
PointCloud * Scene::create_node ( )

◆ create_node() [11/37]

template<>
Volume * Scene::create_node ( )

◆ create_node() [12/37]

template<>
Hair * Scene::create_node ( )

◆ create_node() [13/37]

template<>
Mesh * Scene::create_node ( )

◆ create_node() [14/37]

template<>
BackgroundLight * Scene::create_node ( )

Definition at line 905 of file scene.cpp.

References create_light_node().

◆ create_node() [15/37]

template<>
SunLight * Scene::create_node ( )

Definition at line 900 of file scene.cpp.

References create_light_node().

◆ create_node() [16/37]

template<>
AreaLight * Scene::create_node ( )

Definition at line 895 of file scene.cpp.

References create_light_node().

◆ create_node() [17/37]

template<>
SpotLight * Scene::create_node ( )

Definition at line 890 of file scene.cpp.

References create_light_node().

◆ create_node() [18/37]

template<>
PointLight * Scene::create_node ( )

Definition at line 885 of file scene.cpp.

References create_light_node().

◆ create_node() [19/37]

template<>
SceneAttributes * Scene::create_node ( )

◆ create_node() [20/37]

template<>
Integrator * Scene::create_node ( )

◆ create_node() [21/37]

template<>
Film * Scene::create_node ( )

◆ create_node() [22/37]

template<>
Background * Scene::create_node ( )

◆ create_node() [23/37]

template<>
Camera * Scene::create_node ( )

◆ create_node() [24/37]

template<>
Pass * Scene::create_node ( )

◆ create_node() [25/37]

template<>
Shader * Scene::create_node ( )

◆ create_node() [26/37]

template<>
ParticleSystem * Scene::create_node ( )

◆ create_node() [27/37]

template<>
PointCloud * Scene::create_node ( )

◆ create_node() [28/37]

template<>
Volume * Scene::create_node ( )

◆ create_node() [29/37]

template<>
Hair * Scene::create_node ( )

◆ create_node() [30/37]

template<>
Object * Scene::create_node ( )

◆ create_node() [31/37]

template<>
Mesh * Scene::create_node ( )

◆ create_node() [32/37]

template<>
BackgroundLight * Scene::create_node ( )

◆ create_node() [33/37]

template<>
SunLight * Scene::create_node ( )

◆ create_node() [34/37]

template<>
AreaLight * Scene::create_node ( )

◆ create_node() [35/37]

template<>
SpotLight * Scene::create_node ( )

◆ create_node() [36/37]

template<>
PointLight * Scene::create_node ( )

◆ create_node() [37/37]

◆ delete_node() [1/23]

◆ delete_node() [2/23]

template<>
void Scene::delete_node ( Geometry * node)

References node.

◆ delete_node() [3/23]

template<>
void Scene::delete_node ( Hair * node)

◆ delete_node() [4/23]

template<>
void Scene::delete_node ( Hair * node)

References node.

◆ delete_node() [5/23]

template<>
void Scene::delete_node ( Light * node)

◆ delete_node() [6/23]

template<>
void Scene::delete_node ( Light * node)

References node.

◆ delete_node() [7/23]

template<>
void Scene::delete_node ( Mesh * node)

◆ delete_node() [8/23]

template<>
void Scene::delete_node ( Mesh * node)

References node.

◆ delete_node() [9/23]

template<>
void Scene::delete_node ( Object * node)

◆ delete_node() [10/23]

template<>
void Scene::delete_node ( Object * node)

References node.

◆ delete_node() [11/23]

template<>
void Scene::delete_node ( ParticleSystem * node)

◆ delete_node() [12/23]

template<>
void Scene::delete_node ( ParticleSystem * node)

References node.

◆ delete_node() [13/23]

template<>
void Scene::delete_node ( Pass * node)

◆ delete_node() [14/23]

template<>
void Scene::delete_node ( Pass * node)

References node.

◆ delete_node() [15/23]

template<>
void Scene::delete_node ( PointCloud * node)

◆ delete_node() [16/23]

template<>
void Scene::delete_node ( PointCloud * node)

References node.

◆ delete_node() [17/23]

template<>
void Scene::delete_node ( Procedural * node)

◆ delete_node() [18/23]

template<>
void Scene::delete_node ( Procedural * node)

References node.

◆ delete_node() [19/23]

template<>
void Scene::delete_node ( Shader * node)

Definition at line 1109 of file scene.cpp.

References assert, and node.

◆ delete_node() [20/23]

template<>
void Scene::delete_node ( Shader * node)

References node.

◆ delete_node() [21/23]

template<typename T>
void Scene::delete_node ( T * node)
delete

References node, and T.

◆ delete_node() [22/23]

template<>
void Scene::delete_node ( Volume * node)

◆ delete_node() [23/23]

template<>
void Scene::delete_node ( Volume * node)

References node.

◆ delete_nodes() [1/14]

template<>
void Scene::delete_nodes ( const set< Geometry * > & nodes,
const NodeOwner * owner )

◆ delete_nodes() [2/14]

template<>
void Scene::delete_nodes ( const set< Geometry * > & nodes,
const NodeOwner * owner )

◆ delete_nodes() [3/14]

template<>
void Scene::delete_nodes ( const set< Object * > & nodes,
const NodeOwner * owner )

◆ delete_nodes() [4/14]

template<>
void Scene::delete_nodes ( const set< Object * > & nodes,
const NodeOwner * owner )

◆ delete_nodes() [5/14]

template<>
void Scene::delete_nodes ( const set< ParticleSystem * > & nodes,
const NodeOwner * owner )

◆ delete_nodes() [6/14]

template<>
void Scene::delete_nodes ( const set< ParticleSystem * > & nodes,
const NodeOwner * owner )

◆ delete_nodes() [7/14]

template<>
void Scene::delete_nodes ( const set< Pass * > & nodes,
const NodeOwner * owner )

◆ delete_nodes() [8/14]

template<>
void Scene::delete_nodes ( const set< Pass * > & nodes,
const NodeOwner * owner )

References CCL_NAMESPACE_END.

◆ delete_nodes() [9/14]

template<>
void Scene::delete_nodes ( const set< Procedural * > & nodes,
const NodeOwner * owner )

◆ delete_nodes() [10/14]

template<>
void Scene::delete_nodes ( const set< Procedural * > & nodes,
const NodeOwner * owner )

◆ delete_nodes() [11/14]

template<>
void Scene::delete_nodes ( const set< Shader * > & nodes,
const NodeOwner *  )

Definition at line 1166 of file scene.cpp.

◆ delete_nodes() [12/14]

template<>
void Scene::delete_nodes ( const set< Shader * > & nodes,
const NodeOwner * owner )

◆ delete_nodes() [13/14]

template<typename T>
void Scene::delete_nodes ( const set< T * > & nodes)
inline

◆ delete_nodes() [14/14]

template<typename T>
void Scene::delete_nodes ( const set< T * > & nodes,
const NodeOwner * owner )

◆ device_free()

void Scene::device_free ( )

Definition at line 523 of file scene.cpp.

References free_memory().

◆ device_update()

◆ enable_update_stats()

void Scene::enable_update_stats ( )

Definition at line 534 of file scene.cpp.

References update_stats.

Referenced by BlenderSession::render().

◆ free_memory()

◆ get_max_closure_count()

int Scene::get_max_closure_count ( )
protected

◆ get_volume_stack_size()

int Scene::get_volume_stack_size ( ) const
protected

Definition at line 771 of file scene.cpp.

References LOG_DEBUG, MAX_VOLUME_STACK_SIZE, min, and objects.

Referenced by device_update().

◆ has_shadow_catcher()

bool Scene::has_shadow_catcher ( )

Definition at line 818 of file scene.cpp.

References has_shadow_catcher_, objects, and shadow_catcher_modified_.

Referenced by Integrator::device_update(), and Film::update_passes().

◆ has_volume()

bool Scene::has_volume ( )

Definition at line 843 of file scene.cpp.

References DeviceScene::data, dscene, and has_volume_modified_.

Referenced by Film::update_passes().

◆ has_volume_modified()

bool Scene::has_volume_modified ( ) const

Definition at line 849 of file scene.cpp.

References has_volume_modified_.

Referenced by Film::update_passes().

◆ load_kernels()

◆ motion_shutter_time()

float Scene::motion_shutter_time ( )

Definition at line 447 of file scene.cpp.

References camera, MOTION_PASS, MOTION_PASS_INTERACTIVE, and need_motion().

Referenced by sync_smoke_volume(), and sync_volume_object().

◆ need_data_update()

◆ need_global_attribute()

◆ need_global_attributes()

void Scene::need_global_attributes ( AttributeRequestSet & attributes)

◆ need_motion()

◆ need_reset()

bool Scene::need_reset ( const bool check_camera = true)

Definition at line 497 of file scene.cpp.

References camera, Node::is_modified(), and need_data_update().

Referenced by need_update(), and BlenderSession::synchronize().

◆ need_update()

bool Scene::need_update ( )

Definition at line 482 of file scene.cpp.

References film, Node::is_modified(), and need_reset().

Referenced by update(), and update_kernel_features().

◆ reset()

◆ tag_has_volume_modified()

void Scene::tag_has_volume_modified ( )

Definition at line 854 of file scene.cpp.

References has_volume_modified_.

Referenced by ShaderManager::device_update_pre().

◆ tag_shadow_catcher_modified()

void Scene::tag_shadow_catcher_modified ( )

Definition at line 838 of file scene.cpp.

References shadow_catcher_modified_.

Referenced by Object::tag_update().

◆ update()

bool Scene::update ( Progress & progress)

Definition at line 652 of file scene.cpp.

References device, device_update(), MEM_GUARDED_CALL, need_update(), and Progress::set_status().

◆ update_camera_resolution()

bool Scene::update_camera_resolution ( Progress & progress,
int width,
int height )

◆ update_kernel_features()

◆ use_light_mis()

bool Scene::use_light_mis ( ) const

Definition at line 859 of file scene.cpp.

References Light::is_traceable(), and objects.

Referenced by LightManager::device_update_lights().

Member Data Documentation

◆ background

◆ backgrounds

unique_ptr_vector<Background> Scene::backgrounds

Definition at line 153 of file scene.h.

Referenced by create_node(), and free_memory().

◆ bake_manager

◆ bvh

◆ camera

◆ cameras

unique_ptr_vector<Camera> Scene::cameras

Definition at line 157 of file scene.h.

Referenced by create_node(), and free_memory().

◆ default_background

◆ default_empty

Shader* Scene::default_empty

◆ default_gsplat

Shader* Scene::default_gsplat

◆ default_light

◆ default_surface

◆ default_volume

Shader* Scene::default_volume

Definition at line 179 of file scene.h.

Referenced by ShaderManager::add_default(), get_default_shader(), and Scene().

◆ device

◆ dicing_camera

Camera* Scene::dicing_camera

Definition at line 146 of file scene.h.

Referenced by GeometryManager::device_update(), free_memory(), reset(), and Scene().

◆ dscene

◆ film

◆ films

unique_ptr_vector<Film> Scene::films

Definition at line 154 of file scene.h.

Referenced by create_node(), and free_memory().

◆ geometry

◆ geometry_manager

◆ has_shadow_catcher_

bool Scene::has_shadow_catcher_ = false
protected

Definition at line 275 of file scene.h.

Referenced by has_shadow_catcher().

◆ has_volume_modified_

bool Scene::has_volume_modified_ = true
protected

Definition at line 277 of file scene.h.

Referenced by has_volume(), has_volume_modified(), and tag_has_volume_modified().

◆ image_manager

◆ integrator

◆ integrators

unique_ptr_vector<Integrator> Scene::integrators

Definition at line 155 of file scene.h.

Referenced by create_node(), and free_memory().

◆ kernels_loaded

bool Scene::kernels_loaded
protected

Definition at line 270 of file scene.h.

Referenced by device_update(), load_kernels(), Scene(), and update_kernel_features().

◆ light_manager

◆ lightgroups

map<ustring, int> Scene::lightgroups

◆ loaded_kernel_features

uint64_t Scene::loaded_kernel_features
protected

Definition at line 271 of file scene.h.

Referenced by device_update(), and load_kernels().

◆ lookup_tables

◆ max_closure_global

int Scene::max_closure_global
protected

Definition at line 280 of file scene.h.

Referenced by get_max_closure_count(), and Scene().

◆ mutex

thread_mutex Scene::mutex

Definition at line 193 of file scene.h.

Referenced by device_update(), and BlenderSession::draw().

◆ name

string Scene::name

Definition at line 136 of file scene.h.

Referenced by BlenderSession::create_session(), and Scene().

◆ object_manager

◆ objects

◆ osl_manager

unique_ptr<OSLManager> Scene::osl_manager

◆ params

◆ particle_system_manager

◆ particle_systems

◆ passes

◆ procedural_manager

◆ procedurals

unique_ptr_vector<Procedural> Scene::procedurals

Definition at line 163 of file scene.h.

Referenced by delete_node(), delete_nodes(), free_memory(), and ProceduralManager::update().

◆ scene_attribute

SceneAttributes* Scene::scene_attribute

Definition at line 150 of file scene.h.

Referenced by device_update(), free_memory(), need_data_update(), reset(), and Scene().

◆ scene_attributes

unique_ptr_vector<SceneAttributes> Scene::scene_attributes

Definition at line 156 of file scene.h.

Referenced by create_node(), and free_memory().

◆ scene_updated_while_loading_kernels

bool Scene::scene_updated_while_loading_kernels = false

Definition at line 194 of file scene.h.

Referenced by device_update().

◆ shader_manager

◆ shaders

◆ shadow_catcher_modified_

bool Scene::shadow_catcher_modified_ = true
protected

Definition at line 276 of file scene.h.

Referenced by has_shadow_catcher(), and tag_shadow_catcher_modified().

◆ update_stats

◆ volume_manager


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