Update

2023/scripts/animation_tools/studiolibrary/mutils/selectionset.py

@@ -0,0 +1,111 @@
+# Copyright 2020 by Kurt Rathjen. All Rights Reserved.
+#
+# This library is free software: you can redistribute it and/or modify it 
+# under the terms of the GNU Lesser General Public License as published by 
+# the Free Software Foundation, either version 3 of the License, or 
+# (at your option) any later version. This library is distributed in the 
+# hope that it will be useful, but WITHOUT ANY WARRANTY; without even the 
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
+# See the GNU Lesser General Public License for more details.
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library. If not, see <http://www.gnu.org/licenses/>.
+
+import logging
+
+import mutils
+
+try:
+    import maya.cmds
+except Exception:
+    import traceback
+    traceback.print_exc()
+
+
+logger = logging.getLogger(__name__)
+
+
+def saveSelectionSet(path, objects, metadata=None):
+    """
+    Convenience function for saving a selection set to the given disc location.
+    
+    :type path: str
+    :type objects: list[str]
+    :type metadata: dict or None
+    :type args: list
+    :type kwargs: dict
+    :rtype: SelectionSet 
+    """
+    selectionSet = SelectionSet.fromObjects(objects)
+
+    if metadata:
+        selectionSet.updateMetadata(metadata)
+
+    selectionSet.save(path)
+
+    return selectionSet
+
+
+class SelectionSet(mutils.TransferObject):
+
+    def load(self, objects=None, namespaces=None, **kwargs):
+        """
+        Load/Select the transfer objects to the given objects or namespaces.
+        
+        :type objects: list[str] or None
+        :type namespaces: list[str] or None
+        :type kwargs:
+        """
+        validNodes = []
+        dstObjects = objects
+        srcObjects = self.objects()
+
+        self.validate(namespaces=namespaces)
+
+        matches = mutils.matchNames(
+                srcObjects,
+                dstObjects=dstObjects,
+                dstNamespaces=namespaces
+        )
+
+        for srcNode, dstNode in matches:
+            # Support for wild cards eg: ['*_control'].
+            if "*" in dstNode.name():
+                validNodes.append(dstNode.name())
+            else:
+                # Remove the first pipe in-case the object has a parent.
+                dstNode.stripFirstPipe()
+
+                # Try to get the short name. Much faster than the long
+                # name when selecting objects.
+                try:
+                    dstNode = dstNode.toShortName()
+
+                except mutils.NoObjectFoundError as error:
+                    logger.debug(error)
+                    continue
+
+                except mutils.MoreThanOneObjectFoundError as error:
+                    logger.debug(error)
+
+                validNodes.append(dstNode.name())
+
+        if validNodes:
+            maya.cmds.select(validNodes, **kwargs)
+
+            # Return the focus to the Maya window
+            maya.cmds.setFocus("MayaWindow")
+        else:
+            text = "No objects match when loading data. " \
+                   "Turn on debug mode to see more details."
+
+            raise mutils.NoMatchFoundError(text)
+
+    def select(self, objects=None, namespaces=None, **kwargs):
+        """
+        Convenience method for any classes inheriting SelectionSet.
+        
+        :type objects: str
+        :type namespaces: list[str]
+        :rtype: None
+        """
+        SelectionSet.load(self, objects=objects, namespaces=namespaces, **kwargs)