Cycles API: encapsulate Node socket members

This encapsulates Node socket members behind a set of specific methods;
as such it is no longer possible to directly access Node class members
from exporters and parts of Cycles.

The methods are defined via the NODE_SOCKET_API macros in `graph/
node.h`, and are for getting or setting a specific socket's value, as
well as querying or modifying the state of its update flag.

The setters will check whether the value has changed and tag the socket
as modified appropriately. This will let us know how a Node has changed
and what to update, which is the first concrete step toward a more
granular scene update system.

Since the setters will tag the Node sockets as modified when passed
different data, this patch also removes the various `modified` methods
on Nodes in favor of `Node::is_modified` which checks the sockets'
update flags status.

Reviewed By: brecht

Maniphest Tasks: T79174

Differential Revision: https://developer.blender.org/D8544

1 files changed, 47 insertions, 18 deletions

diff --git a/intern/cycles/render/film.cpp b/intern/cycles/render/film.cpp
index e4c1e452bd5..5c3778f6ae5 100644
--- a/intern/cycles/render/film.cpp
+++ b/intern/cycles/render/film.cpp
@@ -40,10 +40,8 @@ static bool compare_pass_order(const Pass &a, const Pass &b)
   return (a.components > b.components);
 }
 
-NODE_DEFINE(Pass)
+static NodeEnum *get_pass_type_enum()
 {
-  NodeType *type = NodeType::add("pass", create);
-
   static NodeEnum pass_type_enum;
   pass_type_enum.insert("combined", PASS_COMBINED);
   pass_type_enum.insert("depth", PASS_DEPTH);
@@ -84,7 +82,15 @@ NODE_DEFINE(Pass)
   pass_type_enum.insert("bake_primitive", PASS_BAKE_PRIMITIVE);
   pass_type_enum.insert("bake_differential", PASS_BAKE_DIFFERENTIAL);
 
-  SOCKET_ENUM(type, "Type", pass_type_enum, PASS_COMBINED);
+  return &pass_type_enum;
+}
+
+NODE_DEFINE(Pass)
+{
+  NodeType *type = NodeType::add("pass", create);
+
+  NodeEnum *pass_type_enum = get_pass_type_enum();
+  SOCKET_ENUM(type, "Type", *pass_type_enum, PASS_COMBINED);
   SOCKET_STRING(name, "Name", ustring());
 
   return type;
@@ -383,6 +389,21 @@ NODE_DEFINE(Film)
   SOCKET_INT(denoising_flags, "Denoising Flags", 0);
   SOCKET_BOOLEAN(use_adaptive_sampling, "Use Adaptive Sampling", false);
 
+  SOCKET_BOOLEAN(use_light_visibility, "Use Light Visibility", false);
+
+  NodeEnum *pass_type_enum = get_pass_type_enum();
+  SOCKET_ENUM(display_pass, "Display Pass", *pass_type_enum, PASS_COMBINED);
+
+  static NodeEnum cryptomatte_passes_enum;
+  cryptomatte_passes_enum.insert("none", CRYPT_NONE);
+  cryptomatte_passes_enum.insert("object", CRYPT_OBJECT);
+  cryptomatte_passes_enum.insert("material", CRYPT_MATERIAL);
+  cryptomatte_passes_enum.insert("asset", CRYPT_ASSET);
+  cryptomatte_passes_enum.insert("accurate", CRYPT_ACCURATE);
+  SOCKET_ENUM(cryptomatte_passes, "Cryptomatte Passes", cryptomatte_passes_enum, CRYPT_NONE);
+
+  SOCKET_INT(cryptomatte_depth, "Cryptomatte Depth", 0);
+
   return type;
 }
 
@@ -392,8 +413,6 @@ Film::Film() : Node(node_type)
   filter_table_offset = TABLE_OFFSET_INVALID;
   cryptomatte_passes = CRYPT_NONE;
   display_pass = PASS_COMBINED;
-
-  need_update = true;
 }
 
 Film::~Film()
@@ -407,7 +426,7 @@ void Film::add_default(Scene *scene)
 
 void Film::device_update(Device *device, DeviceScene *dscene, Scene *scene)
 {
-  if (!need_update)
+  if (!is_modified())
     return;
 
   scoped_callback_timer timer([scene](double time) {
@@ -658,7 +677,7 @@ void Film::device_update(Device *device, DeviceScene *dscene, Scene *scene)
   denoising_data_offset = kfilm->pass_denoising_data;
   denoising_clean_offset = kfilm->pass_denoising_clean;
 
-  need_update = false;
+  clear_modified();
 }
 
 void Film::device_free(Device * /*device*/, DeviceScene * /*dscene*/, Scene *scene)
@@ -666,11 +685,6 @@ void Film::device_free(Device * /*device*/, DeviceScene * /*dscene*/, Scene *sce
   scene->lookup_tables->remove_table(&filter_table_offset);
 }
 
-bool Film::modified(const Film &film)
-{
-  return !Node::equals(film);
-}
-
 void Film::tag_passes_update(Scene *scene, const vector<Pass> &passes_, bool update_passes)
 {
   if (Pass::contains(scene->passes, PASS_UV) != Pass::contains(passes_, PASS_UV)) {
@@ -691,11 +705,6 @@ void Film::tag_passes_update(Scene *scene, const vector<Pass> &passes_, bool upd
   }
 }
 
-void Film::tag_update(Scene * /*scene*/)
-{
-  need_update = true;
-}
-
 int Film::get_aov_offset(Scene *scene, string name, bool &is_color)
 {
   int num_color = 0, num_value = 0;
@@ -719,4 +728,24 @@ int Film::get_aov_offset(Scene *scene, string name, bool &is_color)
   return -1;
 }
 
+int Film::get_pass_stride() const
+{
+  return pass_stride;
+}
+
+int Film::get_denoising_data_offset() const
+{
+  return denoising_data_offset;
+}
+
+int Film::get_denoising_clean_offset() const
+{
+  return denoising_clean_offset;
+}
+
+size_t Film::get_filter_table_offset() const
+{
+  return filter_table_offset;
+}
+
 CCL_NAMESPACE_END