Merge branch 'dev/e-man/deoptimizing-to-optimize-again' into 'main'

REMIX-4801 - Removing the skip decorator prior to the show() method pattern

See merge request lightspeedrtx/lightspeed-kit!1068

Author: Emanuel Kozerski

CHANGELOG.md

@@ -51,6 +51,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - REMIX-4818: FilePicker now supports automatic conversion to relative paths for USD edit target compliance
 - REMIX-4816: Improved logic graph properties panel UI with icon buttons and clearer dialog messages
 - Update hdremix and omni_core_materials to ext-83e59c6-main
+- REMIX-4801: Replaced decorator-based widget visibility filtering with subscription lifecycle management
 
 ### Fixed
 - Improved Pyright configuration by generating a list of search paths

source/extensions/lightspeed.trex.capture_tree.model/config/extension.toml

@@ -1,5 +1,5 @@
 [package]
-version = "1.4.0"
+version = "1.5.0"
 authors =["Damien Bataille <[email protected]>", "Pierre-Olivier Trottier <[email protected]>"]
 title = "NVIDIA RTX Remix Capture Tree Model and Delegate"
 description = "Model, Delegate and Item classes for a TreeView to display Captures"

source/extensions/lightspeed.trex.capture_tree.model/docs/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [1.5.0]
+### Added
+- Added semantic event subscriptions: subscribe_stage_opened_or_closed(), subscribe_sublayers_changed()
+- Added layer event handling in enable_listeners() for sublayer changes
+
+### Changed
+- Model now owns all data-related event subscriptions, widgets subscribe to model events
+
 ## [1.4.0]
 ### Added
 - Added progress data caching for improved performance

source/extensions/lightspeed.trex.capture_tree.model/lightspeed/trex/capture_tree/model/model.py

@@ -24,6 +24,7 @@
 from omni.flux.utils.common import EventSubscription as _EventSubscription
 from omni.flux.utils.common import deferred_destroy_tasks as _deferred_destroy_tasks
 from omni.flux.utils.common import reset_default_attrs as _reset_default_attrs
+from omni.kit.usd import layers as _layers
 
 from .items import CaptureTreeItem
 
@@ -44,6 +45,7 @@ def __init__(self, context_name, show_progress: bool = True):
             "_core_capture": None,
             "_core_replacement": None,
             "_stage_event_sub": None,
+            "_layer_event_sub": None,
             "_fetch_task": None,
             "_progress_cache": None,
         }
@@ -57,12 +59,17 @@ def __init__(self, context_name, show_progress: bool = True):
         self._core_replacement = _ReplacementCoreSetup(context_name)
 
         self._stage_event_sub = None
+        self._layer_event_sub = None
         self._fetch_task = None
 
         self.__children = []
         # Cache for progress data accessible by path
         self._progress_cache: dict[str, tuple[int, int]] = {}
+
+        # Events
         self.__on_progress_updated = _Event()
+        self.__on_stage_opened_or_closed = _Event()
+        self.__on_sublayers_changed = _Event()
 
     def refresh(self, paths: list[tuple[str, str]]):
         """Refresh the list"""
@@ -104,17 +111,31 @@ def enable_listeners(self, value: bool):
                 .get_stage_event_stream()
                 .create_subscription_to_pop(self.__on_stage_event, name="STAGE_CHANGED_SUB")
             )
+            self._layer_event_sub = (
+                _layers.get_layers()
+                .get_event_stream()
+                .create_subscription_to_pop(self.__on_layer_event, name="LAYER_CHANGED_SUB")
+            )
         else:
             self._stage_event_sub = None
+            self._layer_event_sub = None
 
     def fetch_progress(self, items: list[CaptureTreeItem] | None = None):
         self.cancel_tasks()
         self._fetch_task = asyncio.ensure_future(self.__fetch_progress(items))
 
     def __on_stage_event(self, event):
-        if event.type not in [int(usd.StageEventType.CLOSING), int(usd.StageEventType.CLOSED)]:
+        if event.type in [int(usd.StageEventType.CLOSING), int(usd.StageEventType.CLOSED)]:
+            self.cancel_tasks()
+        if event.type in [int(usd.StageEventType.OPENED), int(usd.StageEventType.CLOSED)]:
+            self.__on_stage_opened_or_closed()
+
+    def __on_layer_event(self, event):
+        payload = _layers.get_layer_event_payload(event)
+        if not payload:
             return
-        self.cancel_tasks()
+        if payload.event_type == _layers.LayerEventType.SUBLAYERS_CHANGED:
+            self.__on_sublayers_changed()
 
     def __task_completed(self):
         if self._fetch_task is not None:
@@ -162,6 +183,20 @@ def subscribe_progress_updated(self, func):
         """
         return _EventSubscription(self.__on_progress_updated, func)
 
+    def subscribe_stage_opened_or_closed(self, func):
+        """
+        Subscribe to stage opened/closed events.
+        Return the object that will automatically unsubscribe when destroyed.
+        """
+        return _EventSubscription(self.__on_stage_opened_or_closed, func)
+
+    def subscribe_sublayers_changed(self, func):
+        """
+        Subscribe to sublayers changed events.
+        Return the object that will automatically unsubscribe when destroyed.
+        """
+        return _EventSubscription(self.__on_sublayers_changed, func)
+
     def destroy(self):
         asyncio.ensure_future(self._deferred_destroy())
 

source/extensions/lightspeed.trex.capture_tree.model/lightspeed/trex/capture_tree/model/tests/__init__.py

@@ -15,4 +15,5 @@
 * limitations under the License.
 """
 
-from .e2e.test_tree import *
+from .e2e.test_tree import TestTreeWidget
+from .unit.test_enable_listeners import TestCaptureTreeModelEnableListeners

…ed/mass_ingestion/tests/unit/__init__.py …apture_tree/model/tests/unit/__init__.pysource/extensions/lightspeed.trex.layout.shared.mass_ingestion/lightspeed/trex/layout/shared/mass_ingestion/tests/unit/__init__.py renamed to source/extensions/lightspeed.trex.capture_tree.model/lightspeed/trex/capture_tree/model/tests/unit/__init__.py source/extensions/lightspeed.trex.layout.shared.mass_ingestion/lightspeed/trex/layout/shared/mass_ingestion/tests/unit/__init__.py renamed to source/extensions/lightspeed.trex.capture_tree.model/lightspeed/trex/capture_tree/model/tests/unit/__init__.py

@@ -0,0 +1,86 @@
+"""
+* SPDX-FileCopyrightText: Copyright (c) 2025 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 lightspeed.trex.capture_tree.model import CaptureTreeModel
+from omni.kit.test import AsyncTestCase
+
+
+class TestCaptureTreeModelEnableListeners(AsyncTestCase):
+    """Test that CaptureTreeModel.enable_listeners() properly creates/destroys subscriptions."""
+
+    async def test_subscriptions_none_by_default(self):
+        """Test that subscriptions are None when model is created."""
+        model = CaptureTreeModel("")
+
+        self.assertIsNone(model._stage_event_sub)  # noqa: PLW0212
+        self.assertIsNone(model._layer_event_sub)  # noqa: PLW0212
+
+        model.destroy()
+
+    async def test_subscriptions_created_when_enabled(self):
+        """Test that subscriptions are created when enable_listeners(True) is called."""
+        model = CaptureTreeModel("")
+
+        model.enable_listeners(True)
+
+        self.assertIsNotNone(model._stage_event_sub)  # noqa: PLW0212
+        self.assertIsNotNone(model._layer_event_sub)  # noqa: PLW0212
+
+        model.enable_listeners(False)
+        model.destroy()
+
+    async def test_subscriptions_destroyed_when_disabled(self):
+        """Test that subscriptions are destroyed when enable_listeners(False) is called."""
+        model = CaptureTreeModel("")
+
+        # First enable
+        model.enable_listeners(True)
+        self.assertIsNotNone(model._stage_event_sub)  # noqa: PLW0212
+        self.assertIsNotNone(model._layer_event_sub)  # noqa: PLW0212
+
+        # Then disable
+        model.enable_listeners(False)
+        self.assertIsNone(model._stage_event_sub)  # noqa: PLW0212
+        self.assertIsNone(model._layer_event_sub)  # noqa: PLW0212
+
+        model.destroy()
+
+    async def test_subscriptions_toggle_multiple_times(self):
+        """Test that subscriptions can be toggled on/off multiple times."""
+        model = CaptureTreeModel("")
+
+        # Toggle on
+        model.enable_listeners(True)
+        self.assertIsNotNone(model._stage_event_sub)  # noqa: PLW0212
+        self.assertIsNotNone(model._layer_event_sub)  # noqa: PLW0212
+
+        # Toggle off
+        model.enable_listeners(False)
+        self.assertIsNone(model._stage_event_sub)  # noqa: PLW0212
+        self.assertIsNone(model._layer_event_sub)  # noqa: PLW0212
+
+        # Toggle on again
+        model.enable_listeners(True)
+        self.assertIsNotNone(model._stage_event_sub)  # noqa: PLW0212
+        self.assertIsNotNone(model._layer_event_sub)  # noqa: PLW0212
+
+        # Toggle off again
+        model.enable_listeners(False)
+        self.assertIsNone(model._stage_event_sub)  # noqa: PLW0212
+        self.assertIsNone(model._layer_event_sub)  # noqa: PLW0212
+
+        model.destroy()

source/extensions/lightspeed.trex.capture_tree.model/lightspeed/trex/capture_tree/model/tests/unit/test_enable_listeners.py

@@ -1,5 +1,5 @@
 [package]
-version = "1.1.0"
+version = "1.1.1"
 authors =["Emanuel Kozerski <[email protected]>"]
 title = "NVIDIA RTX Remix Capture Tree UI Widget"
 description = "Creates a windowed widget with a TreeView to display game Captures from a given path."

source/extensions/lightspeed.trex.capture_tree.widget/config/extension.toml

@@ -1,6 +1,11 @@
 # Changelog
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [1.1.1]
+### Changed
+- Refactored to use model's semantic events instead of direct stage/layer subscriptions
+- Subscriptions now created in __init__ and controlled by model.enable_listeners()
+
 ## [1.1.0]
 ### Added
 - Added WorkspaceWidget interface implementation

source/extensions/lightspeed.trex.capture_tree.widget/docs/CHANGELOG.md

@@ -23,7 +23,6 @@
 import omni.appwindow
 import omni.client
 import omni.kit
-import omni.kit.usd.layers as _layers
 import omni.ui as ui
 import omni.usd
 from lightspeed.common.constants import GlobalEventNames as _GlobalEventNames
@@ -33,7 +32,6 @@
 from lightspeed.trex.capture_tree.model import CaptureTreeDelegate, CaptureTreeModel
 from lightspeed.trex.replacement.core.shared import Setup as ReplacementCoreSetup
 from lightspeed.trex.utils.widget import TrexMessageDialog, WorkspaceWidget
-from lightspeed.trex.utils.widget.decorators import skip_when_widget_is_invisible
 from omni.flux.property_widget_builder.model.file import FileAttributeItem as _FileAttributeItem
 from omni.flux.property_widget_builder.model.file import FileDelegate as _FileDelegate
 from omni.flux.property_widget_builder.model.file import FileModel as _FileModel
@@ -59,6 +57,7 @@ class CaptureWidget(WorkspaceWidget):
     PROPERTY_NAME_COLUMN_WIDTH = ui.Pixel(150)
 
     def __init__(self, context_name):
+        super().__init__()
         self._context = omni.usd.get_context(context_name)
         self.__file_listener_instance = _get_file_listener_instance()
         self._last_capture_tree_view_window_selection = None
@@ -81,38 +80,26 @@ def __init__(self, context_name):
         self._core_replacement = ReplacementCoreSetup(context_name)
         self._game_icon_hovered_task = None
 
+        # Subscribe to model events (always active - model controls when events fire via enable_listeners)
         self._sub_model_changed = self._capture_tree_model.subscribe_progress_updated(self._refresh_trees)
-        self._sub_stage_event = self._context.get_stage_event_stream().create_subscription_to_pop(
-            self.__on_stage_event, name="StageChanged"
-        )
+        self._sub_stage_event = self._capture_tree_model.subscribe_stage_opened_or_closed(self.__on_event)
+        self._sub_layer_event = self._capture_tree_model.subscribe_sublayers_changed(self.__on_event)
 
-        self._layers = _layers.get_layers()
-        self._sub_layer_event = self._layers.get_event_stream().create_subscription_to_pop(
-            self.__on_layer_event, name="LayerChange"
-        )
         self.__create_ui()
 
-    def show(self, visible):
+    def show(self, visible: bool):
+        super().show(visible)
         self._capture_tree_model.enable_listeners(visible)
         self.root_widget.visible = visible
+
         if visible:
             self.refresh_capture_detail_panel()
         else:
             self._capture_tree_model.cancel_tasks()
             self._destroy_capture_properties()
 
-    @skip_when_widget_is_invisible(widget="root_widget")
-    def __on_layer_event(self, event):
-        """Layer event callback - automatically filtered when widget invisible."""
-        payload = _layers.get_layer_event_payload(event)
-        if not payload:
-            return
-        if payload.event_type == _layers.LayerEventType.SUBLAYERS_CHANGED:
-            self.__on_event()
-
-    @skip_when_widget_is_invisible(widget="root_widget")
     def _refresh_trees(self, *_):
-        """Model progress callback - automatically filtered when widget invisible."""
+        """Model progress callback - subscription destroyed when window invisible."""
         if self._capture_tree_view_window:
             self._capture_tree_view_window.dirty_widgets()
         if self._capture_tree_view:
@@ -362,14 +349,6 @@ def _show_error_popup(self, title, message):
         self._error_popup.show()
         carb.log_error(message)
 
-    @skip_when_widget_is_invisible(widget="root_widget")
-    def __on_stage_event(self, event):
-        if event.type in [
-            int(omni.usd.StageEventType.CLOSED),
-            int(omni.usd.StageEventType.OPENED),
-        ]:
-            self.__on_event()
-
     def __on_event(self):
         self.refresh_capture_detail_panel()