EMSUSD-2111 print collection membership

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

@@ -15,6 +15,7 @@
 INCLUDE_EXCLUDE_LABEL = "Include/Exclude"
 REMOVE_ALL_LABEL = "Remove All"
 CLEAR_OPINIONS_LABEL = "Clear Opinions from Target Layer"
+PRINT_PRIMS_LABEL = "Print Prims to Script Editor"
 
 
 class ExpressionMenu(QMenu):
@@ -27,10 +28,14 @@
 
         self._removeAllAction = QAction(REMOVE_ALL_LABEL, self)
         self._clearOpinionsAction = QAction(CLEAR_OPINIONS_LABEL, self)
-        self.addActions([self._removeAllAction, self._clearOpinionsAction])
+        prePrintSeparator = QAction()
+        prePrintSeparator.setSeparator(True)
+        self._printPrimsAction = QAction(PRINT_PRIMS_LABEL, self)
+        self.addActions([self._removeAllAction, self._clearOpinionsAction, prePrintSeparator, self._printPrimsAction])
 
         self._removeAllAction.triggered.connect(self._onRemoveAll)
         self._clearOpinionsAction.triggered.connect(self._onClearOpinions)
+        self._printPrimsAction.triggered.connect(self._onPrintPrims)
 
         self._collData.dataChanged.connect(self._onDataChanged)
         expansionRulesMenu = QMenu("Expansion Rules", self)
@@ -64,6 +69,9 @@
     def _onClearOpinions(self):
         self._collData.clearIncludeExcludeOpinions()
 
+    def _onPrintPrims(self):
+        self._collData.printCollection()        
+
     def onExpressionSelected(self, menuOption):
         if menuOption == self.expandPrimsAction:
             self._collData.setExpansionRule(Usd.Tokens.expandPrims)

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

@@ -30,6 +30,12 @@ def getStage(self):
         '''
         return None
 
+    def printCollection(self):
+        '''
+        Prints the collection to the host logging system.
+        '''
+        pass
+
     # Include and exclude
 
     def includesAll(self) -> bool:

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

@@ -6,6 +6,10 @@
 from pxr import Sdf, Tf, Usd
 
 
+PRINT_PRIMS_MSG = "{count} prims included in collection {collName} on {primName}:"
+PRINT_PRIMS_CONFLICT_MSG = "Both Include/Exclude rules and Expressions are currently defined. Expressions will be ignored."
+
+
 class UsdCollectionData(CollectionData):
     def __init__(self, prim: Usd.Prim, collection: Usd.CollectionAPI):
         super().__init__()
@@ -85,6 +89,24 @@
         '''
         return self._prim.GetStage()
 
+    @validateCollection('')
+    def printCollection(self):
+        '''
+        Prints the collection to the host logging system.
+        '''
+        members = list(map(str, self.computeMembership()))
+        msgHeader = PRINT_PRIMS_MSG.format(
+            count=len(members),
+            collName=self._collection.GetName(),
+            primName=self._prim.GetPath())
+
+        from ..common.host import Host, MessageType
+        Host.instance().reportMessage(msgHeader, MessageType.INFO)
+        Host.instance().reportMessage('\n'.join(members), MessageType.INFO)
+
+        if (self.hasDataConflict()):
+            Host.instance().reportMessage(PRINT_PRIMS_CONFLICT_MSG, MessageType.INFO)
+
     # Include and exclude
 
     @validateCollection(False)
@@ -214,4 +236,18 @@
         query = self._collection.ComputeMembershipQuery()
         if not query:
             return []
-        return Usd.CollectionAPI.ComputeIncludedPaths(query, self._prim.GetStage())
+
+        # When there are both explicit inclusions/exclusions and a membership
+        # expression, the CollectionAPI docs states that the expression should
+        # be ignored. Unfortunately, ComputeIncludedPaths does not handle this
+        # correctly, so we have to do the work by hand by calling IsPAthIncluded
+        # for each path, as that function works correctly.
+        if self.hasDataConflict():
+            members = []
+            for prim in self._prim.GetStage().TraverseAll():
+                path = prim.GetPath()
+                if query.IsPathIncluded(path):
+                    members.append(path.pathString)
+            return members
+        else:
+            return Usd.CollectionAPI.ComputeIncludedPaths(query, self._prim.GetStage())