From c3bcee89a33864efec125dbe5334d1e21fa62816 Mon Sep 17 00:00:00 2001 From: Gina Wu <42229107+ginazhouhuiwu@users.noreply.github.com> Date: Fri, 28 Jun 2024 13:27:19 -0700 Subject: [PATCH] Bump viser (#3234) * Bump viser to 0.2.2 --------- Co-authored-by: Justin Kerr --- nerfstudio/viewer/control_panel.py | 18 ++-- nerfstudio/viewer/export_panel.py | 57 +++++----- nerfstudio/viewer/render_panel.py | 126 +++++++++++----------- nerfstudio/viewer/render_state_machine.py | 2 +- nerfstudio/viewer/viewer.py | 20 ++-- nerfstudio/viewer/viewer_elements.py | 24 ++--- nerfstudio/viewer_legacy/viser/server.py | 6 +- pyproject.toml | 2 +- 8 files changed, 128 insertions(+), 127 deletions(-) diff --git a/nerfstudio/viewer/control_panel.py b/nerfstudio/viewer/control_panel.py index 63209fcc7..73a136af9 100644 --- a/nerfstudio/viewer/control_panel.py +++ b/nerfstudio/viewer/control_panel.py @@ -50,7 +50,7 @@ class ControlPanel: def __init__( self, - viser_server: ViserServer, + server: ViserServer, time_enabled: bool, scale_ratio: float, rerender_cb: Callable[[], None], @@ -60,7 +60,7 @@ class ControlPanel: ): self.viser_scale_ratio = scale_ratio # elements holds a mapping from tag: [elements] - self.viser_server = viser_server + self.server = server self._elements_by_tag: DefaultDict[str, List[ViewerElement]] = defaultdict(lambda: []) self.default_composite_depth = default_composite_depth @@ -152,7 +152,7 @@ class ControlPanel: self._background_color = ViewerRGB( "Background color", (38, 42, 55), cb_hook=lambda _: rerender_cb(), hint="Color of the background" ) - self._crop_handle = self.viser_server.add_transform_controls("Crop", depth_test=False, line_width=4.0) + self._crop_handle = self.server.scene.add_transform_controls("Crop", depth_test=False, line_width=4.0) def update_center(han): self._crop_handle.position = tuple(p * self.viser_scale_ratio for p in han.value) # type: ignore @@ -193,7 +193,7 @@ class ControlPanel: self.add_element(self._train_speed) self.add_element(self._train_util) - with self.viser_server.add_gui_folder("Render Options"): + with self.server.gui.add_folder("Render Options"): self.add_element(self._max_res) self.add_element(self._output_render) self.add_element(self._colormap) @@ -205,7 +205,7 @@ class ControlPanel: self.add_element(self._max, additional_tags=("colormap",)) # split options - with self.viser_server.add_gui_folder("Split Screen"): + with self.server.gui.add_folder("Split Screen"): self.add_element(self._split) self.add_element(self._split_percentage, additional_tags=("split",)) @@ -217,7 +217,7 @@ class ControlPanel: self.add_element(self._split_min, additional_tags=("split_colormap",)) self.add_element(self._split_max, additional_tags=("split_colormap",)) - with self.viser_server.add_gui_folder("Crop Viewport"): + with self.server.gui.add_folder("Crop Viewport"): self.add_element(self._crop_viewport) # Crop options self.add_element(self._background_color, additional_tags=("crop",)) @@ -226,7 +226,7 @@ class ControlPanel: self.add_element(self._crop_rot, additional_tags=("crop",)) self.add_element(self._time, additional_tags=("time",)) - self._reset_camera = viser_server.add_gui_button( + self._reset_camera = server.gui.add_button( label="Reset Up Direction", icon=viser.Icon.ARROW_BIG_UP_LINES, color="gray", @@ -249,7 +249,7 @@ class ControlPanel: self._max_res.value = 1024 def _reset_camera_cb(self, _) -> None: - for client in self.viser_server.get_clients().values(): + for client in self.server.get_clients().values(): client.camera.up_direction = vtf.SO3(client.camera.wxyz) @ np.array([0.0, -1.0, 0.0]) def update_output_options(self, new_options: List[str]): @@ -271,7 +271,7 @@ class ControlPanel: self._elements_by_tag["all"].append(e) for t in additional_tags: self._elements_by_tag[t].append(e) - e.install(self.viser_server) + e.install(self.server) def update_control_panel(self) -> None: """ diff --git a/nerfstudio/viewer/export_panel.py b/nerfstudio/viewer/export_panel.py index 16201ba29..2bb3969cd 100644 --- a/nerfstudio/viewer/export_panel.py +++ b/nerfstudio/viewer/export_panel.py @@ -34,17 +34,17 @@ def populate_export_tab( ) -> None: viewing_gsplat = isinstance(viewer_model, SplatfactoModel) if not viewing_gsplat: - crop_output = server.add_gui_checkbox("Use Crop", False) + crop_output = server.gui.add_checkbox("Use Crop", False) @crop_output.on_update def _(_) -> None: control_panel.crop_viewport = crop_output.value - with server.add_gui_folder("Splat"): + with server.gui.add_folder("Splat"): populate_splat_tab(server, control_panel, config_path, viewing_gsplat) - with server.add_gui_folder("Point Cloud"): + with server.gui.add_folder("Point Cloud"): populate_point_cloud_tab(server, control_panel, config_path, viewing_gsplat) - with server.add_gui_folder("Mesh"): + with server.gui.add_folder("Mesh"): populate_mesh_tab(server, control_panel, config_path, viewing_gsplat) @@ -54,8 +54,8 @@ def show_command_modal(client: viser.ClientHandle, what: Literal["mesh", "point In the future, we should only show the modal to the client that pushes the generation button. """ - with client.add_gui_modal(what.title() + " Export") as modal: - client.add_gui_markdown( + with client.gui.add_modal(what.title() + " Export") as modal: + client.gui.add_markdown( "\n".join( [ f"To export a {what}, run the following from the command line:", @@ -66,7 +66,7 @@ def show_command_modal(client: viser.ClientHandle, what: Literal["mesh", "point ] ) ) - close_button = client.add_gui_button("Close") + close_button = client.gui.add_button("Close") @close_button.on_click def _(_) -> None: @@ -80,6 +80,7 @@ def get_crop_string(obb: OrientedBox, crop_viewport: bool): if not crop_viewport: return "" rpy = vtf.SO3.from_matrix(obb.R.numpy(force=True)).as_rpy_radians() + rpy = [rpy.roll, rpy.pitch, rpy.yaw] pos = obb.T.squeeze().tolist() scale = obb.S.squeeze().tolist() rpystring = " ".join([f"{x:.10f}" for x in rpy]) @@ -95,9 +96,9 @@ def populate_point_cloud_tab( viewing_gsplat: bool, ) -> None: if not viewing_gsplat: - server.add_gui_markdown("Render depth, project to an oriented point cloud, and filter ") - num_points = server.add_gui_number("# Points", initial_value=1_000_000, min=1, max=None, step=1) - world_frame = server.add_gui_checkbox( + server.gui.add_markdown("Render depth, project to an oriented point cloud, and filter ") + num_points = server.gui.add_number("# Points", initial_value=1_000_000, min=1, max=None, step=1) + world_frame = server.gui.add_checkbox( "Save in world frame", False, hint=( @@ -105,16 +106,16 @@ def populate_point_cloud_tab( "scaled and reoriented coordinate space expected by the NeRF models." ), ) - remove_outliers = server.add_gui_checkbox("Remove outliers", True) - normals = server.add_gui_dropdown( + remove_outliers = server.gui.add_checkbox("Remove outliers", True) + normals = server.gui.add_dropdown( "Normals", # TODO: options here could depend on what's available to the model. ("open3d", "model_output"), initial_value="open3d", hint="Normal map source.", ) - output_dir = server.add_gui_text("Output Directory", initial_value="exports/pcd/") - generate_command = server.add_gui_button("Generate Command", icon=viser.Icon.TERMINAL_2) + output_dir = server.gui.add_text("Output Directory", initial_value="exports/pcd/") + generate_command = server.gui.add_button("Generate Command", icon=viser.Icon.TERMINAL_2) @generate_command.on_click def _(event: viser.GuiEvent) -> None: @@ -134,7 +135,7 @@ def populate_point_cloud_tab( show_command_modal(event.client, "point cloud", command) else: - server.add_gui_markdown("Point cloud export is not currently supported with Gaussian Splatting") + server.gui.add_markdown("Point cloud export is not currently supported with Gaussian Splatting") def populate_mesh_tab( @@ -144,23 +145,23 @@ def populate_mesh_tab( viewing_gsplat: bool, ) -> None: if not viewing_gsplat: - server.add_gui_markdown( + server.gui.add_markdown( "Render depth, project to an oriented point cloud, and run Poisson surface reconstruction" ) - normals = server.add_gui_dropdown( + normals = server.gui.add_dropdown( "Normals", ("open3d", "model_output"), initial_value="open3d", hint="Source for normal maps.", ) - num_faces = server.add_gui_number("# Faces", initial_value=50_000, min=1) - texture_resolution = server.add_gui_number("Texture Resolution", min=8, initial_value=2048) - output_directory = server.add_gui_text("Output Directory", initial_value="exports/mesh/") - num_points = server.add_gui_number("# Points", initial_value=1_000_000, min=1, max=None, step=1) - remove_outliers = server.add_gui_checkbox("Remove outliers", True) + num_faces = server.gui.add_number("# Faces", initial_value=50_000, min=1) + texture_resolution = server.gui.add_number("Texture Resolution", min=8, initial_value=2048) + output_directory = server.gui.add_text("Output Directory", initial_value="exports/mesh/") + num_points = server.gui.add_number("# Points", initial_value=1_000_000, min=1, max=None, step=1) + remove_outliers = server.gui.add_checkbox("Remove outliers", True) - generate_command = server.add_gui_button("Generate Command", icon=viser.Icon.TERMINAL_2) + generate_command = server.gui.add_button("Generate Command", icon=viser.Icon.TERMINAL_2) @generate_command.on_click def _(event: viser.GuiEvent) -> None: @@ -181,7 +182,7 @@ def populate_mesh_tab( show_command_modal(event.client, "mesh", command) else: - server.add_gui_markdown("Mesh export is not currently supported with Gaussian Splatting") + server.gui.add_markdown("Mesh export is not currently supported with Gaussian Splatting") def populate_splat_tab( @@ -191,10 +192,10 @@ def populate_splat_tab( viewing_gsplat: bool, ) -> None: if viewing_gsplat: - server.add_gui_markdown("Generate ply export of Gaussian Splat") + server.gui.add_markdown("Generate ply export of Gaussian Splat") - output_directory = server.add_gui_text("Output Directory", initial_value="exports/splat/") - generate_command = server.add_gui_button("Generate Command", icon=viser.Icon.TERMINAL_2) + output_directory = server.gui.add_text("Output Directory", initial_value="exports/splat/") + generate_command = server.gui.add_button("Generate Command", icon=viser.Icon.TERMINAL_2) @generate_command.on_click def _(event: viser.GuiEvent) -> None: @@ -210,4 +211,4 @@ def populate_splat_tab( show_command_modal(event.client, "splat", command) else: - server.add_gui_markdown("Splat export is only supported with Gaussian Splatting methods") + server.gui.add_markdown("Splat export is only supported with Gaussian Splatting methods") diff --git a/nerfstudio/viewer/render_panel.py b/nerfstudio/viewer/render_panel.py index 8ac9a09ca..10d263f8c 100644 --- a/nerfstudio/viewer/render_panel.py +++ b/nerfstudio/viewer/render_panel.py @@ -101,7 +101,7 @@ class CameraPath: keyframe_index = self._keyframe_counter self._keyframe_counter += 1 - frustum_handle = server.add_camera_frustum( + frustum_handle = server.scene.add_camera_frustum( f"/render_cameras/{keyframe_index}", fov=keyframe.override_fov_rad if keyframe.override_fov_enabled else self.default_fov, aspect=keyframe.aspect, @@ -111,7 +111,7 @@ class CameraPath: position=keyframe.position, visible=self._keyframes_visible, ) - self._server.add_icosphere( + self._server.scene.add_icosphere( f"/render_cameras/{keyframe_index}/sphere", radius=0.03, color=(200, 10, 30), @@ -123,13 +123,13 @@ class CameraPath: self._camera_edit_panel.remove() self._camera_edit_panel = None - with server.add_3d_gui_container( + with server.scene.add_3d_gui_container( "/camera_edit_panel", position=keyframe.position, ) as camera_edit_panel: self._camera_edit_panel = camera_edit_panel - override_fov = server.add_gui_checkbox("Override FOV", initial_value=keyframe.override_fov_enabled) - override_fov_degrees = server.add_gui_slider( + override_fov = server.gui.add_checkbox("Override FOV", initial_value=keyframe.override_fov_enabled) + override_fov_degrees = server.gui.add_slider( "Override FOV (degrees)", 5.0, 175.0, @@ -138,10 +138,10 @@ class CameraPath: disabled=not keyframe.override_fov_enabled, ) if self.time_enabled: - override_time = server.add_gui_checkbox( + override_time = server.gui.add_checkbox( "Override Time", initial_value=keyframe.override_time_enabled ) - override_time_val = server.add_gui_slider( + override_time_val = server.gui.add_slider( "Override Time", 0.0, 1.0, @@ -161,9 +161,9 @@ class CameraPath: keyframe.override_time_val = override_time_val.value self.add_camera(keyframe, keyframe_index) - delete_button = server.add_gui_button("Delete", color="red", icon=viser.Icon.TRASH) - go_to_button = server.add_gui_button("Go to") - close_button = server.add_gui_button("Close") + delete_button = server.gui.add_button("Delete", color="red", icon=viser.Icon.TRASH) + go_to_button = server.gui.add_button("Go to") + close_button = server.gui.add_button("Close") @override_fov.on_update def _(_) -> None: @@ -179,10 +179,10 @@ class CameraPath: @delete_button.on_click def _(event: viser.GuiEvent) -> None: assert event.client is not None - with event.client.add_gui_modal("Confirm") as modal: - event.client.add_gui_markdown("Delete keyframe?") - confirm_button = event.client.add_gui_button("Yes", color="red", icon=viser.Icon.TRASH) - exit_button = event.client.add_gui_button("Cancel") + with event.client.gui.add_modal("Confirm") as modal: + event.client.gui.add_markdown("Delete keyframe?") + confirm_button = event.client.gui.add_button("Yes", color="red", icon=viser.Icon.TRASH) + exit_button = event.client.gui.add_button("Cancel") @confirm_button.on_click def _(_) -> None: @@ -374,7 +374,7 @@ class CameraPath: self._spline_nodes.clear() self._spline_nodes.append( - self._server.add_spline_catmull_rom( + self._server.scene.add_spline_catmull_rom( "/render_camera_spline", positions=points_array, color=(220, 220, 220), @@ -384,7 +384,7 @@ class CameraPath: ) ) self._spline_nodes.append( - self._server.add_point_cloud( + self._server.scene.add_point_cloud( "/render_camera_spline/points", points=points_array, colors=colors_array, @@ -401,7 +401,7 @@ class CameraPath: ) ) ) - transition_sphere = self._server.add_icosphere( + transition_sphere = self._server.scene.add_icosphere( f"/render_camera_spline/transition_{i}", radius=0.04, color=(255, 0, 0), @@ -420,16 +420,16 @@ class CameraPath: keyframe_index = (i + 1) % len(self._keyframes) keyframe = keyframes[keyframe_index][0] - with server.add_3d_gui_container( + with server.scene.add_3d_gui_container( "/camera_edit_panel", position=transition_pos, ) as camera_edit_panel: self._camera_edit_panel = camera_edit_panel - override_transition_enabled = server.add_gui_checkbox( + override_transition_enabled = server.gui.add_checkbox( "Override transition", initial_value=keyframe.override_transition_enabled, ) - override_transition_sec = server.add_gui_number( + override_transition_sec = server.gui.add_number( "Override transition (sec)", initial_value=keyframe.override_transition_sec if keyframe.override_transition_sec is not None @@ -439,7 +439,7 @@ class CameraPath: step=0.001, disabled=not override_transition_enabled.value, ) - close_button = server.add_gui_button("Close") + close_button = server.gui.add_button("Close") @override_transition_enabled.on_update def _(_) -> None: @@ -532,7 +532,7 @@ def populate_render_tab( preview_camera_type="Perspective", ) - fov_degrees = server.add_gui_slider( + fov_degrees = server.gui.add_slider( "Default FOV", initial_value=75.0, min=0.1, @@ -543,7 +543,7 @@ def populate_render_tab( render_time = None if control_panel is not None and control_panel._time_enabled: - render_time = server.add_gui_slider( + render_time = server.gui.add_slider( "Default Time", initial_value=0.0, min=0.0, @@ -568,7 +568,7 @@ def populate_render_tab( camera_path.update_aspect(resolution.value[0] / resolution.value[1]) compute_and_update_preview_camera_state() - resolution = server.add_gui_vector2( + resolution = server.gui.add_vector2( "Resolution", initial_value=(1920, 1080), min=(50, 50), @@ -582,13 +582,13 @@ def populate_render_tab( camera_path.update_aspect(resolution.value[0] / resolution.value[1]) compute_and_update_preview_camera_state() - camera_type = server.add_gui_dropdown( + camera_type = server.gui.add_dropdown( "Camera type", ("Perspective", "Fisheye", "Equirectangular"), initial_value="Perspective", hint="Camera model to render with. This is applied to all keyframes.", ) - add_button = server.add_gui_button( + add_button = server.gui.add_button( "Add Keyframe", icon=viser.Icon.PLUS, hint="Add a new keyframe at the current pose.", @@ -609,7 +609,7 @@ def populate_render_tab( duration_number.value = camera_path.compute_duration() camera_path.update_spline() - clear_keyframes_button = server.add_gui_button( + clear_keyframes_button = server.gui.add_button( "Clear Keyframes", icon=viser.Icon.TRASH, hint="Remove all keyframes from the render path.", @@ -619,10 +619,10 @@ def populate_render_tab( def _(event: viser.GuiEvent) -> None: assert event.client_id is not None client = server.get_clients()[event.client_id] - with client.atomic(), client.add_gui_modal("Confirm") as modal: - client.add_gui_markdown("Clear all keyframes?") - confirm_button = client.add_gui_button("Yes", color="red", icon=viser.Icon.TRASH) - exit_button = client.add_gui_button("Cancel") + with client.atomic(), client.gui.add_modal("Confirm") as modal: + client.gui.add_markdown("Clear all keyframes?") + confirm_button = client.gui.add_button("Yes", color="red", icon=viser.Icon.TRASH) + exit_button = client.gui.add_button("Cancel") @confirm_button.on_click def _(_) -> None: @@ -642,14 +642,14 @@ def populate_render_tab( def _(_) -> None: modal.close() - loop = server.add_gui_checkbox("Loop", False, hint="Add a segment between the first and last keyframes.") + loop = server.gui.add_checkbox("Loop", False, hint="Add a segment between the first and last keyframes.") @loop.on_update def _(_) -> None: camera_path.loop = loop.value duration_number.value = camera_path.compute_duration() - tension_slider = server.add_gui_slider( + tension_slider = server.gui.add_slider( "Spline tension", min=0.0, max=1.0, @@ -663,7 +663,7 @@ def populate_render_tab( camera_path.tension = tension_slider.value camera_path.update_spline() - move_checkbox = server.add_gui_checkbox( + move_checkbox = server.gui.add_checkbox( "Move keyframes", initial_value=False, hint="Toggle move handles for keyframes in the scene.", @@ -697,7 +697,7 @@ def populate_render_tab( # Show move handles. assert event.client is not None for keyframe_index, keyframe in camera_path._keyframes.items(): - controls = event.client.add_transform_controls( + controls = event.client.scene.add_transform_controls( f"/keyframe_move/{keyframe_index}", scale=0.4, wxyz=keyframe[0].wxyz, @@ -706,7 +706,7 @@ def populate_render_tab( transform_controls.append(controls) _make_transform_controls_callback(keyframe, controls) - show_keyframe_checkbox = server.add_gui_checkbox( + show_keyframe_checkbox = server.gui.add_checkbox( "Show keyframes", initial_value=True, hint="Show keyframes in the scene.", @@ -716,7 +716,7 @@ def populate_render_tab( def _(_: viser.GuiEvent) -> None: camera_path.set_keyframes_visible(show_keyframe_checkbox.value) - show_spline_checkbox = server.add_gui_checkbox( + show_spline_checkbox = server.gui.add_checkbox( "Show spline", initial_value=True, hint="Show camera path spline in the scene.", @@ -727,16 +727,16 @@ def populate_render_tab( camera_path.show_spline = show_spline_checkbox.value camera_path.update_spline() - playback_folder = server.add_gui_folder("Playback") + playback_folder = server.gui.add_folder("Playback") with playback_folder: - play_button = server.add_gui_button("Play", icon=viser.Icon.PLAYER_PLAY) - pause_button = server.add_gui_button("Pause", icon=viser.Icon.PLAYER_PAUSE, visible=False) - preview_render_button = server.add_gui_button( + play_button = server.gui.add_button("Play", icon=viser.Icon.PLAYER_PLAY) + pause_button = server.gui.add_button("Pause", icon=viser.Icon.PLAYER_PAUSE, visible=False) + preview_render_button = server.gui.add_button( "Preview Render", hint="Show a preview of the render in the viewport." ) - preview_render_stop_button = server.add_gui_button("Exit Render Preview", color="red", visible=False) + preview_render_stop_button = server.gui.add_button("Exit Render Preview", color="red", visible=False) - transition_sec_number = server.add_gui_number( + transition_sec_number = server.gui.add_number( "Transition (sec)", min=0.001, max=30.0, @@ -744,9 +744,9 @@ def populate_render_tab( initial_value=2.0, hint="Time in seconds between each keyframe, which can also be overridden on a per-transition basis.", ) - framerate_number = server.add_gui_number("FPS", min=0.1, max=240.0, step=1e-2, initial_value=30.0) - framerate_buttons = server.add_gui_button_group("", ("24", "30", "60")) - duration_number = server.add_gui_number( + framerate_number = server.gui.add_number("FPS", min=0.1, max=240.0, step=1e-2, initial_value=30.0) + framerate_buttons = server.gui.add_button_group("", ("24", "30", "60")) + duration_number = server.gui.add_number( "Duration (sec)", min=0.0, max=1e8, @@ -807,7 +807,7 @@ def populate_render_tab( re-added anytime the `max` value changes.""" with playback_folder: - preview_frame_slider = server.add_gui_slider( + preview_frame_slider = server.gui.add_slider( "Preview frame", min=0, max=get_max_frame_index(), @@ -831,7 +831,7 @@ def populate_render_tab( else: pose, fov_rad = maybe_pose_and_fov_rad - preview_camera_handle = server.add_camera_frustum( + preview_camera_handle = server.scene.add_camera_frustum( "/preview_camera", fov=fov_rad, aspect=resolution.value[0] / resolution.value[1], @@ -867,7 +867,7 @@ def populate_render_tab( del fov # Hide all scene nodes when we're previewing the render. - server.set_global_scene_node_visibility(False) + server.scene.set_global_visibility(False) # Back up and then set camera poses. for client in server.get_clients().values(): @@ -896,7 +896,7 @@ def populate_render_tab( client.flush() # Un-hide scene nodes. - server.set_global_scene_node_visibility(True) + server.scene.set_global_visibility(True) preview_frame_slider = add_preview_frame_slider() @@ -942,7 +942,7 @@ def populate_render_tab( pause_button.visible = False # add button for loading existing path - load_camera_path_button = server.add_gui_button( + load_camera_path_button = server.gui.add_button( "Load Path", icon=viser.Icon.FOLDER_OPEN, hint="Load an existing camera path." ) @@ -954,17 +954,17 @@ def populate_render_tab( preexisting_camera_paths = list(camera_path_dir.glob("*.json")) preexisting_camera_filenames = [p.name for p in preexisting_camera_paths] - with event.client.add_gui_modal("Load Path") as modal: + with event.client.gui.add_modal("Load Path") as modal: if len(preexisting_camera_filenames) == 0: - event.client.add_gui_markdown("No existing paths found") + event.client.gui.add_markdown("No existing paths found") else: - event.client.add_gui_markdown("Select existing camera path:") - camera_path_dropdown = event.client.add_gui_dropdown( + event.client.gui.add_markdown("Select existing camera path:") + camera_path_dropdown = event.client.gui.add_dropdown( label="Camera Path", options=[str(p) for p in preexisting_camera_filenames], initial_value=str(preexisting_camera_filenames[0]), ) - load_button = event.client.add_gui_button("Load") + load_button = event.client.gui.add_button("Load") @load_button.on_click def _(_) -> None: @@ -1006,7 +1006,7 @@ def populate_render_tab( camera_path.update_spline() modal.close() - cancel_button = event.client.add_gui_button("Cancel") + cancel_button = event.client.gui.add_button("Cancel") @cancel_button.on_click def _(_) -> None: @@ -1014,19 +1014,19 @@ def populate_render_tab( # set the initial value to the current date-time string now = datetime.datetime.now() - render_name_text = server.add_gui_text( + render_name_text = server.gui.add_text( "Render name", initial_value=now.strftime("%Y-%m-%d-%H-%M-%S"), hint="Name of the render", ) - render_button = server.add_gui_button( + render_button = server.gui.add_button( "Generate Command", color="green", icon=viser.Icon.FILE_EXPORT, hint="Generate the ns-render command for rendering the camera path.", ) - reset_up_button = server.add_gui_button( + reset_up_button = server.gui.add_button( "Reset Up Direction", icon=viser.Icon.ARROW_BIG_UP_LINES, color="gray", @@ -1135,7 +1135,7 @@ def populate_render_tab( with open(json_outfile.absolute(), "w") as outfile: json.dump(json_data, outfile) # now show the command - with event.client.add_gui_modal("Render Command") as modal: + with event.client.gui.add_modal("Render Command") as modal: dataname = datapath.name command = " ".join( [ @@ -1145,7 +1145,7 @@ def populate_render_tab( f"--output-path renders/{dataname}/{render_name_text.value}.mp4", ] ) - event.client.add_gui_markdown( + event.client.gui.add_markdown( "\n".join( [ "To render the trajectory, run the following from the command line:", @@ -1156,7 +1156,7 @@ def populate_render_tab( ] ) ) - close_button = event.client.add_gui_button("Close") + close_button = event.client.gui.add_button("Close") @close_button.on_click def _(_) -> None: diff --git a/nerfstudio/viewer/render_state_machine.py b/nerfstudio/viewer/render_state_machine.py index 07c74f220..cc8002ec9 100644 --- a/nerfstudio/viewer/render_state_machine.py +++ b/nerfstudio/viewer/render_state_machine.py @@ -303,7 +303,7 @@ class RenderStateMachine(threading.Thread): if self.viewer.render_tab_state.preview_render else 40 ) - self.client.set_background_image( + self.client.scene.set_background_image( selected_output, format=self.viewer.config.image_format, jpeg_quality=jpg_quality, diff --git a/nerfstudio/viewer/viewer.py b/nerfstudio/viewer/viewer.py index a5093f0da..bb90ea160 100644 --- a/nerfstudio/viewer/viewer.py +++ b/nerfstudio/viewer/viewer.py @@ -150,7 +150,7 @@ class Viewer: href="https://docs.nerf.studio/", ) titlebar_theme = viser.theme.TitlebarConfig(buttons=buttons, image=image) - self.viser_server.configure_theme( + self.viser_server.gui.configure_theme( titlebar_content=titlebar_theme, control_layout="collapsible", dark_mode=True, @@ -162,32 +162,32 @@ class Viewer: self.viser_server.on_client_connect(self.handle_new_client) # Populate the header, which includes the pause button, train cam button, and stats - self.pause_train = self.viser_server.add_gui_button( + self.pause_train = self.viser_server.gui.add_button( label="Pause Training", disabled=False, icon=viser.Icon.PLAYER_PAUSE_FILLED ) self.pause_train.on_click(lambda _: self.toggle_pause_button()) self.pause_train.on_click(lambda han: self._toggle_training_state(han)) - self.resume_train = self.viser_server.add_gui_button( + self.resume_train = self.viser_server.gui.add_button( label="Resume Training", disabled=False, icon=viser.Icon.PLAYER_PLAY_FILLED ) self.resume_train.on_click(lambda _: self.toggle_pause_button()) self.resume_train.on_click(lambda han: self._toggle_training_state(han)) self.resume_train.visible = False # Add buttons to toggle training image visibility - self.hide_images = self.viser_server.add_gui_button( + self.hide_images = self.viser_server.gui.add_button( label="Hide Train Cams", disabled=False, icon=viser.Icon.EYE_OFF, color=None ) self.hide_images.on_click(lambda _: self.set_camera_visibility(False)) self.hide_images.on_click(lambda _: self.toggle_cameravis_button()) - self.show_images = self.viser_server.add_gui_button( + self.show_images = self.viser_server.gui.add_button( label="Show Train Cams", disabled=False, icon=viser.Icon.EYE, color=None ) self.show_images.on_click(lambda _: self.set_camera_visibility(True)) self.show_images.on_click(lambda _: self.toggle_cameravis_button()) self.show_images.visible = False mkdown = self.make_stats_markdown(0, "0x0px") - self.stats_markdown = self.viser_server.add_gui_markdown(mkdown) - tabs = self.viser_server.add_gui_tab_group() + self.stats_markdown = self.viser_server.gui.add_markdown(mkdown) + tabs = self.viser_server.gui.add_tab_group() control_tab = tabs.add_tab("Control", viser.Icon.SETTINGS) with control_tab: self.control_panel = ControlPanel( @@ -242,7 +242,7 @@ class Viewer: # Otherwise, use the existing folder as context manager. folder_path = "/".join(prev_labels + [folder_labels[0]]) if folder_path not in viewer_gui_folders: - viewer_gui_folders[folder_path] = self.viser_server.add_gui_folder(folder_labels[0]) + viewer_gui_folders[folder_path] = self.viser_server.gui.add_folder(folder_labels[0]) with viewer_gui_folders[folder_path]: nested_folder_install(folder_labels[1:], prev_labels + [folder_labels[0]], element) @@ -272,7 +272,7 @@ class Viewer: # Diagnostics for Gaussian Splatting: where the points are at the start of training. # This is hidden by default, it can be shown from the Viser UI's scene tree table. if isinstance(pipeline.model, SplatfactoModel): - self.viser_server.add_point_cloud( + self.viser_server.scene.add_point_cloud( "/gaussian_splatting_initial_points", points=pipeline.model.means.numpy(force=True) * VISER_NERFSTUDIO_SCALE_RATIO, colors=(255, 0, 0), @@ -452,7 +452,7 @@ class Viewer: c2w = camera.camera_to_worlds.cpu().numpy() R = vtf.SO3.from_matrix(c2w[:3, :3]) R = R @ vtf.SO3.from_x_radians(np.pi) - camera_handle = self.viser_server.add_camera_frustum( + camera_handle = self.viser_server.scene.add_camera_frustum( name=f"/cameras/camera_{idx:05d}", fov=float(2 * np.arctan(camera.cx / camera.fx[0])), scale=self.config.camera_frustum_scale, diff --git a/nerfstudio/viewer/viewer_elements.py b/nerfstudio/viewer/viewer_elements.py index 1d0ffd466..1ccfab3b4 100644 --- a/nerfstudio/viewer/viewer_elements.py +++ b/nerfstudio/viewer/viewer_elements.py @@ -227,7 +227,7 @@ class ViewerControl: cb_overriden = False with warnings.catch_warnings(record=True) as w: # Register the callback with the viser server. - self.viser_server.on_scene_pointer(event_type=event_type)(wrapped_cb) + self.viser_server.scene.on_pointer_event(event_type=event_type)(wrapped_cb) # If there exists a warning, it's because a callback was overriden. cb_overriden = len(w) > 0 @@ -239,7 +239,7 @@ class ViewerControl: # If there exists a cleanup callback after the pointer event is done, register it. if removed_cb is not None: - self.viser_server.on_scene_pointer_removed(removed_cb) + self.viser_server.scene.on_pointer_callback_removed(removed_cb) def unregister_click_cb(self, cb: Optional[Callable] = None): """Deprecated, use unregister_pointer_cb instead. `cb` is ignored.""" @@ -257,7 +257,7 @@ class ViewerControl: Args: cb: The callback to remove """ - self.viser_server.remove_scene_pointer_callback() + self.viser_server.scene.remove_pointer_callback() @property def server(self): @@ -339,7 +339,7 @@ class ViewerButton(ViewerElement[bool]): super().__init__(name, disabled=disabled, visible=visible, cb_hook=cb_hook) def _create_gui_handle(self, viser_server: ViserServer) -> None: - self.gui_handle = viser_server.add_gui_button(label=self.name, disabled=self.disabled, visible=self.visible) + self.gui_handle = viser_server.gui.add_button(label=self.name, disabled=self.disabled, visible=self.visible) def install(self, viser_server: ViserServer) -> None: self._create_gui_handle(viser_server) @@ -441,7 +441,7 @@ class ViewerSlider(ViewerParameter[IntOrFloat], Generic[IntOrFloat]): def _create_gui_handle(self, viser_server: ViserServer) -> None: assert self.gui_handle is None, "gui_handle should be initialized once" - self.gui_handle = viser_server.add_gui_slider( + self.gui_handle = viser_server.gui.add_slider( self.name, self.min, self.max, @@ -480,7 +480,7 @@ class ViewerText(ViewerParameter[str]): def _create_gui_handle(self, viser_server: ViserServer) -> None: assert self.gui_handle is None, "gui_handle should be initialized once" - self.gui_handle = viser_server.add_gui_text( + self.gui_handle = viser_server.gui.add_text( self.name, self.default_value, disabled=self.disabled, visible=self.visible, hint=self.hint ) @@ -514,7 +514,7 @@ class ViewerNumber(ViewerParameter[IntOrFloat], Generic[IntOrFloat]): def _create_gui_handle(self, viser_server: ViserServer) -> None: assert self.gui_handle is None, "gui_handle should be initialized once" - self.gui_handle = viser_server.add_gui_number( + self.gui_handle = viser_server.gui.add_number( self.name, self.default_value, disabled=self.disabled, visible=self.visible, hint=self.hint ) @@ -546,7 +546,7 @@ class ViewerCheckbox(ViewerParameter[bool]): def _create_gui_handle(self, viser_server: ViserServer) -> None: assert self.gui_handle is None, "gui_handle should be initialized once" - self.gui_handle = viser_server.add_gui_checkbox( + self.gui_handle = viser_server.gui.add_checkbox( self.name, self.default_value, disabled=self.disabled, visible=self.visible, hint=self.hint ) @@ -586,7 +586,7 @@ class ViewerDropdown(ViewerParameter[TString], Generic[TString]): def _create_gui_handle(self, viser_server: ViserServer) -> None: assert self.gui_handle is None, "gui_handle should be initialized once" - self.gui_handle = viser_server.add_gui_dropdown( + self.gui_handle = viser_server.gui.add_dropdown( self.name, self.options, self.default_value, @@ -632,7 +632,7 @@ class ViewerButtonGroup(ViewerParameter[TString], Generic[TString]): def _create_gui_handle(self, viser_server: ViserServer) -> None: assert self.gui_handle is None, "gui_handle should be initialized once" - self.gui_handle = viser_server.add_gui_button_group(self.name, self.options, visible=self.visible) + self.gui_handle = viser_server.gui.add_button_group(self.name, self.options, visible=self.visible) def install(self, viser_server: ViserServer) -> None: self._create_gui_handle(viser_server) @@ -668,7 +668,7 @@ class ViewerRGB(ViewerParameter[Tuple[int, int, int]]): self.hint = hint def _create_gui_handle(self, viser_server: ViserServer) -> None: - self.gui_handle = viser_server.add_gui_rgb( + self.gui_handle = viser_server.gui.add_rgb( self.name, self.default_value, disabled=self.disabled, visible=self.visible, hint=self.hint ) @@ -703,6 +703,6 @@ class ViewerVec3(ViewerParameter[Tuple[float, float, float]]): self.hint = hint def _create_gui_handle(self, viser_server: ViserServer) -> None: - self.gui_handle = viser_server.add_gui_vector3( + self.gui_handle = viser_server.gui.add_vector3( self.name, self.default_value, step=self.step, disabled=self.disabled, visible=self.visible, hint=self.hint ) diff --git a/nerfstudio/viewer_legacy/viser/server.py b/nerfstudio/viewer_legacy/viser/server.py index 5bbb1f9aa..6984b1c30 100644 --- a/nerfstudio/viewer_legacy/viser/server.py +++ b/nerfstudio/viewer_legacy/viser/server.py @@ -18,8 +18,8 @@ from __future__ import annotations from typing import Callable, Type -import viser.infra from typing_extensions import override +from viser.infra import WebsockServer from .message_api import MessageApi from .messages import GuiUpdateMessage, NerfstudioMessage @@ -43,7 +43,7 @@ class ViserServer(MessageApi): ): super().__init__() - self._ws_server = viser.infra.Server(host, port, http_server_root=None, verbose=False) + self._ws_server = WebsockServer(host, port, http_server_root=None, verbose=False) self._ws_server.register_handler(GuiUpdateMessage, self._handle_gui_updates) self._ws_server.start() @@ -52,7 +52,7 @@ class ViserServer(MessageApi): """Implements message enqueue required by MessageApi. Pushes a message onto a broadcast queue.""" - self._ws_server.broadcast(message) + self._ws_server.queue_message(message) def register_handler( self, message_type: Type[NerfstudioMessage], handler: Callable[[NerfstudioMessage], None] diff --git a/pyproject.toml b/pyproject.toml index b7998309b..826873746 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -57,7 +57,7 @@ dependencies = [ "torchvision>=0.14.1", "torchmetrics[image]>=1.0.1", "typing_extensions>=4.4.0", - "viser==0.1.27", + "viser==0.2.2", "nuscenes-devkit>=1.1.1", "wandb>=0.13.3", "xatlas",