Merge pull request #4696 from Autodesk/bailp/EMSUSD-3260/collection-material-bindings

EMSUSD-3260 collection-based material-binding support

Author: seando-adsk

lib/mayaUsd/resources/ae/usd-shared-components/src/python/usdSharedComponents/collection/expressionRulesMenu.py

@@ -14,6 +14,8 @@
 EXPAND_PRIMS_PROPERTIES_MENU_OPTION = "Expand Prims and Properties"
 EXPLICIT_ONLY_MENU_OPTION = "Explicit Only"
 INCLUDE_EXCLUDE_LABEL = "Include/Exclude"
+ASSIGN_MATERIAL_LABEL = "Assign Material"
+UNASSIGN_MATERIAL_LABEL = "Unassign Material"
 REMOVE_ALL_LABEL = "Remove All"
 CLEAR_OPINIONS_LABEL = "Clear Opinions from Target Layer"
 PRINT_PRIMS_LABEL = "Print Prims to Script Editor"
@@ -28,16 +30,22 @@ def __init__(self, data: CollectionData, parent: QWidget):
 
         theme = Theme.instance()
 
+        self._assignMaterialAction = QAction(theme.themeLabel(ASSIGN_MATERIAL_LABEL), self)
+        self._unassignMaterialAction = QAction(theme.themeLabel(UNASSIGN_MATERIAL_LABEL), self)
         self._removeAllAction = QAction(theme.themeLabel(REMOVE_ALL_LABEL), self)
         self._clearOpinionsAction = QAction(theme.themeLabel(CLEAR_OPINIONS_LABEL), self)
         self._printPrimsAction = QAction(theme.themeLabel(PRINT_PRIMS_LABEL), self)
         self._copyCollectionPathAction = QAction(theme.themeLabel(COPY_COLLECTION_PATH_LABEL), self)
         self._helpAction = QAction(theme.themeLabel(HELP_LABEL), self)
 
+        self.addActions([self._assignMaterialAction, self._unassignMaterialAction])
+        self.addSeparator()
         self.addActions([self._removeAllAction, self._clearOpinionsAction])
         self.addSeparator()
         self.addActions([self._printPrimsAction, self._copyCollectionPathAction])
 
+        self._assignMaterialAction.triggered.connect(self._onAssignMaterial)
+        self._unassignMaterialAction.triggered.connect(self._onUnassignMaterial)
         self._removeAllAction.triggered.connect(self._onRemoveAll)
         self._clearOpinionsAction.triggered.connect(self._onClearOpinions)
         self._printPrimsAction.triggered.connect(self._onPrintPrims)
@@ -72,6 +80,16 @@ def _onDataChanged(self):
         elif usdExpansionRule == Usd.Tokens.explicitOnly:
             self.explicitOnlyAction.setChecked(True)
 
+        hasMaterialBinding = self._collData.hasMaterialBinding()
+        self._assignMaterialAction.setVisible(not hasMaterialBinding)
+        self._unassignMaterialAction.setVisible(hasMaterialBinding)
+
+    def _onAssignMaterial(self):
+        self._collData.createMaterialBinding()
+
+    def _onUnassignMaterial(self):
+        self._collData.removeMaterialBinding()
+
     def _onRemoveAll(self):
         self._collData.removeAllIncludeExclude()
 

lib/mayaUsd/resources/ae/usd-shared-components/src/python/usdSharedComponents/data/collectionData.py

@@ -84,6 +84,31 @@ def getNamedCollectionPath(self) -> str:
         '''
         return None
 
+    # Collection material binding
+
+    def hasMaterialBinding(self) -> bool:
+        '''
+        Verify if the collection has a collection-based material binding.
+        '''
+        return False
+
+    def createMaterialBinding(self) -> bool:
+        '''
+        Create an (initially unbound) collection-based material binding for
+        this collection so that it can be edited.
+        Return True if successfully created.
+        Return False if a binding already exists.
+        '''
+        return False
+
+    def removeMaterialBinding(self) -> bool:
+        '''
+        Remove the collection-based material binding for this collection.
+        Return True if successfully removed.
+        Return False if there was no binding to remove.
+        '''
+        return False
+
     # Expression
 
     def getExpansionRule(self):

lib/mayaUsd/resources/ae/usd-shared-components/src/python/usdSharedComponents/usdData/usdCollectionData.py

@@ -3,7 +3,7 @@
 from .usdCollectionStringListData import CollectionStringListData
 from .validator import validatePrim, validateCollection
 
-from pxr import Sdf, Tf, Usd
+from pxr import Sdf, Tf, Usd, UsdShade
 
 
 PRINT_PRIMS_MSG = "{count} prims included in collection {collName} on {primName}:"
@@ -178,6 +178,63 @@ def clearIncludeExcludeOpinions(self) -> bool:
         self._collection.ResetCollection()
         return True
 
+    # Collection material binding
+
+    _materialBindingPurposes = [UsdShade.Tokens.allPurpose, UsdShade.Tokens.preview, UsdShade.Tokens.full]
+
+    def _getCollectionBindingRel(self, purpose):
+        '''
+        Returns the collection-based material binding relationship for this
+        collection and the given purpose, if authored, or an invalid
+        relationship otherwise.
+        '''
+        matAPI = UsdShade.MaterialBindingAPI(self._prim)
+        return matAPI.GetCollectionBindingRel(self._collection.GetName(), purpose)
+
+    @validateCollection(False)
+    def hasMaterialBinding(self) -> bool:
+        '''
+        Verify if the collection has a collection-based material binding.
+        '''
+        for purpose in self._materialBindingPurposes:
+            if self._getCollectionBindingRel(purpose):
+                return True
+        return False
+
+    @validateCollection(False)
+    def createMaterialBinding(self) -> bool:
+        '''
+        Create an (initially unbound) collection-based material binding for
+        this collection so that it can be edited.
+        '''
+        if self.hasMaterialBinding():
+            return False
+
+        bindingName = self._collection.GetName()
+        collectionPath = Usd.CollectionAPI.GetNamedCollectionPath(self._prim, bindingName)
+
+        # Note: there is no "Create" accessor for a collection binding relationship.
+        #       GetCollectionBindingRel() returns a (possibly still-unauthored) handle
+        #       that SetTargets() will author on demand.
+        matAPI = UsdShade.MaterialBindingAPI.Apply(self._prim)
+        bindingRel = matAPI.GetCollectionBindingRel(bindingName, UsdShade.Tokens.allPurpose)
+        bindingRel.SetTargets([collectionPath])
+        return True
+
+    @validateCollection(False)
+    def removeMaterialBinding(self) -> bool:
+        '''
+        Remove the collection-based material binding for this collection.
+        '''
+        if not self.hasMaterialBinding():
+            return False
+
+        for purpose in self._materialBindingPurposes:
+            bindingRel = self._getCollectionBindingRel(purpose)
+            if bindingRel:
+                self._prim.RemoveProperty(bindingRel.GetName())
+        return True
+
     # Expression
 
     @validateCollection('')

lib/mayaUsd/resources/ae/usdschemabase/ae_template.py

@@ -19,7 +19,7 @@
 from .attributeCustomControl import cleanAndFormatTooltip
 from .connectionsCustomControl import ConnectionsCustomControl
 from .displayCustomControl import DisplayCustomControl
-from .materialCustomControl import MaterialCustomControl
+from .materialCustomControl import MaterialCustomControl, CollectionMaterialCustomControl
 from .metadataCustomControl import MetadataCustomControl
 from .assetInfoCustomControl import AssetInfoCustomControl
 from .relationshipCustomControl import RelationshipCustomControl
@@ -75,7 +75,7 @@ def __init__(self, ufeSceneItem):
         # Get the UFE Attributes interface for this scene item.
         self.attrs = ufe.Attributes.attributes(self.item)
         self.addedAttrs = set()
-        self.suppressedAttrs = []
+        self.suppressedAttrs = set()
         self.hasConnectionObserver = False
 
         self.showArrayAttributes = False
@@ -177,9 +177,7 @@ def addControls(self, attrNames, nameMap=None):
             for controlCreator in AETemplate._controlCreators:
                 # Control can suppress attributes in the creator function
                 # so we check for supression at each loop
-                if attrName in self.suppressedAttrs:
-                    break
-                if attrName in self.addedAttrs:
+                if self.isAttrAlreadyHandled(attrName):
                     break
 
                 try:
@@ -194,7 +192,16 @@ def addControls(self, attrNames, nameMap=None):
 
     def suppress(self, attrName):
         cmds.editorTemplate(suppress=attrName)
-        self.suppressedAttrs.append(attrName)
+        self.suppressedAttrs.add(attrName)
+
+    def isSuppressedAttr(self, attrName):
+        return attrName in self.suppressedAttrs
+
+    def isAddedAttr(self, attrName):
+        return attrName in self.addedAttrs
+
+    def isAttrAlreadyHandled(self, attrName):
+        return self.isSuppressedAttr(attrName) or self.isAddedAttr(attrName)
 
     def defineCustom(self, customObj, attrs=[]):
         create = lambda *args : customObj.onCreate(args)
@@ -205,9 +212,7 @@ def createSection(self, layoutName, attrList, schemasAttributes, collapse=False)
         # We create the section named "layoutName" if at least one
         # of the attributes from the input list exists.
         for attr in attrList:
-            if attr in self.suppressedAttrs:
-                continue
-            if attr in self.addedAttrs:
+            if self.isAttrAlreadyHandled(attr):
                 continue
             if self.attrs.hasAttribute(attr):
                 with ufeAeTemplate.Layout(self, layoutName, collapse):
@@ -387,7 +392,7 @@ def createCustomExtraAttrs(self, sectionName, attrs, schemasAttributes, collapse
         extraAttrs = []
         otherSchemaAttrs = {item for values in schemasAttributes.values() for item in values}
         for attr in self.attrs.attributeNames:
-            if attr in self.addedAttrs or attr in self.suppressedAttrs or attr in otherSchemaAttrs:
+            if self.isAttrAlreadyHandled(attr) or attr in otherSchemaAttrs:
                 continue
             extraAttrs.append(attr)
         sectionName = mel.eval("uiRes(\"s_TPStemplateStrings.rExtraAttributes\");")
@@ -403,6 +408,49 @@ def createAccessibilitySection(self, sectionName, attrs, schemasAttributes, coll
         with ufeAeTemplate.Layout(self, sectionName, collapse=collapse):
             self.addControls(attrs, nameMap=nameMap)
 
+    def createCollectionSection(self, sectionName, attrs, schemasAttributes, collapse, typeName):
+        '''
+        Create the section for a named CollectionAPI instance, then, if that
+        collection has a collection-based material binding authored on it, add
+        a sibling section right underneath to edit that binding.
+        '''
+        self.createSection(sectionName, attrs, schemasAttributes, collapse)
+
+        collectionApiSuffix = 'CollectionAPI'
+        if not typeName.endswith(collectionApiSuffix):
+            return
+        instanceName = typeName[:-len(collectionApiSuffix)]
+        if not instanceName:
+            return
+
+        self.createCollectionMaterialBindingSection(instanceName)
+
+    def createCollectionMaterialBindingSection(self, instanceName):
+        '''
+        If the named collection has a collection-based material binding
+        authored on the prim, create a section to edit it and suppress the
+        underlying attributes so they do not also appear in Extra Attributes.
+        '''
+        if not CollectionMaterialCustomControl.hasCollectionMaterial(self.prim, instanceName):
+            return
+
+        matAPI = UsdShade.MaterialBindingAPI(self.prim)
+        authoredRelNames = []
+        for purpose in [UsdShade.Tokens.allPurpose, UsdShade.Tokens.preview, UsdShade.Tokens.full]:
+            bindingRel = matAPI.GetCollectionBindingRel(instanceName, purpose)
+            if bindingRel:
+                authoredRelNames.append(bindingRel.GetName())
+
+        layoutName = '%s Collection Material' % instanceName
+        with ufeAeTemplate.Layout(self, layoutName, collapse=False):
+            createdControl = CollectionMaterialCustomControl(self.item, self.prim, instanceName, self.useNiceName)
+            usdNoticeControl = UsdNoticeListener(self.prim, [createdControl])
+            self.defineCustom(createdControl)
+            self.defineCustom(usdNoticeControl)
+
+        for relName in authoredRelNames:
+            self.suppress(relName)
+
     def findAppliedSchemas(self):
         # loop on all applied schemas and store all those
         # schema into a dictionary with the attributes.
@@ -604,6 +652,10 @@ def createSchemasSections(self, schemasOrder, schemasAttributes):
         def addMatSection():
             if not self.addedMaterialSection:
                 self.addedMaterialSection = True
+                # Note: collection sections are handled first because if there are *only*
+                #       collection-based material bindings, we want to show those only 
+                #       and not the material section.
+                self.createAllCollectionMaterialBindingSections()
                 self.createMaterialAttributeSection()
 
         # Function that determines if a section should be expanded.
@@ -632,6 +684,7 @@ def isUsdRender(prim):
             'assetInfo': self.createAssetInfoSection,
             'metadata': self.createMetadataSection,
             ".*AccessibilityAPI": self.createAccessibilitySection,
+            ".*CollectionAPI": self.createCollectionSection,
         }
 
         # We only want the attributes appearing once so if the prim 
@@ -647,14 +700,18 @@ def isUsdRender(prim):
             attrs = schemasAttributes[typeName]
             sectionName = self.sectionNameFromSchema(typeName)
             collapse = not isSectionOpen(sectionName)
+            creator = self.createSection
+            isCollectionSchema = False
             for pattern, value in customAttributes.items():
                 if re.fullmatch(pattern, typeName):
                     creator = value
+                    isCollectionSchema = (pattern == ".*CollectionAPI")
                     break
-            else:
-                creator = self.createSection
 
-            creator(sectionName, attrs, schemasAttributes, collapse)
+            if isCollectionSchema:
+                creator(sectionName, attrs, schemasAttributes, collapse, typeName)
+            else:
+                creator(sectionName, attrs, schemasAttributes, collapse)
 
             if sectionName == primTypeName:
                 addMatSection()
@@ -663,7 +720,10 @@ def isUsdRender(prim):
         addMatSection()        
 
     def createMaterialAttributeSection(self):
-        if not MaterialCustomControl.hasMaterial(self.prim):
+        for rel in MaterialCustomControl.findMaterialRelationships(self.prim):
+            if not self.isAttrAlreadyHandled(rel.GetName()):
+                break
+        else:
             return
         layoutName = getMayaUsdLibString('kLabelMaterial')
         with ufeAeTemplate.Layout(self, layoutName, collapse=False):
@@ -672,6 +732,14 @@ def createMaterialAttributeSection(self):
             self.defineCustom(createdControl)
             self.defineCustom(usdNoticeControl)
 
+    def createAllCollectionMaterialBindingSections(self):
+        collectionBindings = CollectionMaterialCustomControl.findCollectionMaterials(self.prim)
+        for instanceName, rel in collectionBindings.items():
+            if self.isAttrAlreadyHandled(rel.GetName()):
+                continue
+            self.createCollectionMaterialBindingSection(instanceName)
+            self.addedAttrs.add(rel.GetName())
+
     def suppressArrayAttribute(self):
         # Suppress all array attributes.
         if not self.showArrayAttributes:

lib/mayaUsd/resources/ae/usdschemabase/collectionMayaHost.py

@@ -8,8 +8,10 @@
 from maya.api.OpenMaya import MPxCommand, MFnPlugin, MGlobal, MSyntax, MArgDatabase
 import mayaUsd.lib
 import mayaUsd.ufe
+import maya.internal.ufeSupport.ufeCmdWrapper as ufeCmdWrapper
 import maya.mel as mel
 import maya.cmds as cmds
+import ufe
 
 from pxr import Usd
 from typing import AnyStr, Sequence, Tuple
@@ -304,6 +306,35 @@ def setMembershipExpression(self, textExpression: AnyStr):
         with _UsdUndoBlockContext(_SetMembershipExpressionCommand.commandName):
             super().setMembershipExpression(textExpression)
 
+    # Collection material binding
+
+    def _getUfePathString(self) -> str:
+        '''
+        Build the UFE path string for the prim held by this collection data,
+        without requiring a pre-existing UFE scene item.
+        '''
+        stagePathStr = mayaUsd.ufe.stagePath(self._prim.GetStage())
+        mayaSegment = ufe.PathString.path(stagePathStr).segments[0]
+        usdSegment = ufe.PathSegment(str(self._prim.GetPath()), mayaUsd.ufe.getUsdRunTimeId(), '/')
+        return ufe.PathString.string(ufe.Path([mayaSegment, usdSegment]))
+
+    def createMaterialBinding(self) -> bool:
+        if self.hasMaterialBinding():
+            return False
+        cmd = mayaUsd.ufe.CreateCollectionMaterialBindingCommand(
+            self._getUfePathString(), self._collection.GetName())
+        ufeCmdWrapper.execute(cmd)
+        return True
+
+    def removeMaterialBinding(self) -> bool:
+        if not self.hasMaterialBinding():
+            return False
+        # Note: the bool overload removes all purposes of the binding at once.
+        cmd = mayaUsd.ufe.UnbindCollectionMaterialCommand(
+            self._getUfePathString(), self._collection.GetName(), True)
+        ufeCmdWrapper.execute(cmd)
+        return True
+
 
 class MayaStringListData(CollectionStringListData):
     '''