Merge pull request #4943 from ynput/enhancement/OP-5548_Fusion-saver-settings

openpype/hosts/fusion/plugins/create/create_saver.py

@@ -1,3 +1,4 @@
+from copy import deepcopy
 import os
 
 from openpype.hosts.fusion.api import (
@@ -11,15 +12,13 @@ from openpype.lib import (
 )
 from openpype.pipeline import (
     legacy_io,
-    Creator,
+    Creator as NewCreator,
     CreatedInstance,
-)
-from openpype.client import (
-    get_asset_by_name,
+    Anatomy
 )
 
 
-class CreateSaver(Creator):
+class CreateSaver(NewCreator):
     identifier = "io.openpype.creators.fusion.saver"
     label = "Render (saver)"
     name = "render"
@@ -28,9 +27,24 @@ class CreateSaver(Creator):
     description = "Fusion Saver to generate image sequence"
     icon = "fa5.eye"
 
-    instance_attributes = ["reviewable"]
+    instance_attributes = [
+        "reviewable"
+    ]
+    default_variants = [
+        "Main",
+        "Mask"
+    ]
+
+    # TODO: This should be renamed together with Nuke so it is aligned
+    temp_rendering_path_template = (
+        "{workdir}/renders/fusion/{subset}/{subset}.{frame}.{ext}")
 
     def create(self, subset_name, instance_data, pre_create_data):
+        instance_data.update({
+            "id": "pyblish.avalon.instance",
+            "subset": subset_name
+        })
+
         # TODO: Add pre_create attributes to choose file format?
         file_format = "OpenEXRFormat"
 
@@ -39,7 +53,6 @@ class CreateSaver(Creator):
             args = (-32768, -32768)  # Magical position numbers
             saver = comp.AddTool("Saver", *args)
 
-            instance_data["subset"] = subset_name
             self._update_tool_with_data(saver, data=instance_data)
 
             saver["OutputFormat"] = file_format
@@ -78,7 +91,7 @@ class CreateSaver(Creator):
         for tool in tools:
             data = self.get_managed_tool_data(tool)
             if not data:
-                data = self._collect_unmanaged_saver(tool)
+                continue
 
             # Add instance
             created_instance = CreatedInstance.from_existing(data, self)
@@ -125,60 +138,35 @@ class CreateSaver(Creator):
         original_subset = tool.GetData("openpype.subset")
         subset = data["subset"]
         if original_subset != subset:
-            # Subset change detected
-            # Update output filepath
-            workdir = os.path.normpath(legacy_io.Session["AVALON_WORKDIR"])
-            filename = f"{subset}..exr"
-            filepath = os.path.join(workdir, "render", subset, filename)
-            tool["Clip"] = filepath
+            self._configure_saver_tool(data, tool, subset)
 
-            # Rename tool
-            if tool.Name != subset:
-                print(f"Renaming {tool.Name} -> {subset}")
-                tool.SetAttrs({"TOOLS_Name": subset})
+    def _configure_saver_tool(self, data, tool, subset):
+        formatting_data = deepcopy(data)
 
-    def _collect_unmanaged_saver(self, tool):
-        # TODO: this should not be done this way - this should actually
-        #       get the data as stored on the tool explicitly (however)
-        #       that would disallow any 'regular saver' to be collected
-        #       unless the instance data is stored on it to begin with
-
-        print("Collecting unmanaged saver..")
-        comp = tool.Comp()
-
-        # Allow regular non-managed savers to also be picked up
-        project = legacy_io.Session["AVALON_PROJECT"]
-        asset = legacy_io.Session["AVALON_ASSET"]
-        task = legacy_io.Session["AVALON_TASK"]
-
-        asset_doc = get_asset_by_name(project_name=project, asset_name=asset)
-
-        path = tool["Clip"][comp.TIME_UNDEFINED]
-        fname = os.path.basename(path)
-        fname, _ext = os.path.splitext(fname)
-        variant = fname.rstrip(".")
-        subset = self.get_subset_name(
-            variant=variant,
-            task_name=task,
-            asset_doc=asset_doc,
-            project_name=project,
+        # get frame padding from anatomy templates
+        anatomy = Anatomy()
+        frame_padding = int(
+            anatomy.templates["render"].get("frame_padding", 4)
         )
 
-        attrs = tool.GetAttrs()
-        passthrough = attrs["TOOLB_PassThrough"]
-        return {
-            # Required data
-            "project": project,
-            "asset": asset,
-            "subset": subset,
-            "task": task,
-            "variant": variant,
-            "active": not passthrough,
-            "family": self.family,
-            # Unique identifier for instance and this creator
-            "id": "pyblish.avalon.instance",
-            "creator_identifier": self.identifier,
-        }
+        # Subset change detected
+        workdir = os.path.normpath(legacy_io.Session["AVALON_WORKDIR"])
+        formatting_data.update({
+            "workdir": workdir,
+            "frame": "0" * frame_padding,
+            "ext": "exr"
+        })
+
+        # build file path to render
+        filepath = self.temp_rendering_path_template.format(
+            **formatting_data)
+
+        tool["Clip"] = os.path.normpath(filepath)
+
+        # Rename tool
+        if tool.Name != subset:
+            print(f"Renaming {tool.Name} -> {subset}")
+            tool.SetAttrs({"TOOLS_Name": subset})
 
     def get_managed_tool_data(self, tool):
         """Return data of the tool if it matches creator identifier"""
@@ -238,3 +226,25 @@ class CreateSaver(Creator):
             default=("reviewable" in self.instance_attributes),
             label="Review",
         )
+
+    def apply_settings(
+        self,
+        project_settings,
+        system_settings
+    ):
+        """Method called on initialization of plugin to apply settings."""
+
+        # plugin settings
+        plugin_settings = (
+            project_settings["fusion"]["create"][self.__class__.__name__]
+        )
+
+        # individual attributes
+        self.instance_attributes = plugin_settings.get(
+            "instance_attributes") or self.instance_attributes
+        self.default_variants = plugin_settings.get(
+            "default_variants") or self.default_variants
+        self.temp_rendering_path_template = (
+            plugin_settings.get("temp_rendering_path_template")
+            or self.temp_rendering_path_template
+        )

openpype/settings/defaults/project_settings/fusion.json

@@ -21,5 +21,18 @@
         "copy_path": "~/.openpype/hosts/fusion/profiles",
         "copy_status": false,
         "force_sync": false
+    },
+    "create": {
+        "CreateSaver": {
+            "temp_rendering_path_template": "{workdir}/renders/fusion/{subset}/{subset}.{frame}.{ext}",
+            "default_variants": [
+                "Main",
+                "Mask"
+            ],
+            "instance_attributes": [
+                "reviewable",
+                "farm_rendering"
+            ]
+        }
     }
 }

openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json

@@ -68,6 +68,50 @@
                     "label": "Resync profile on each launch"
                 }
             ]
+        },
+        {
+            "type": "dict",
+            "collapsible": true,
+            "key": "create",
+            "label": "Creator plugins",
+            "children": [
+                {
+                    "type": "dict",
+                    "collapsible": true,
+                    "key": "CreateSaver",
+                    "label": "Create Saver",
+                    "is_group": true,
+                    "children": [
+                        {
+                            "type": "text",
+                            "key": "temp_rendering_path_template",
+                            "label": "Temporary rendering path template"
+                        },
+                        {
+                            "type": "list",
+                            "key": "default_variants",
+                            "label": "Default variants",
+                            "object_type": {
+                                "type": "text"
+                            }
+                        },
+                        {
+                            "key": "instance_attributes",
+                            "label": "Instance attributes",
+                            "type": "enum",
+                            "multiselection": true,
+                            "enum_items": [
+                                {
+                                    "reviewable": "Reviewable"
+                                },
+                                {
+                                    "farm_rendering": "Farm rendering"
+                                }
+                            ]
+                        }
+                    ]
+                }
+            ]
         }
     ]
 }