Maya: Fix Maya Alembic Extractors

client/ayon_core/hosts/maya/api/alembic.py

@@ -22,7 +22,6 @@
     "melPostJobCallback": str,
     "noNormals": bool,
     "preRoll": bool,
-    "preRollStartFrame": int,
     "pythonPerFrameCallback": str,
     "pythonPostJobCallback": str,
     "renderableOnly": bool,
@@ -54,15 +53,22 @@ def extract_alembic(
     endFrame=None,
     eulerFilter=True,
     frameRange="",
+    melPerFrameCallback=None,
+    melPostJobCallback=None,
     noNormals=False,
     preRoll=False,
     preRollStartFrame=0,
+    pythonPerFrameCallback=None,
+    pythonPostJobCallback=None,
     renderableOnly=False,
     root=None,
     selection=True,
     startFrame=None,
     step=1.0,
     stripNamespaces=True,
+    userAttr=None,
+    userAttrPrefix=None,
+    uvsOnly=False,
     uvWrite=True,
     verbose=False,
     wholeFrameGeo=False,
@@ -102,6 +108,11 @@ def extract_alembic(
             string formatted as: "startFrame endFrame". This argument
             overrides `startFrame` and `endFrame` arguments.
 
+        melPerFrameCallback (Optional[str]): MEL callback run per frame.
+
+        melPostJobCallback (Optional[str]): MEL callback after last frame is
+            written.
+
         noNormals (bool): When on, normal data from the original polygon
             objects is not included in the exported Alembic cache file.
 
@@ -113,6 +124,11 @@ def extract_alembic(
             dependent translations and can be used to evaluate run-up that
             isn't actually translated. Defaults to 0.
 
+        pythonPerFrameCallback (Optional[str]): Python callback run per frame.
+
+        pythonPostJobCallback (Optional[str]): Python callback after last frame
+            is written.
+
         renderableOnly (bool): When on, any non-renderable nodes or hierarchy,
             such as hidden objects, are not included in the Alembic file.
             Defaults to False.
@@ -137,6 +153,15 @@ def extract_alembic(
             object with the namespace taco:foo:bar appears as bar in the
             Alembic file.
 
+        userAttr (list of str, optional): A specific user defined attribute to
+            write out. Defaults to [].
+
+        userAttrPrefix (list of str, optional): Prefix filter for determining
+            which user defined attributes to write out. Defaults to [].
+
+        uvsOnly (bool): When on, only uv data for PolyMesh and SubD shapes
+            will be written to the Alembic file.
+
         uvWrite (bool): When on, UV data from polygon meshes and subdivision
             objects are written to the Alembic file. Only the current UV map is
             included.
@@ -183,6 +208,8 @@ def extract_alembic(
     # Ensure list arguments are valid.
     attr = attr or []
     attrPrefix = attrPrefix or []
+    userAttr = userAttr or []
+    userAttrPrefix = userAttrPrefix or []
     root = root or []
 
     # Pass the start and end frame on as `frameRange` so that it
@@ -213,8 +240,10 @@ def extract_alembic(
         "eulerFilter": eulerFilter,
         "noNormals": noNormals,
         "preRoll": preRoll,
+        "root": root,
         "renderableOnly": renderableOnly,
         "uvWrite": uvWrite,
+        "uvsOnly": uvsOnly,
         "writeColorSets": writeColorSets,
         "writeFaceSets": writeFaceSets,
         "wholeFrameGeo": wholeFrameGeo,
@@ -226,9 +255,10 @@ def extract_alembic(
         "step": step,
         "attr": attr,
         "attrPrefix": attrPrefix,
+        "userAttr": userAttr,
+        "userAttrPrefix": userAttrPrefix,
         "stripNamespaces": stripNamespaces,
-        "verbose": verbose,
-        "preRollStartFrame": preRollStartFrame
+        "verbose": verbose
     }
 
     # Validate options
@@ -264,6 +294,17 @@ def extract_alembic(
     if maya_version >= 2018:
         options['autoSubd'] = options.pop('writeCreases', False)
 
+    # Only add callbacks if they are set so that we're not passing `None`
+    callbacks = {
+        "melPerFrameCallback": melPerFrameCallback,
+        "melPostJobCallback": melPostJobCallback,
+        "pythonPerFrameCallback": pythonPerFrameCallback,
+        "pythonPostJobCallback": pythonPostJobCallback,
+    }
+    for key, callback in callbacks.items():
+        if callback:
+            options[key] = str(callback)
+
     # Format the job string from options
     job_args = list()
     for key, value in options.items():
@@ -297,7 +338,11 @@ def extract_alembic(
     # exports are made. (PLN-31)
     # TODO: Make sure this actually fixes the issues
     with evaluation("off"):
-        cmds.AbcExport(j=job_str, verbose=verbose)
+        cmds.AbcExport(
+            j=job_str,
+            verbose=verbose,
+            preRollStartFrame=preRollStartFrame
+        )
 
     if verbose:
         log.debug("Extracted Alembic to: %s", file)

client/ayon_core/hosts/maya/plugins/publish/extract_pointcache.py

@@ -6,6 +6,7 @@
 from ayon_core.pipeline import publish
 from ayon_core.hosts.maya.api.alembic import extract_alembic
 from ayon_core.hosts.maya.api.lib import (
+    get_all_children,
     suspended_refresh,
     maintained_selection,
     iter_visible_nodes_in_range
@@ -40,7 +41,6 @@ class ExtractAlembic(publish.Extractor, AYONPyblishPluginMixin):
     # From settings
     attr = []
     attrPrefix = []
-    autoSubd = False
     bake_attributes = []
     bake_attribute_prefixes = []
     dataFormat = "ogawa"
@@ -63,6 +63,7 @@ class ExtractAlembic(publish.Extractor, AYONPyblishPluginMixin):
     wholeFrameGeo = False
     worldSpace = True
     writeColorSets = False
+    writeCreases = False
     writeFaceSets = False
     writeNormals = True
     writeUVSets = False
@@ -173,15 +174,9 @@ def process(self, instance):
             "writeVisibility": attribute_values.get(
                 "writeVisibility", self.writeVisibility
             ),
-            "autoSubd": attribute_values.get(
-                "autoSubd", self.autoSubd
-            ),
             "uvsOnly": attribute_values.get(
                 "uvsOnly", self.uvsOnly
             ),
-            "writeNormals": attribute_values.get(
-                "writeNormals", self.writeNormals
-            ),
             "melPerFrameCallback": attribute_values.get(
                 "melPerFrameCallback", self.melPerFrameCallback
             ),
@@ -193,7 +188,12 @@ def process(self, instance):
             ),
             "pythonPostJobCallback": attribute_values.get(
                 "pythonPostJobCallback", self.pythonPostJobCallback
-            )
+            ),
+            # Note that this converts `writeNormals` to `noNormals` for the
+            # `AbcExport` equivalent in `extract_alembic`
+            "noNormals": not attribute_values.get(
+                "writeNormals", self.writeNormals
+            ),
         }
 
         if instance.data.get("visibleOnly", False):
@@ -249,7 +249,6 @@ def process(self, instance):
             with maintained_selection():
                 cmds.select(instance.data["proxy"])
                 extract_alembic(**kwargs)
-
         representation = {
             "name": "proxy",
             "ext": "abc",
@@ -268,20 +267,6 @@ def get_attribute_defs(cls):
             return []
 
         override_defs = OrderedDict({
-            "autoSubd": BoolDef(
-                "autoSubd",
-                label="Auto Subd",
-                default=cls.autoSubd,
-                tooltip=(
-                    "If this flag is present and the mesh has crease edges, "
-                    "crease vertices or holes, the mesh (OPolyMesh) would now "
-                    "be written out as an OSubD and crease info will be stored"
-                    " in the Alembic  file. Otherwise, creases info won't be "
-                    "preserved in Alembic file unless a custom Boolean "
-                    "attribute SubDivisionMesh has been added to mesh node and"
-                    " its value is true."
-                )
-            ),
             "eulerFilter": BoolDef(
                 "eulerFilter",
                 label="Euler Filter",
@@ -354,6 +339,13 @@ def get_attribute_defs(cls):
                 default=cls.writeColorSets,
                 tooltip="Write vertex colors with the geometry."
             ),
+            "writeCreases": BoolDef(
+                "writeCreases",
+                label="Write Creases",
+                default=cls.writeCreases,
+                tooltip="Write the geometry's edge and vertex crease "
+                        "information."
+            ),
             "writeFaceSets": BoolDef(
                 "writeFaceSets",
                 label="Write Face Sets",
@@ -527,9 +519,7 @@ def get_members_and_roots(self, instance):
         roots = cmds.sets(out_set, query=True) or []
 
         # Include all descendants
-        nodes = roots
-        nodes += cmds.listRelatives(
-            roots, allDescendents=True, fullPath=True
-        ) or []
+        nodes = roots.copy()
+        nodes.extend(get_all_children(roots, ignore_intermediate_objects=True))
 
         return nodes, roots

client/ayon_core/hosts/maya/plugins/publish/validate_alembic_options_defaults.py

@@ -1,3 +1,4 @@
+import inspect
 import pyblish.api
 
 from ayon_core.pipeline import OptionalPyblishPluginMixin
@@ -29,29 +30,28 @@ def _get_settings(cls, context):
 
     @classmethod
     def _get_publish_attributes(cls, instance):
-        attributes = instance.data["publish_attributes"][
-            cls.plugin_name(
-                instance.data["publish_attributes"]
-            )
-        ]
-
-        return attributes
+        return instance.data["publish_attributes"][cls.plugin_name]
 
     def process(self, instance):
         if not self.is_active(instance.data):
             return
 
         settings = self._get_settings(instance.context)
-
         attributes = self._get_publish_attributes(instance)
 
-        msg = (
-            "Alembic Extract setting \"{}\" is not the default value:"
-            "\nCurrent: {}"
-            "\nDefault Value: {}\n"
-        )
-        errors = []
+        invalid = {}
         for key, value in attributes.items():
+            if key not in settings:
+                # This may occur if attributes have changed over time and an
+                # existing instance has older legacy attributes that do not
+                # match the current settings definition.
+                self.log.warning(
+                    "Publish attribute %s not found in Alembic Export "
+                    "default settings. Ignoring validation for attribute.",
+                    key
+                )
+                continue
+
             default_value = settings[key]
 
             # Lists are best to compared sorted since we cant rely on the order
@@ -61,10 +61,35 @@ def process(self, instance):
                 default_value = sorted(default_value)
 
             if value != default_value:
-                errors.append(msg.format(key, value, default_value))
+                invalid[key] = value, default_value
 
-        if errors:
-            raise PublishValidationError("\n".join(errors))
+        if invalid:
+            non_defaults = "\n".join(
+                f"- {key}: {value} \t(default: {default_value})"
+                for key, (value, default_value) in invalid.items()
+            )
+
+            raise PublishValidationError(
+                "Alembic extract options differ from default values:\n"
+                f"{non_defaults}",
+                description=self.get_description()
+            )
+
+    @staticmethod
+    def get_description():
+        return inspect.cleandoc(
+            """### Alembic Extract settings differ from defaults
+
+            The alembic export options differ from the project default values. 
+
+            If this is intentional you can disable this validation by 
+            disabling **Validate Alembic Options Default**.
+
+            If not you may use the "Repair" action to revert all the options to
+            their default values.
+
+            """
+        )
 
     @classmethod
     def repair(cls, instance):
@@ -75,13 +100,20 @@ def repair(cls, instance):
         )
 
         # Set the settings values on the create context then save to workfile.
-        publish_attributes = instance.data["publish_attributes"]
-        plugin_name = cls.plugin_name(publish_attributes)
-        attributes = cls._get_publish_attributes(instance)
         settings = cls._get_settings(instance.context)
-        create_publish_attributes = create_instance.data["publish_attributes"]
+        attributes = cls._get_publish_attributes(create_instance)
         for key in attributes:
-            create_publish_attributes[plugin_name][key] = settings[key]
+            if key not in settings:
+                # This may occur if attributes have changed over time and an
+                # existing instance has older legacy attributes that do not
+                # match the current settings definition.
+                cls.log.warning(
+                    "Publish attribute %s not found in Alembic Export "
+                    "default settings. Ignoring repair for attribute.",
+                    key
+                )
+                continue
+            attributes[key] = settings[key]
 
         create_context.save_changes()
 
@@ -93,6 +125,6 @@ class ValidateAlembicDefaultsAnimation(
 
     The defaults are defined in the project settings.
     """
-    label = "Validate Alembic Options   Defaults"
+    label = "Validate Alembic Options Defaults"
     families = ["animation"]
     plugin_name = "ExtractAnimation"

server_addon/maya/package.py

@@ -1,3 +1,3 @@
 name = "maya"
 title = "Maya"
-version = "0.1.17"
+version = "0.1.18"