feat: Adding Playback UI

Author: ganimtron-10

docs/examples/_valid_examples.toml

@@ -50,6 +50,7 @@ files = [
     "viz_textblock.py",
     "viz_sliders.py",
     "viz_button.py",
+    "viz_playback_panel.py",
 ]
 
 [animation]

docs/examples/viz_playback_panel.py

@@ -0,0 +1,73 @@
+"""
+================
+PlaybackPanel UI
+================
+"""
+
+import numpy as np
+from fury import actor, window
+from fury.ui import PlaybackPanel
+
+###############################################################################
+# 1. Create the Scene and a target actor (Rotating Cube)
+scene = window.Scene()
+
+centers = np.array([[0, 0, 0]])
+colors = np.array([[1, 0.5, 0]])
+cube = actor.box(centers, directions=(0, 1, 0), colors=colors, scales=(2, 2, 2))
+scene.add(cube)
+
+###############################################################################
+# 2. Initialize the PlaybackPanel
+
+playback_ui = PlaybackPanel(position=(50, 50), width=700, loop=True)
+playback_ui.final_time = 60.0
+scene.add(playback_ui)
+
+state = {"current_time": 0.0, "rotation_speed": 1.0}
+
+
+def on_progress_changed(t):
+    state["current_time"] = t
+    cube.local.rotation = (0, t * 10, 0)
+
+
+def on_speed_changed(s):
+    state["rotation_speed"] = s
+
+
+playback_ui.on_progress_bar_changed = on_progress_changed
+playback_ui.on_speed_changed = on_speed_changed
+
+###############################################################################
+# 5. Define the Callback
+
+
+def update_playback_logic(target_actor):
+    """Callback to sync animation state with UI."""
+    if playback_ui._playing:
+        step = 0.05 * state["rotation_speed"]
+        state["current_time"] += step
+
+        if state["current_time"] > playback_ui.final_time:
+            if playback_ui._loop:
+                state["current_time"] = 0
+            else:
+                state["current_time"] = playback_ui.final_time
+                playback_ui.pause()
+
+        playback_ui.current_time = state["current_time"]
+
+        target_actor.local.rotation = (0, 0, state["current_time"] * 0.01, 1)
+
+
+###############################################################################
+# 6. Start the ShowManager and Register the Callback
+
+show_m = window.ShowManager(
+    scene=scene, size=(800, 700), title="FURY Playback Panel UI"
+)
+
+show_m.register_callback(update_playback_logic, 0.05, True, "PlaybackSync", cube)
+
+show_m.start()

fury/ui/__init__.pyi

@@ -23,7 +23,7 @@ __all__ = [
     #     "FileMenu2D",
     #     "DrawShape",
     #     "DrawPanel",
-    #     "PlaybackPanel",
+    "PlaybackPanel",
     #     "Card2D",
     #     "SpinBox",
     "UI",
@@ -48,7 +48,7 @@ __all__ = [
 from .containers import Panel2D
 from .context import UIContext
 from .core import UI, Anchor, Disk2D, Rectangle2D, TextBlock2D
-from .elements import LineSlider2D, TextButton2D, TexturedButton2D
+from .elements import LineSlider2D, PlaybackPanel, TextButton2D, TexturedButton2D
 
 # from .elements import (
 #     Card2D,

fury/ui/core.py

@@ -301,6 +301,8 @@ def z_order(self, z_order):
             raise ValueError("Z-order must be an integer.")
 
         self._z_order = z_order
+        for child in self._children:
+            child.z_order = z_order
         UIContext.z_order_bounds = z_order
 
     @abc.abstractmethod
@@ -343,6 +345,9 @@ def set_visibility(self, visibility):
         for actor in self.actors:
             actor.visible = visibility
 
+        for child in self._children:
+            child.set_visibility(visibility)
+
     def handle_events(self, actor):
         """Attach event handlers to the UI object.
 
@@ -565,9 +570,7 @@ def _setup(self):
         Create the plane actor used internally.
         """
         geo = plane_geometry(width=1, height=1)
-        mat = _create_mesh_material(
-            material="basic", enable_picking=True, flat_shading=True
-        )
+        mat = _create_mesh_material(material="basic", alpha_mode="auto")
         self.actor = create_mesh(geometry=geo, material=mat)
 
         self.handle_events(self.actor)
@@ -647,6 +650,8 @@ def resize(self, size):
         size : (float, float)
             Rectangle size (width, height) in pixels.
         """
+        if tuple(size) == (0, 0):
+            size = np.array([1, 1])
         self.actor.geometry = plane_geometry(width=size[0], height=size[1])
         self._update_actors_position()
 
@@ -762,9 +767,7 @@ def _setup(self):
             inner_radius=self.inner_radius, outer_radius=self.outer_radius
         )
         geo = buffer_to_geometry(positions=positions, indices=indices)
-        mat = _create_mesh_material(
-            material="basic", enable_picking=True, flat_shading=True
-        )
+        mat = _create_mesh_material(material="basic", alpha_mode="auto")
         self.actor = create_mesh(geometry=geo, material=mat)
 
         self.handle_events(self.actor)
@@ -1006,6 +1009,7 @@ def _setup(self):
             markdown=self._message, screen_space=True, anchor="middle-center"
         )
         self.background = Rectangle2D()
+        self._children.append(self.background)
         self.handle_events(self.actor)
 
     def resize(self, size):
@@ -1040,7 +1044,7 @@ def _get_actors(self):
         list
             List containing the text actor and background actors.
         """
-        return [self.actor] + self.background.actors
+        return [self.actor]
 
     def get_formatted_text(self, text):
         """Format the given text with markdown syntax for bold/italic styles.
@@ -1611,7 +1615,8 @@ def _get_actors(self):
             List containing the child actor(s).
         """
         if self.child:
-            if isinstance(self.child, UI):
-                return self.child.actors
-            return [self.child]
+            if not isinstance(self.child, UI):
+                return [self.child]
+            else:
+                self._children.append(self.child)
         return []