viser4d 0.1.1__tar.gz

viser4d-0.1.1/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Andrea Boscolo Camiletto
+
+   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
+
+       http://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.

viser4d-0.1.1/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: viser4d
+Version: 0.1.1
+Summary: A viser extension with out-of-the-box support for the time dimension
+Author-email: Andrea Boscolo Camiletto <abcamiletto@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/abcamiletto/viser4d
+Project-URL: Repository, https://github.com/abcamiletto/viser4d
+Project-URL: Issues, https://github.com/abcamiletto/viser4d/issues
+Keywords: viser,visualization,3d,timeline,animation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cloudpickle>=3.0.0
+Requires-Dist: numpy>=2.4.1
+Requires-Dist: objsize>=0.7.0
+Requires-Dist: viser>=1.0.19
+Requires-Dist: zstandard>=0.23.0
+Dynamic: license-file
+
+# viser4d
+
+viser4d is a small wrapper around `viser` that adds a time dimension. It records
+scene operations across timesteps and can seek or play them back.
+
+## Quickstart
+
+```bash
+pip install -e .
+```
+
+```python
+import numpy as np
+import viser4d
+
+server = viser4d.Viser4dServer(num_steps=10)
+
+point_cloud = None
+for i in range(10):
+    with server.at(i):
+        points = np.random.uniform(-1.0, 1.0, size=(200, 3))
+        if point_cloud is None:
+            point_cloud = server.scene.add_point_cloud(
+                "/points",
+                points=points,
+                colors=(255, 200, 0),
+            )
+        else:
+            point_cloud.points = points
+
+server.play(fps=10, loop=True)
+server.sleep_forever()
+```
+
+## Timestep callbacks
+
+If you have your own visualization logic and just want to use viser4d's timeline
+infrastructure (playback controls, seeking, scrubbing), you can register a
+callback that fires whenever the timestep changes:
+
+```python
+import viser4d
+
+server = viser4d.Viser4dServer(num_steps=100)
+
+def on_timestep(t: int) -> None:
+    # Update your custom visualizations here
+    update_video_frames(t)
+    update_body_meshes(t)
+    update_3d_keypoints(t)
+
+server.on_timestep_change(on_timestep)
+server.play(fps=30, loop=True)
+server.sleep_forever()
+```
+
+Callbacks are invoked after viser4d applies its own recorded state, so you can
+mix both approaches - record some operations with `at(t)` and handle others via
+callbacks.
+
+## How it works
+
+Context determines behavior. `server.scene` always returns the same `ProxyScene` object, but
+it behaves differently based on whether you're inside an `at(t)` context:
+
+```
+Inside at(t):                          Outside at(t):
+─────────────                          ──────────────
+scene.add_frame(...)                   scene.add_frame(...)
+       │                                      │
+       ▼                                      ▼
+    records to Timeline                    forwards to live viser scene
+```
+
+- **Inside `at(t)`**: Operations are recorded to a timeline, not executed.
+- **Outside `at(t)`**: Operations forward directly to viser's live scene.
+- **Playback**: `seek(t)` or `play()` applies recorded state to the live scene.
+
+See `examples/` for more.
+
+## Quality checks
+
+```bash
+uvx ruff format .
+uvx ruff check .
+uvx ty check
+```
+
+## Tests
+
+```bash
+uv run --group dev pytest -q
+```

viser4d-0.1.1/README.md

@@ -0,0 +1,93 @@
+# viser4d
+
+viser4d is a small wrapper around `viser` that adds a time dimension. It records
+scene operations across timesteps and can seek or play them back.
+
+## Quickstart
+
+```bash
+pip install -e .
+```
+
+```python
+import numpy as np
+import viser4d
+
+server = viser4d.Viser4dServer(num_steps=10)
+
+point_cloud = None
+for i in range(10):
+    with server.at(i):
+        points = np.random.uniform(-1.0, 1.0, size=(200, 3))
+        if point_cloud is None:
+            point_cloud = server.scene.add_point_cloud(
+                "/points",
+                points=points,
+                colors=(255, 200, 0),
+            )
+        else:
+            point_cloud.points = points
+
+server.play(fps=10, loop=True)
+server.sleep_forever()
+```
+
+## Timestep callbacks
+
+If you have your own visualization logic and just want to use viser4d's timeline
+infrastructure (playback controls, seeking, scrubbing), you can register a
+callback that fires whenever the timestep changes:
+
+```python
+import viser4d
+
+server = viser4d.Viser4dServer(num_steps=100)
+
+def on_timestep(t: int) -> None:
+    # Update your custom visualizations here
+    update_video_frames(t)
+    update_body_meshes(t)
+    update_3d_keypoints(t)
+
+server.on_timestep_change(on_timestep)
+server.play(fps=30, loop=True)
+server.sleep_forever()
+```
+
+Callbacks are invoked after viser4d applies its own recorded state, so you can
+mix both approaches - record some operations with `at(t)` and handle others via
+callbacks.
+
+## How it works
+
+Context determines behavior. `server.scene` always returns the same `ProxyScene` object, but
+it behaves differently based on whether you're inside an `at(t)` context:
+
+```
+Inside at(t):                          Outside at(t):
+─────────────                          ──────────────
+scene.add_frame(...)                   scene.add_frame(...)
+       │                                      │
+       ▼                                      ▼
+    records to Timeline                    forwards to live viser scene
+```
+
+- **Inside `at(t)`**: Operations are recorded to a timeline, not executed.
+- **Outside `at(t)`**: Operations forward directly to viser's live scene.
+- **Playback**: `seek(t)` or `play()` applies recorded state to the live scene.
+
+See `examples/` for more.
+
+## Quality checks
+
+```bash
+uvx ruff format .
+uvx ruff check .
+uvx ty check
+```
+
+## Tests
+
+```bash
+uv run --group dev pytest -q
+```

viser4d-0.1.1/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "viser4d"
+version = "0.1.1"
+description = "A viser extension with out-of-the-box support for the time dimension"
+readme = "README.md"
+license = "Apache-2.0"
+authors = [{ name = "Andrea Boscolo Camiletto", email = "abcamiletto@gmail.com" }]
+keywords = ["viser", "visualization", "3d", "timeline", "animation"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Visualization",
+]
+requires-python = ">=3.13"
+dependencies = [
+    "cloudpickle>=3.0.0",
+    "numpy>=2.4.1",
+    "objsize>=0.7.0",
+    "viser>=1.0.19",
+    "zstandard>=0.23.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/abcamiletto/viser4d"
+Repository = "https://github.com/abcamiletto/viser4d"
+Issues = "https://github.com/abcamiletto/viser4d/issues"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.4",
+    "ty>=0.0.1a7",
+]
+
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

viser4d-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

viser4d-0.1.1/src/viser4d/__init__.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+import viser as _viser
+
+from .op import CompressionMode
+from .server import Viser4dServer
+
+__all__ = ["CompressionMode", "Viser4dServer"]
+
+
+def __getattr__(name: str):
+    return getattr(_viser, name)
+
+
+def __dir__():
+    return sorted(set(__all__) | set(dir(_viser)))

viser4d-0.1.1/src/viser4d/gui.py

@@ -0,0 +1,114 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .server import Viser4dServer
+
+
+class PlaybackControls:
+    """GUI controls for timeline playback.
+
+    Registers itself as a timestep listener and manages its own state based on
+    user interactions and timestep callbacks.
+    """
+
+    def __init__(self, server: Viser4dServer) -> None:
+        self._server = server
+        self._playing = False
+        self._suppress_slider = False
+        self._suppress_fps = False
+
+        with server.gui.add_folder("Playback"):
+            self._play_button = server.gui.add_button("Play", order=0)
+            self._slider = server.gui.add_slider(
+                "Timestep",
+                min=0,
+                max=server.num_steps - 1,
+                step=1,
+                initial_value=0,
+                order=1,
+            )
+            self._step_buttons = server.gui.add_button_group(
+                "",
+                ("Prev", "Next"),
+                order=2,
+            )
+            self._fps_slider = server.gui.add_slider(
+                "FPS",
+                min=1.0,
+                max=60.0,
+                step=1.0,
+                initial_value=server._fps,
+                order=3,
+            )
+
+        self._play_button.on_click(self._on_play_button)
+        self._step_buttons.on_click(self._on_step)
+        self._slider.on_update(self._on_slider)
+        self._fps_slider.on_update(self._on_fps)
+
+        # Register as timestep listener
+        server.on_timestep_change(self._on_timestep)
+
+    def _on_timestep(self, t: int) -> None:
+        """Handle timestep changes from the server."""
+        # Update slider
+        if self._slider.value != t:
+            self._suppress_slider = True
+            self._slider.value = t
+            self._suppress_slider = False
+
+        # Detect playback ended (reached last frame while playing, non-looping)
+        if self._playing and t == self._server.num_steps - 1:
+            # Check if playback actually stopped (not looping)
+            # We'll get another callback if it loops, so defer the check
+            pass  # Handled by server calling set_playing(False)
+
+    def set_fps(self, fps: float) -> None:
+        """Update the FPS slider value."""
+        if self._fps_slider.value == fps:
+            return
+        self._suppress_fps = True
+        self._fps_slider.value = fps
+        self._suppress_fps = False
+
+    def set_playing(self, playing: bool) -> None:
+        """Update the play/pause button state."""
+        if self._playing == playing:
+            return
+        self._playing = playing
+        self._play_button.label = "Pause" if playing else "Play"
+
+    def _on_slider(self, event) -> None:
+        """Handle user dragging the timestep slider."""
+        if self._suppress_slider:
+            return
+        self._server.seek(event.target.value)
+
+    def _on_step(self, event) -> None:
+        """Handle prev/next button clicks."""
+        current = self._slider.value
+        if event.target.value == "Prev":
+            if current > 0:
+                self._server.seek(current - 1)
+        else:
+            if current < self._server.num_steps - 1:
+                self._server.seek(current + 1)
+
+    def _on_play_button(self, _event) -> None:
+        """Handle play/pause button clicks."""
+        if self._playing:
+            self._playing = False
+            self._play_button.label = "Play"
+            self._server.pause()
+        else:
+            self._playing = True
+            self._play_button.label = "Pause"
+            self._server.play(self._fps_slider.value)
+
+    def _on_fps(self, event) -> None:
+        """Handle FPS slider changes."""
+        if self._suppress_fps:
+            return
+        self._server._set_fps(event.target.value)