REMIX-4793: Auto expanding tree when a Stage Manager filter is used

Author: Shona Gillard

CHANGELOG.md

@@ -31,6 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - REMIX-4792: Added a badge to the Additional Filters button to show the number of modified filters
 - REMIX-4813: Added Logic Graph sidebar button for quick layout switching with dedicated Logic Graph layout
 - REMIX-4807: Added Escape key support to close Stage Prim Picker dropdown
+- REMIX-4793: Added a function to check if tree items need to be expanded in the Stage Manager
 
 ### Changed
 - Update hdremix and omni_core_materials to ext-822f7b6-main

source/extensions/lightspeed.trex.stage_manager.plugin.filter.usd/config/extension.toml

@@ -1,6 +1,6 @@
 [package]
 # Semantic Versionning is used: https://semver.org/
-version = "2.1.0"
+version = "2.1.1"
 
 # Lists people or organizations that are considered the "authors" of the package.
 authors = ["Pierre-Olivier Trottier <[email protected]>"]

source/extensions/lightspeed.trex.stage_manager.plugin.filter.usd/docs/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [2.1.1]
+### Changed
+- Updated is_logic_graph filter plugin to have a public field for the current filter type
+
 ## [2.1.0]
 ### Added
 - Added filter plugin remix logic graphs

source/extensions/lightspeed.trex.stage_manager.plugin.filter.usd/lightspeed/trex/stage_manager/plugin/filter/usd/is_logic_graph.py

@@ -38,6 +38,7 @@ class RemixLogicPrimsFilterPlugin(StageManagerUSDFilterPlugin):
     _COMBO_BOX_WIDTH: int = PrivateAttr(default=130)
     _filter_combobox: ui.ComboBox | None = PrivateAttr(default=None)
     _current_index: int = PrivateAttr(default=0)
+    current_filter_type: str = Field(default="No Filter", description="The type of logic to filter by")
 
     def filter_predicate(self, item: StageManagerItem) -> bool:
         match self._current_index:
@@ -65,4 +66,5 @@ def build_ui(self) -> None:
     def _on_filter_changed(self, model: "StageManagerTreeModel", _: "StageManagerTreeItem") -> None:
         selected_index = model.get_item_value_model().get_value_as_int()
         self._current_index = selected_index
+        self.current_filter_type = _filter_types[selected_index]
         self._filter_items_changed()

source/extensions/omni.flux.stage_manager.plugin.filter.usd/config/extension.toml

@@ -1,6 +1,6 @@
 [package]
 # Semantic Versionning is used: https://semver.org/
-version = "2.4.0"
+version = "2.4.1"
 
 # Lists people or organizations that are considered the "authors" of the package.
 authors = ["Pierre-Olivier Trottier <[email protected]>"]

source/extensions/omni.flux.stage_manager.plugin.filter.usd/docs/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [2.4.1]
+### Changed
+- Changed default value for SearchFilterPlugin
+
 ## [2.4.0]
 ### Added
 - Added a badge to the Additional Filters button to show the number of modified filters

source/extensions/omni.flux.stage_manager.plugin.filter.usd/omni/flux/stage_manager/plugin/filter/usd/search.py

@@ -30,7 +30,7 @@ class SearchFilterPlugin(_StageManagerUSDFilterPlugin):
 
     display_name: str = Field(default="Search", exclude=True)
     tooltip: str = Field(default="Search through the list of prims", exclude=True)
-    search_term: str = Field(default="", exclude=True)
+    search_term: str = Field(default="", exclude=False)
 
     _end_edit_sub: _EventSubscription | None = PrivateAttr(default=None)
 

source/extensions/omni.flux.stage_manager.plugin.interaction.usd/config/extension.toml

@@ -1,6 +1,6 @@
 [package]
 # Semantic Versionning is used: https://semver.org/
-version = "2.6.0"
+version = "2.7.0"
 
 # Lists people or organizations that are considered the "authors" of the package.
 authors = ["Pierre-Olivier Trottier <[email protected]>"]

source/extensions/omni.flux.stage_manager.plugin.interaction.usd/docs/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [2.7.0]
+### Added
+- Added a function to check if tree items need to be expanded
+
 ## [2.6.0]
 ### Added
 - Added `LogicGraphWidgetPlugin` to the interactions plugins

source/extensions/omni.flux.stage_manager.plugin.interaction.usd/omni/flux/stage_manager/plugin/interaction/usd/base/usd_base.py

@@ -285,6 +285,57 @@ def _evaluate_filtering_rules(self, prim_path: Sdf.Path) -> bool:
                     return True
         return False
 
+    def _expand_filtered_items(self):
+        """
+        Expand all items that are currently visible after filtering.
+        """
+        # Only expand if filters are active
+        if not any(f.enabled for f in self.filters):
+            return
+
+        def is_filter_modified(filter_obj):
+            """Check if any field in the filter has been modified from its default value."""
+            for field_name, field_info in filter_obj.model_fields.items():
+                # Skip standard or excluded fields
+                if (
+                    field_name in ["display_name", "tooltip", "enabled"]
+                    or field_name.startswith("_")
+                    or field_info.exclude is True
+                ):
+                    continue
+
+                current_value = getattr(filter_obj, field_name, None)
+                default_value = (
+                    field_info.default_factory() if field_info.default_factory is not None else field_info.default
+                )
+
+                # Skip filter_active if it's False, since that is the default state
+                if field_name == "filter_active" and current_value is False:
+                    continue
+
+                if (field_name == "filter_active" and current_value is True) or (current_value != default_value):
+                    return True
+            return False
+
+        if not any(is_filter_modified(f) for f in self.filters) and not any(
+            is_filter_modified(f) for f in self.additional_filters
+        ):
+            return
+
+        def expand_items(items):
+            for item in items:
+                if not item or not item.data:
+                    continue
+                self._item_expansion_states[hash(item)] = True
+
+                # Directly expand in the widget
+                if self._tree_widget:
+                    self._tree_widget.set_expanded(item, True, False)
+
+                expand_items(self.tree.model.get_item_children(item))
+
+        expand_items(self.tree.model.get_item_children(None))
+
     def _on_item_changed(self, model, item):
         # Convert `_on_item_changed` to an async method since `_update_context_items` is also async
         if self._items_changed_task:
@@ -302,3 +353,4 @@ async def _on_item_changed_async(self, model, item):
         # Wait for the updated items to be rendered
         await omni.kit.app.get_app().next_update_async()
         self._update_tree_selection()
+        self._expand_filtered_items()