From d498afbf489eefbe3a2733a17d6f8ebe988abf79 Mon Sep 17 00:00:00 2001
From: Simone Barbieri <simone.barbieri@hey.com>
Date: Fri, 22 Sep 2023 15:24:17 +0100
Subject: [PATCH] New family ue_yeticache, new creator and extractor

---
 .../plugins/create/create_unreal_yeticache.py | 39 ++++++++++++
 .../plugins/publish/collect_yeti_cache.py     |  2 +-
 .../publish/extract_unreal_yeticache.py       | 62 +++++++++++++++++++
 .../plugins/publish/collect_resources_path.py |  3 +-
 openpype/plugins/publish/integrate.py         |  3 +-
 5 files changed, 106 insertions(+), 3 deletions(-)
 create mode 100644 openpype/hosts/maya/plugins/create/create_unreal_yeticache.py
 create mode 100644 openpype/hosts/maya/plugins/publish/extract_unreal_yeticache.py

diff --git a/openpype/hosts/maya/plugins/create/create_unreal_yeticache.py b/openpype/hosts/maya/plugins/create/create_unreal_yeticache.py
new file mode 100644
index 0000000000..8ff3dccea2
--- /dev/null
+++ b/openpype/hosts/maya/plugins/create/create_unreal_yeticache.py
@@ -0,0 +1,39 @@
+from openpype.hosts.maya.api import (
+    lib,
+    plugin
+)
+from openpype.lib import NumberDef
+
+
+class CreateYetiCache(plugin.MayaCreator):
+    """Output for procedural plugin nodes of Yeti """
+
+    identifier = "io.openpype.creators.maya.unrealyeticache"
+    label = "Unreal Yeti Cache"
+    family = "ue_yeticache"
+    icon = "pagelines"
+
+    def get_instance_attr_defs(self):
+
+        defs = [
+            NumberDef("preroll",
+                      label="Preroll",
+                      minimum=0,
+                      default=0,
+                      decimals=0)
+        ]
+
+        # Add animation data without step and handles
+        defs.extend(lib.collect_animation_defs())
+        remove = {"step", "handleStart", "handleEnd"}
+        defs = [attr_def for attr_def in defs if attr_def.key not in remove]
+
+        # Add samples after frame range
+        defs.append(
+            NumberDef("samples",
+                      label="Samples",
+                      default=3,
+                      decimals=0)
+        )
+
+        return defs
diff --git a/openpype/hosts/maya/plugins/publish/collect_yeti_cache.py b/openpype/hosts/maya/plugins/publish/collect_yeti_cache.py
index 4dcda29050..426e330f89 100644
--- a/openpype/hosts/maya/plugins/publish/collect_yeti_cache.py
+++ b/openpype/hosts/maya/plugins/publish/collect_yeti_cache.py
@@ -39,7 +39,7 @@ class CollectYetiCache(pyblish.api.InstancePlugin):
 
     order = pyblish.api.CollectorOrder + 0.45
     label = "Collect Yeti Cache"
-    families = ["yetiRig", "yeticache"]
+    families = ["yetiRig", "yeticache", "ue_yeticache"]
     hosts = ["maya"]
 
     def process(self, instance):
diff --git a/openpype/hosts/maya/plugins/publish/extract_unreal_yeticache.py b/openpype/hosts/maya/plugins/publish/extract_unreal_yeticache.py
new file mode 100644
index 0000000000..2279d52111
--- /dev/null
+++ b/openpype/hosts/maya/plugins/publish/extract_unreal_yeticache.py
@@ -0,0 +1,62 @@
+import os
+import json
+
+from maya import cmds
+
+from openpype.pipeline import publish
+
+
+class ExtractYetiCache(publish.Extractor):
+    """Producing Yeti cache files using scene time range.
+
+    This will extract Yeti cache file sequence and fur settings.
+    """
+
+    label = "Extract Yeti Cache"
+    hosts = ["maya"]
+    families = ["ue_yeticache"]
+
+    def process(self, instance):
+
+        yeti_nodes = cmds.ls(instance, type="pgYetiMaya")
+        if not yeti_nodes:
+            raise RuntimeError("No pgYetiMaya nodes found in the instance")
+
+        # Define extract output file path
+        dirname = self.staging_dir(instance)
+
+        # Collect information for writing cache
+        start_frame = instance.data["frameStartHandle"]
+        end_frame = instance.data["frameEndHandle"]
+        preroll = instance.data["preroll"]
+        if preroll > 0:
+            start_frame -= preroll
+
+        kwargs = {}
+        samples = instance.data.get("samples", 0)
+        if samples == 0:
+            kwargs.update({"sampleTimes": "0.0 1.0"})
+        else:
+            kwargs.update({"samples": samples})
+
+        self.log.debug(f"Writing out cache {start_frame} - {end_frame}")
+        filename = "{0}.abc".format(instance.name)
+        path = os.path.join(dirname, filename)
+        cmds.pgYetiCommand(yeti_nodes,
+                           writeAlembic=path,
+                           range=(start_frame, end_frame),
+                           asUnrealAbc=True,
+                           **kwargs)
+
+        if "representations" not in instance.data:
+            instance.data["representations"] = []
+
+        representation = {
+            'name': 'abc',
+            'ext': 'abc',
+            'files': filename,
+            'stagingDir': dirname
+        }
+        instance.data["representations"].append(representation)
+
+        self.log.debug(f"Extracted {instance} to {dirname}")
diff --git a/openpype/plugins/publish/collect_resources_path.py b/openpype/plugins/publish/collect_resources_path.py
index f96dd0ae18..6840509f79 100644
--- a/openpype/plugins/publish/collect_resources_path.py
+++ b/openpype/plugins/publish/collect_resources_path.py
@@ -62,7 +62,8 @@ class CollectResourcesPath(pyblish.api.InstancePlugin):
                 "effect",
                 "staticMesh",
                 "skeletalMesh",
-                "xgen"
+                "xgen",
+                "ue_yeticache"
                 ]
 
     def process(self, instance):
diff --git a/openpype/plugins/publish/integrate.py b/openpype/plugins/publish/integrate.py
index 7e48155b9e..24fbc0d8e7 100644
--- a/openpype/plugins/publish/integrate.py
+++ b/openpype/plugins/publish/integrate.py
@@ -139,7 +139,8 @@ class IntegrateAsset(pyblish.api.InstancePlugin):
                 "simpleUnrealTexture",
                 "online",
                 "uasset",
-                "blendScene"
+                "blendScene",
+                "ue_yeticache"
                 ]
 
     default_template_name = "publish"