Light linking sync

lib/mayaUsd/resources/ae/CMakeLists.txt

@@ -62,6 +62,7 @@ if(MAYA_APP_VERSION VERSION_GREATER_EQUAL 2023)
         ${MAYAUSD_SHARED_COMPONENTS}/common/__init__.py
         ${MAYAUSD_SHARED_COMPONENTS}/common/filteredStringListModel.py
         ${MAYAUSD_SHARED_COMPONENTS}/common/filteredStringListView.py
+        ${MAYAUSD_SHARED_COMPONENTS}/common/host.py
         ${MAYAUSD_SHARED_COMPONENTS}/common/list.py
         ${MAYAUSD_SHARED_COMPONENTS}/common/persistentStorage.py
         ${MAYAUSD_SHARED_COMPONENTS}/common/resizable.py
@@ -72,6 +73,7 @@ if(MAYA_APP_VERSION VERSION_GREATER_EQUAL 2023)
 
     set(LIB_ICONS
         ${MAYAUSD_SHARED_COMPONENTS}/icons/dark/menu
+        ${MAYAUSD_SHARED_COMPONENTS}/icons/dark/delete
     )
     foreach(ICON_BASE ${LIB_ICONS})
         # The _100.png files need to be installed without the _100. This is the

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

@@ -1,46 +1,51 @@
+from typing import Sequence
+
 from ..common.list import StringList
 from ..common.resizable import Resizable
 from ..common.menuButton import MenuButton
 from .expressionRulesMenu import ExpressionMenu
+from ..common.host import Host
+from ..common.theme import Theme
 
 try:
-    from PySide6.QtCore import QEvent, QObject  # type: ignore
-    from PySide6.QtWidgets import QFrame, QWidget, QHBoxLayout, QVBoxLayout, QLineEdit, QSizePolicy  # type: ignore
+    from PySide6.QtCore import QEvent, QObject, Qt  # type: ignore
+    from PySide6.QtWidgets import QFrame, QHBoxLayout, QVBoxLayout, QLineEdit, QMenu, QSizePolicy, QToolButton, QWidget  # type: ignore
+    from PySide6.QtGui import QAction # type: ignore
 except ImportError:
-    from PySide2.QtWidgets import QFrame, QWidget, QHBoxLayout, QVBoxLayout, QLineEdit, QSizePolicy # type: ignore
+    from PySide2.QtCore import QEvent, QObject, Qt  # type: ignore
+    from PySide2.QtWidgets import QFrame, QHBoxLayout, QVBoxLayout, QLineEdit, QMenu, QSizePolicy, QToolButton, QWidget  # type: ignore
+    from PySide2.QtGui import QAction # type: ignore
 
 from pxr import Usd, Sdf
 
 # TODO: support I8N
-kSearchPlaceHolder = 'Search...'
+kSearchPlaceHolder = "Search..."
+
 
 class IncludeExcludeWidget(QWidget):
-    def __init__(self, collection: Usd.CollectionAPI = None, parent: QWidget = None):
+    def __init__(
+        self,
+        prim: Usd.Prim = None,
+        collection: Usd.CollectionAPI = None,
+        parent: QWidget = None,
+    ):
         super(IncludeExcludeWidget, self).__init__(parent)
-        self._collection = collection
+        self._collection: Usd.CollectionAPI = collection
+        self._prim: Usd.Prim = prim
+        self._updatingUI = False
 
-        shouldIncludeAll = False
-        includes = []
-        excludes = []
+        includeExcludeLayout = QVBoxLayout(self)
 
-        if self._collection is not None:
-            includeRootAttribute = self._collection.GetIncludeRootAttr()
-            if includeRootAttribute.IsAuthored():
-                shouldIncludeAll = self._collection.GetIncludeRootAttr().Get()
+        includeExcludeLayout.setContentsMargins(0, 0, 0, 0)
 
-            for p in self._collection.GetIncludesRel().GetTargets():
-                includes.append(p.pathString)
-            for p in self._collection.GetExcludesRel().GetTargets():
-                excludes.append(p.pathString)
-
-        includeExcludeLayout = QVBoxLayout(self)
-        includeExcludeLayout.setContentsMargins(0,0,0,0)
         self._expressionMenu = ExpressionMenu(self._collection, self)
         menuButton = MenuButton(self._expressionMenu, self)
 
         self._filterWidget = QLineEdit()
         self._filterWidget.setContentsMargins(0, 0, 0, 0)
-        self._filterWidget.setSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Fixed)
+        self._filterWidget.setSizePolicy(
+            QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Fixed
+        )
         self._filterWidget.setPlaceholderText(kSearchPlaceHolder)
         self._filterWidget.setClearButtonEnabled(True)
 
@@ -50,29 +55,73 @@
         headerWidget = QWidget(self)
         headerWidget.setContentsMargins(0, 0, 0, 0)
         headerLayout = QHBoxLayout(headerWidget)
+
         headerLayout.setContentsMargins(0, 2, 2, 0)
+
+        if Host.instance().canPick:
+            addBtn = QToolButton(headerWidget)
+            addBtn.setToolTip("Add prims to Include or Exclude")
+            addBtn.setIcon(Theme.instance().icon("add"))
+            addBtn.setPopupMode(QToolButton.InstantPopup)
+            addBtnMenu = QMenu(addBtn)
+            addBtnMenu.addAction("Add prims to Include", self.onAddToIncludePrimClicked)
+            addBtnMenu.addAction("Add prims to Exclude", self.onAddToExcludePrimClicked)
+            addBtn.setMenu(addBtnMenu)
+            headerLayout.addWidget(addBtn)
+
+        self._deleteBtn = QToolButton(headerWidget)
+        self._deleteBtn.setToolTip("Remove selected prims from Include or Exclude")
+        self._deleteBtn.setIcon(Theme.instance().icon("delete"))
+        self._deleteBtn.setPopupMode(QToolButton.InstantPopup)
+        self._deleteBtnMenu = QMenu(self._deleteBtn)
+        self._deleteBtnActionFromIncludes = QAction("Remove selected prims from Include", self._deleteBtnMenu)
+        self._deleteBtnActionFromIncludes.triggered.connect(self.onRemoveSelectionFromInclude)
+        self._deleteBtnMenu.addAction(self._deleteBtnActionFromIncludes)
+        self._deleteBtnActionFromExcludes = QAction("Remove selected prims from Exclude", self._deleteBtnMenu)
+        self._deleteBtnActionFromExcludes.triggered.connect(self.onRemoveSelectionFromExclude)
+        self._deleteBtnMenu.addAction(self._deleteBtnActionFromExcludes)
+        self._deleteBtn.setMenu(self._deleteBtnMenu)
+        headerLayout.addWidget(self._deleteBtn)
+
+        self._deleteBtn.setEnabled(False)
+
         headerLayout.addWidget(self._filterWidget)
         headerLayout.addWidget(separator)
         headerLayout.addWidget(menuButton)
         includeExcludeLayout.addWidget(headerWidget)
 
-        self._include = StringList(includes, "Include", "Include all", self)
-        self._include.cbIncludeAll.setChecked(shouldIncludeAll)
+        self._include = StringList([], "Include", "Include all", self)
         self._include.cbIncludeAll.stateChanged.connect(self.onIncludeAllToggle)
-        self._resizableInclude = Resizable(self._include, "USD_Light_Linking", "IncludeListHeight", self, defaultSize=80)
+        self._resizableInclude = Resizable(
+            self._include,
+            "USD_Light_Linking",
+            "IncludeListHeight",
+            self,
+            defaultSize=80,
+        )
         includeExcludeLayout.addWidget(self._resizableInclude)
 
-        self._exclude = StringList(excludes, "Exclude", "", self)
-        self._resizableExclude = Resizable(self._exclude, "USD_Light_Linking", "ExcludeListHeight", self, defaultSize=80)
+        self._exclude = StringList([], "Exclude", "", self)
+        self._resizableExclude = Resizable(
+            self._exclude,
+            "USD_Light_Linking",
+            "ExcludeListHeight",
+            self,
+            defaultSize=80,
+        )
         includeExcludeLayout.addWidget(self._resizableExclude)
 
+        self._include.list.selectionChanged.connect(self.onListSelectionChanged)
+        self._exclude.list.selectionChanged.connect(self.onListSelectionChanged)
+
         self._filterWidget.textChanged.connect(self._include.list._model.setFilter)
         self._filterWidget.textChanged.connect(self._exclude.list._model.setFilter)
         EventFilter(self._include.list, self)
         EventFilter(self._exclude.list, self)
 
         self.setLayout(includeExcludeLayout)
-        self.update()
+        self.updateUI()
+        self.onListSelectionChanged()
 
     def update(self):
         self._expressionMenu.update()
@@ -99,15 +148,111 @@
 
     def getExcludedItems(self):
         return self._exclude.list.items()
-    
+
     def getIncludeAll(self):
         return self._include.cbIncludeAll.isChecked()
 
     def setIncludeAll(self, value: bool):
         self._include.cbIncludeAll.setChecked(value)
 
-    def onIncludeAllToggle(self):
-        self._collection.GetIncludeRootAttr().Set(self._include.cbIncludeAll.isChecked())
+    def updateUI(self):
+        if self._updatingUI:
+            return
+
+        self._updatingUI = True
+
+        # update the include list
+        includes = []
+        for p in self._collection.GetIncludesRel().GetTargets():
+            includes.append(p.pathString)
+        self._include.list.items = includes
+
+        # update the exclude list
+        excludes = []
+        for p in self._collection.GetExcludesRel().GetTargets():
+            excludes.append(p.pathString)
+        self._exclude.list.items = excludes
+
+        self._include.cbIncludeAll.setChecked(
+            self._collection.GetIncludeRootAttr().Get()
+        )
+
+        self._updatingUI = False
+
+    def onAddToIncludePrimClicked(self):
+        prims: Sequence[Usd.Prim] = Host.instance().pick(self._prim.GetStage())
+        if prims is None:
+            return
+        self._updatingUI = True
+        for prim in prims:
+            self._collection.GetIncludesRel().AddTarget(prim.GetPath())
+        self._updatingUI = False
+        self.updateUI()
+
+    def onAddToExcludePrimClicked(self):
+        prims: Sequence[Usd.Prim] = Host.instance().pick(self._prim.GetStage())
+        if prims is None:
+            return
+        self._updatingUI = True
+        for prim in prims:
+            self._collection.GetExcludesRel().AddTarget(prim.GetPath())
+        self._updatingUI = False
+        self.updateUI()
+
+    def onRemoveSelectionFromInclude(self):
+        self._updatingUI = True
+        for item in self._include.list.selectedItems:
+            self._collection.GetIncludesRel().RemoveTarget(Sdf.Path(item))
+        self._updatingUI = False
+        self.updateUI()
+        self.onListSelectionChanged()
+        self._include.list.update_placeholder()
+
+    def onRemoveSelectionFromExclude(self):
+        self._updatingUI = True
+        for item in self._exclude.list.selectedItems:
+            self._collection.GetExcludesRel().RemoveTarget(Sdf.Path(item))
+        self._updatingUI = False
+        self.updateUI()
+        self.onListSelectionChanged()
+        self._exclude.list.update_placeholder()
+
+    def onListSelectionChanged(self):
+        includesSelected = self._include.list.hasSelectedItems
+        excludeSelected = self._exclude.list.hasSelectedItems
+        self._deleteBtn.setEnabled(includesSelected or excludeSelected)
+
+        self._deleteBtnActionFromIncludes.setEnabled(includesSelected)
+        self._deleteBtnActionFromExcludes.setEnabled(excludeSelected)
+
+        try:
+            self._deleteBtn.pressed.disconnect(self.onRemoveSelectionFromInclude)
+            self._deleteBtn.pressed.disconnect(self.onRemoveSelectionFromExclude)
+        except Exception:
+            pass
+
+        if includesSelected and excludeSelected:
+            self._deleteBtn.setToolTip(
+                "Remove selected prims from Include or Exclude..."
+            )
+            self._deleteBtn.setPopupMode(QToolButton.InstantPopup)
+            self._deleteBtn.setStyleSheet("")
+        else:
+            if includesSelected:
+                self._deleteBtn.setToolTip("Remove selected prims from Include")
+                self._deleteBtn.pressed.connect(self.onRemoveSelectionFromInclude)
+            elif excludeSelected:
+                self._deleteBtn.setToolTip("Remove selected prims from Exclude")
+                self._deleteBtn.pressed.connect(self.onRemoveSelectionFromExclude)
+            self._deleteBtn.setPopupMode(QToolButton.DelayedPopup)
+            self._deleteBtn.setStyleSheet(
+                """QToolButton::menu-indicator { width: 0px; }"""
+            )
+
+    def onIncludeAllToggle(self, state: Qt.CheckState):
+        if not self._updatingUI:
+            self._collection.GetIncludeRootAttr().Set(state == Qt.Checked)
+
 
 class EventFilter(QObject):
     def __init__(self, widget, control):
@@ -136,14 +281,14 @@
         return super().eventFilter(obj, event)
 
     def addItemToCollection(self, items):
-        itemList = items.split('\n')
+        itemList = items.split("\n")
         for item in itemList:
             path = ""
-            if ',' in item:
-                path = item.split(',')[1]
+            if "," in item:
+                path = item.split(",")[1]
             else:
                 path = item
-            
+
             if not self._validatePath(self.control._collection, path):
                 return
 
@@ -154,26 +299,18 @@
                     self.control._collection.GetExcludesRel().AddTarget(path)
 
         self.control.update()
-    '''
-    def removeItemToCollection(self, item):
-        if self.control._collection is not None:
-            if self.widget.headerTitle == "Include":
-                self.control._collection.GetIncludesRel().RemoveTarget(item)
-            elif self.widget.headerTitle == "Exclude":
-                self.control._collection.GetExcludesRel().RemoveTarget(item)
-
-        self.control.update()
-    '''
 
     def _validatePath(self, collection, path):
-       
+
         if not Sdf.Path.IsValidPathString(path):
             raise ValueError("Invalid sdf path: " + path)
 
         stage = self.control._collection.GetPrim().GetStage()
         prim = stage.GetPrimAtPath(Sdf.Path(path))
 
         if not prim or not prim.IsValid():
-            raise ValueError("Value must be a float or an int")("Error: The dragged object is not in the same stage as the collection. Ensure that objects belong to the same stage before adding them")
-
-        return True
+            raise ValueError(
+                "Error: The dragged object is not in the same stage as the collection. Ensure that objects belong to the same stage before adding them"
+            )
+
+        return True