REMIX-4792: Adding counter icon for additional filters

Author: Shona Gillard

CHANGELOG.md

@@ -28,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - REMIX-4719: Added Stage Manager Remix Logic Graph Interaction Action Plugin, And Logic Graph Filter
 - REMIX-4245: Added a generic Stage Prim Picker widget and implemented it in the Remix Logic Properties Panel.
 - REMIX-4774: Added select all, select none, and delete selection actions & hotkeys to the Remix Logic Graph Editor
+- REMIX-4792: Added a badge to the Additional Filters button to show the number of modified filters
 
 ### Changed
 - Update hdremix and omni_core_materials to ext-822f7b6-main

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.3.0"
+version = "2.4.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.4.0]
+### Added
+- Added a badge to the Additional Filters button to show the number of modified filters
+
 ## [2.3.0]
 ### Added
 - Added `AdditionalFilterPlugin`

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

@@ -130,6 +130,8 @@ class AdditionalFilterPlugin(_StageManagerUSDFilterPlugin):
     _modified_filters: list[_StageManagerUSDFilterPlugin] = PrivateAttr(default=[])
 
     _icon: ui.Image | None = PrivateAttr(default=None)
+    _counter_circle: ui.Circle | None = PrivateAttr(default=None)
+    _counter_label: ui.Label | None = PrivateAttr(default=None)
 
     def filter_predicate(self, item: _StageManagerItem) -> bool:
         # This filter is not used, it is only here to satisfy the interface
@@ -228,6 +230,15 @@ def _on_filter_changed(self):
         self._update_active_filters()
         if self._icon:
             self._icon.name = "FilterActive" if self._modified_filters else "Filter"
+        if self._counter_circle is None or self._counter_label is None:
+            return
+        if self._modified_filters:
+            self._counter_circle.visible = True
+            self._counter_label.visible = True
+            self._counter_label.text = str(len(self._modified_filters))
+        else:
+            self._counter_circle.visible = False
+            self._counter_label.visible = False
 
     def _on_button_clicked(self):
         self._update_active_filters()
@@ -238,15 +249,39 @@ def build_ui(self):  # noqa PLW0221
         # Gather available filters and update active filters
         if not self._active_filters:
             self._active_filters = self._get_available_filters()
-        else:
-            self._update_active_filters()
+
+        self._update_active_filters()
+
+        # Clean up existing UI elements if they exist
+        if self._icon:
+            self._icon.destroy()
+        if self._counter_circle:
+            self._counter_circle.destroy()
+        if self._counter_label:
+            self._counter_label.destroy()
 
         with ui.HStack(height=0):
-            self._icon = ui.Image(
-                "",
-                name="FilterActive" if self._modified_filters else "Filter",
-                tooltip="Additional Filters",
-                mouse_pressed_fn=lambda x, y, b, m: self._on_button_clicked(),
-                width=ui.Pixel(24),
-                height=ui.Pixel(24),
-            )
+            with ui.ZStack(width=ui.Pixel(24), height=ui.Pixel(24)):
+                self._icon = ui.Image(
+                    "",
+                    name="FilterActive" if self._modified_filters else "Filter",
+                    tooltip="Additional Filters",
+                    mouse_pressed_fn=lambda x, y, b, m: self._on_button_clicked(),
+                    width=ui.Pixel(24),
+                    height=ui.Pixel(24),
+                )
+
+                # A counter badge to show the number of modified filters.
+                # It is hidden by default and shown when there are modified filters.
+                count = len(self._modified_filters)
+                with ui.VStack(padding=8):
+                    with ui.HStack(padding=8):
+                        with ui.ZStack(width=ui.Pixel(14), height=ui.Pixel(14)):
+                            self._counter_circle = ui.Circle(radius=12, style={"background_color": 0xFF646464})
+                            self._counter_circle.visible = bool(self._modified_filters)
+                            self._counter_label = ui.Label(
+                                str(count), alignment=ui.Alignment.CENTER, style={"font_size": 10, "color": 0xFFFFFFFF}
+                            )
+                            self._counter_label.visible = bool(self._modified_filters)
+                        ui.Spacer()
+                    ui.Spacer()