Viewer reset and functions for remove (#280)

- reset - removes all views and reset the state of the editor
- removeScene
- removeView

Signed-off-by: Petra Hapalova <phapalova@nvidia.com>

Author: phapalova

fvdb/_Cpp.pyi

@@ -974,9 +974,12 @@ class Viewer:
     def __init__(self, ip_address: str, port: int, device_id: int, verbose: bool) -> None: ...
     def port(self) -> int: ...
     def ip_address(self) -> str: ...
+    def reset(self) -> None: ...
     def add_scene(self, scene_name: str) -> None: ...
+    def remove_scene(self, scene_name: str) -> None: ...
+    def remove_view(self, scene_name: str, name: str) -> None: ...
     def add_gaussian_splat_3d_view(
-        scene_name: str, self, name: str, gaussian_splat_3d: GaussianSplat3d
+        self, scene_name: str, name: str, gaussian_splat_3d: GaussianSplat3d
     ) -> GaussianSplat3dView: ...
     def has_gaussian_splat_3d_view(self, name: str) -> bool: ...
     def get_gaussian_splat_3d_view(self, name: str) -> GaussianSplat3dView: ...

fvdb/viz/_scene.py

@@ -45,6 +45,21 @@ def __init__(self, name: str):
         server = _get_viewer_server_cpp()
         server.add_scene(name)
 
+    def __del__(self):
+        """
+        Delete the scene. This will remove the scene and its views from the viewer.
+        """
+        server = _get_viewer_server_cpp()
+        server.remove_scene(self._name)
+
+    def reset(self):
+        """
+        Reset the scene. This will reset viewer server state and clear all views in the scene.
+        """
+        server = _get_viewer_server_cpp()
+        server.reset()
+        server.add_scene(self._name)
+
     @torch.no_grad()
     def add_point_cloud(
         self,

fvdb/viz/_viewer_server.py

@@ -105,3 +105,34 @@ def show():
         pass
 
     webbrowser.open_new_tab(url)
+
+
+def reset():
+    """
+    Reset the viewer server state. This will clear all scenes and views and ads back the default scene.
+    """
+    viewer_server = _get_viewer_server_cpp()
+    viewer_server.reset()
+
+
+def remove_scene(scene_name: str):
+    """
+    Remove a scene from the viewer server.
+
+    Args:
+        scene_name (str): The name of the scene to remove.
+    """
+    viewer_server = _get_viewer_server_cpp()
+    viewer_server.remove_scene(scene_name)
+
+
+def remove_view(scene_name: str, name: str):
+    """
+    Remove a view from the viewer server.
+
+    Args:
+        scene_name (str): The name of the scene view belongs to.
+        name (str): The name of the view to remove.
+    """
+    viewer_server = _get_viewer_server_cpp()
+    viewer_server.remove_view(scene_name, name)

src/cmake/get_nanovdb_editor.cmake

@@ -15,7 +15,7 @@ option(NANOVDB_EDITOR_SKIP "Skip nanovdb_editor wheel build" OFF)
 set(NANOVDB_EDITOR_BUILD_TYPE "Release" CACHE STRING "Build type for nanovdb_editor (Release/Debug)")
 
 # For fVDB main use nanovdb-editor main
-set(NANOVDB_EDITOR_TAG f71090f9c45f11fb57ee640c5bca63086cfcf8b6)
+set(NANOVDB_EDITOR_TAG 5132a9ae4f74098a990e729139ca73fea1e4b807)
 set(NANOVDB_EDITOR_VERSION 0.0.7)   # version at this commit
 
 # If skip is set, get the latest tagged version to prevent unnecessary rebuilds each hash update

src/fvdb/detail/viewer/Viewer.cpp

@@ -115,10 +115,6 @@ Viewer::Viewer(const std::string &ipAddress,
 
     startServer();
 }
-void
-Viewer::setSceneName(const std::string &scene_name) {
-    mCurrentSceneName = scene_name;
-}
 
 Viewer::~Viewer() {
     stopServer();
@@ -134,6 +130,53 @@ Viewer::~Viewer() {
     pnanovdb_compiler_free(&mEditor.compiler);
 }
 
+void
+Viewer::reset() {
+    mEditor.editor.reset(&mEditor.editor);
+
+    mCameraViews.clear();
+    mSplat3dViews.clear();
+}
+
+void
+Viewer::addScene(const std::string &scene_name) {
+    pnanovdb_camera_init(&mEditor.camera);
+    updateCamera(scene_name);
+}
+
+void
+Viewer::removeScene(const std::string &scene_name) {
+    pnanovdb_editor_token_t *sceneToken = mEditor.editor.get_token(scene_name.c_str());
+    mEditor.editor.remove(&mEditor.editor, sceneToken, nullptr);
+
+    // Erase all camera views belonging to the removed scene
+    for (auto it = mCameraViews.begin(); it != mCameraViews.end();) {
+        if (it->second.mSceneToken == sceneToken) {
+            it = mCameraViews.erase(it);
+        } else {
+            ++it;
+        }
+    }
+    // Erase all splat 3d views belonging to the removed scene
+    for (auto it = mSplat3dViews.begin(); it != mSplat3dViews.end();) {
+        if (it->second.mSceneToken == sceneToken) {
+            it = mSplat3dViews.erase(it);
+        } else {
+            ++it;
+        }
+    }
+}
+
+void
+Viewer::removeView(const std::string &scene_name, const std::string &name) {
+    pnanovdb_editor_token_t *sceneToken = mEditor.editor.get_token(scene_name.c_str());
+    pnanovdb_editor_token_t *viewToken  = mEditor.editor.get_token(name.c_str());
+    mEditor.editor.remove(&mEditor.editor, sceneToken, viewToken);
+
+    mCameraViews.erase(name);
+    mSplat3dViews.erase(name);
+}
+
 fvdb::detail::viewer::GaussianSplat3dView &
 Viewer::addGaussianSplat3dView(const std::string &scene_name,
                                const std::string &name,

src/fvdb/detail/viewer/Viewer.h

@@ -53,11 +53,15 @@ class Viewer {
            const bool verbose = false);
     ~Viewer();
 
-    void
-    addScene(const std::string &scene_name) {
-        pnanovdb_camera_init(&mEditor.camera);
-        updateCamera(scene_name);
-    }
+    void reset();
+
+    void setSceneName(const std::string &scene_name);
+
+    void addScene(const std::string &scene_name);
+
+    void removeScene(const std::string &scene_name);
+
+    void removeView(const std::string &scene_name, const std::string &view_name);
 
     pnanovdb_editor_token_t *
     getToken(const std::string &name) const {
@@ -131,8 +135,6 @@ class Viewer {
     port() const {
         return mPort;
     };
-
-    void setSceneName(const std::string &scene_name);
 };
 
 } // namespace fvdb::detail::viewer

src/python/ViewerBinding.cpp

@@ -109,11 +109,24 @@ bind_viewer(py::module &m) {
              &fvdb::detail::viewer::Viewer::port,
              "The port the viewer server is listening on.")
 
+        .def("reset", &fvdb::detail::viewer::Viewer::reset, "Reset the viewer server state")
+
         .def("add_scene",
              &fvdb::detail::viewer::Viewer::addScene,
              py::arg("scene_name"),
              "Add a new scene to the viewer")
 
+        .def("remove_scene",
+             &fvdb::detail::viewer::Viewer::removeScene,
+             py::arg("scene_name"),
+             "Remove a scene from the viewer")
+
+        .def("remove_view",
+             &fvdb::detail::viewer::Viewer::removeView,
+             py::arg("scene_name"),
+             py::arg("name"),
+             "Remove a view from a scene")
+
         .def("camera_orbit_center",
              &fvdb::detail::viewer::Viewer::cameraOrbitCenter,
              py::arg("scene_name"),
@@ -214,9 +227,5 @@ bind_viewer(py::module &m) {
              &fvdb::detail::viewer::Viewer::getCameraView,
              py::arg("name"),
              py::return_value_policy::reference_internal,
-             "Get a camera view by name")
-        .def("set_scene_name",
-             &fvdb::detail::viewer::Viewer::setSceneName,
-             py::arg("scene_name"),
-             "Set the current scene name");
+             "Get a camera view by name");
 }