Merge branch 'dev/sgillard/visibility_filter_sm' into 'main'

REMIX-4552: Adding visibility filter for stage manager

See merge request lightspeedrtx/lightspeed-kit!1066

Author: Shona Gillard

CHANGELOG.md

@@ -32,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 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
+- REMIX-4552: Added Visibility Filter to the Stage Manager
 
 ### Changed
 - Update hdremix and omni_core_materials to ext-822f7b6-main

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

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

source/extensions/lightspeed.trex.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.4.0]
+### Added
+- Added `VisiblePrimsFilterPlugin` to the interactions plugins
+
 ## [2.3.0]
 ### Added
 - Added `DeleteRestoreActionWidgetPlugin`

source/extensions/lightspeed.trex.stage_manager.plugin.interaction.usd/lightspeed/trex/stage_manager/plugin/interaction/usd/all_categories.py

@@ -36,6 +36,7 @@ class AllCategoriesInteractionPlugin(_StageManagerUSDInteractionPlugin):
             "IgnorePrimsFilterPlugin",
             "IsCaptureFilterPlugin",
             "IsCategoryFilterPlugin",
+            "VisiblePrimsFilterPlugin",
             "LightPrimsFilterPlugin",
             "MeshPrimsFilterPlugin",
             "OmniPrimsFilterPlugin",

source/extensions/lightspeed.trex.stage_manager.plugin.interaction.usd/lightspeed/trex/stage_manager/plugin/interaction/usd/all_meshes.py

@@ -40,6 +40,7 @@ class AllMeshesInteractionPlugin(_StageManagerUSDInteractionPlugin):
             "IgnorePrimsFilterPlugin",
             "IsCaptureFilterPlugin",
             "IsCategoryFilterPlugin",
+            "VisiblePrimsFilterPlugin",
             "LightPrimsFilterPlugin",
             "MeshPrimsFilterPlugin",
             "OmniPrimsFilterPlugin",

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.1"
+version = "2.5.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.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.5.0]
+### Added
+- Added `VisiblePrimsFilterPlugin`
+
 ## [2.4.1]
 ### Changed
 - Changed default value for SearchFilterPlugin

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

@@ -60,7 +60,10 @@ def build_item(self):
 
         with self._container:
             ui.Spacer(width=0)
-            self.filter_obj.build_ui()
+            with ui.VStack(width=0, spacing=ui.Pixel(4)):
+                self.filter_obj.build_ui()
+                if not isinstance(self.filter_obj, _ToggleableUSDFilterPlugin):
+                    ui.Spacer(width=0)
             ui.Spacer(width=0)
 
     def destroy(self):
@@ -75,8 +78,10 @@ def __init__(self, title, filters: list[_StageManagerUSDFilterPlugin], on_filter
         self.filters = filters
 
     def build_menu_items(self):
-        for item in self._delegate.items:
-            item.build_item()
+        with ui.VStack(width=0, spacing=ui.Pixel(4)):
+            ui.Spacer(width=0)
+            for item in self._delegate.items:
+                item.build_item()
 
 
 class AdditionalFiltersPopupMenuDelegate(PopupMenuDelegate):

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

@@ -27,6 +27,7 @@
 from .omni_prims import OmniPrimsFilterPlugin as _OmniPrimsFilterPlugin
 from .search import SearchFilterPlugin as _SearchFilterPlugin
 from .skeleton_prims import SkeletonPrimsFilterPlugin as _SkeletonPrimsFilterPlugin
+from .visible_prims import VisiblePrimsFilterPlugin as _VisiblePrimsFilterPlugin
 
 
 class StageManagerUSDFilterPluginsExtension(omni.ext.IExt):
@@ -39,6 +40,7 @@ class StageManagerUSDFilterPluginsExtension(omni.ext.IExt):
         _OmniPrimsFilterPlugin,
         _SearchFilterPlugin,
         _SkeletonPrimsFilterPlugin,
+        _VisiblePrimsFilterPlugin,
     ]
 
     def on_startup(self, _):

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

@@ -0,0 +1,77 @@
+"""
+* SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+* SPDX-License-Identifier: Apache-2.0
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* https://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+"""
+
+from typing import TYPE_CHECKING
+
+from omni import ui
+from omni.flux.stage_manager.factory import StageManagerItem as _StageManagerItem
+from omni.flux.stage_manager.plugin.filter.usd.base import StageManagerUSDFilterPlugin as _StageManagerUSDFilterPlugin
+from pxr import Usd, UsdGeom
+from pydantic import Field, PrivateAttr
+
+if TYPE_CHECKING:
+    from omni.flux.stage_manager.factory.plugins.tree_plugin import StageManagerTreeItem as _StageManagerTreeItem
+    from omni.flux.stage_manager.factory.plugins.tree_plugin import StageManagerTreeModel as _StageManagerTreeModel
+
+
+class VisiblePrimsFilterPlugin(_StageManagerUSDFilterPlugin):
+    display_name: str = Field(default="Visibility Filter", exclude=True)
+    tooltip: str = Field(default="Filter prims by their visibility status.", exclude=True)
+
+    visible_prims_type: str = Field(default="All Prims", description="Filter prims by their visibility status.")
+
+    _VISIBLE_PRIMS_DISPLAY_LABELS: dict = PrivateAttr(
+        default={"All": "All Prims", "Visible": "Visible Prims", "Hidden": "Hidden Prims"}
+    )
+    _COMBO_BOX_WIDTH: int = PrivateAttr(default=130)
+    _visible_prims_combobox: ui.ComboBox | None = PrivateAttr(default=None)
+    _current_index: int | None = PrivateAttr(default=None)
+    _current_attr: str | None = PrivateAttr(default=None)
+
+    def filter_predicate(self, item: _StageManagerItem) -> bool:
+        if self.visible_prims_type == "All Prims":
+            return True
+
+        imageable = UsdGeom.Imageable(item.data)
+        if not imageable:
+            return False
+
+        is_visible = imageable.ComputeVisibility(Usd.TimeCode.Default()) != UsdGeom.Tokens.invisible
+        if self.visible_prims_type == "Visible Prims":
+            return bool(is_visible)
+        if self.visible_prims_type == "Hidden Prims":
+            return bool(not is_visible)
+        return True
+
+    def build_ui(self):
+        with ui.HStack(spacing=ui.Pixel(8)):
+            ui.Spacer(width=0)
+            ui.Label(self.display_name, width=ui.Pixel(self._LABEL_WIDTH), alignment=ui.Alignment.RIGHT)
+            self._visible_prims_combobox = ui.ComboBox(
+                self._current_index or 0,
+                *self._VISIBLE_PRIMS_DISPLAY_LABELS.values(),
+                width=ui.Pixel(self._COMBO_BOX_WIDTH),
+            )
+            self._visible_prims_combobox.model.add_item_changed_fn(self._on_visible_prims_type_changed)
+
+    def _on_visible_prims_type_changed(self, model: "_StageManagerTreeModel", item: "_StageManagerTreeItem"):
+        selected_index = model.get_item_value_model().get_value_as_int()
+        self.visible_prims_type = list(self._VISIBLE_PRIMS_DISPLAY_LABELS.values())[selected_index]
+        self._current_index = selected_index
+        self._current_attr = list(self._VISIBLE_PRIMS_DISPLAY_LABELS.keys())[selected_index]
+
+        self._filter_items_changed()