# Copyright 2022 the Regents of the University of California, Nerfstudio Team and contributors. All rights reserved. # # 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. from __future__ import annotations from pathlib import Path import viser import viser.transforms as vtf from typing_extensions import Literal from nerfstudio.data.scene_box import OrientedBox from nerfstudio.models.base_model import Model from nerfstudio.models.splatfacto import SplatfactoModel from nerfstudio.viewer.control_panel import ControlPanel def populate_export_tab( server: viser.ViserServer, control_panel: ControlPanel, config_path: Path, viewer_model: Model, ) -> None: viewing_gsplat = isinstance(viewer_model, SplatfactoModel) if not viewing_gsplat: crop_output = server.add_gui_checkbox("Use Crop", False) @crop_output.on_update def _(_) -> None: control_panel.crop_viewport = crop_output.value with server.add_gui_folder("Splat"): populate_splat_tab(server, control_panel, config_path, viewing_gsplat) with server.add_gui_folder("Point Cloud"): populate_point_cloud_tab(server, control_panel, config_path, viewing_gsplat) with server.add_gui_folder("Mesh"): populate_mesh_tab(server, control_panel, config_path, viewing_gsplat) def show_command_modal(client: viser.ClientHandle, what: Literal["mesh", "point cloud", "splat"], command: str) -> None: """Show a modal to each currently connected client. 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( "\n".join( [ f"To export a {what}, run the following from the command line:", "", "```", command, "```", ] ) ) close_button = client.add_gui_button("Close") @close_button.on_click def _(_) -> None: modal.close() def get_crop_string(obb: OrientedBox, crop_viewport: bool): """Takes in an oriented bounding box and returns a string of the form "--obb_{center,rotation,scale} and each arg formatted with spaces around it """ if not crop_viewport: return "" rpy = vtf.SO3.from_matrix(obb.R.numpy(force=True)).as_rpy_radians() pos = obb.T.squeeze().tolist() scale = obb.S.squeeze().tolist() rpystring = " ".join([f"{x:.10f}" for x in rpy]) posstring = " ".join([f"{x:.10f}" for x in pos]) scalestring = " ".join([f"{x:.10f}" for x in scale]) return f"--obb_center {posstring} --obb_rotation {rpystring} --obb_scale {scalestring}" def populate_point_cloud_tab( server: viser.ViserServer, control_panel: ControlPanel, config_path: Path, 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( "Save in world frame", False, hint=( "If checked, saves the point cloud in the same frame as the original dataset. Otherwise, uses the " "scaled and reoriented coordinate space expected by the NeRF models." ), ) remove_outliers = server.add_gui_checkbox("Remove outliers", True) normals = server.add_gui_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) @generate_command.on_click def _(event: viser.GuiEvent) -> None: assert event.client is not None command = " ".join( [ "ns-export pointcloud", f"--load-config {config_path}", f"--output-dir {output_dir.value}", f"--num-points {num_points.value}", f"--remove-outliers {remove_outliers.value}", f"--normal-method {normals.value}", f"--save-world-frame {world_frame.value}", get_crop_string(control_panel.crop_obb, control_panel.crop_viewport), ] ) show_command_modal(event.client, "point cloud", command) else: server.add_gui_markdown("Point cloud export is not currently supported with Gaussian Splatting") def populate_mesh_tab( server: viser.ViserServer, control_panel: ControlPanel, config_path: Path, viewing_gsplat: bool, ) -> None: if not viewing_gsplat: server.add_gui_markdown( "Render depth, project to an oriented point cloud, and run Poisson surface reconstruction" ) normals = server.add_gui_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) generate_command = server.add_gui_button("Generate Command", icon=viser.Icon.TERMINAL_2) @generate_command.on_click def _(event: viser.GuiEvent) -> None: assert event.client is not None command = " ".join( [ "ns-export poisson", f"--load-config {config_path}", f"--output-dir {output_directory.value}", f"--target-num-faces {num_faces.value}", f"--num-pixels-per-side {texture_resolution.value}", f"--num-points {num_points.value}", f"--remove-outliers {remove_outliers.value}", f"--normal-method {normals.value}", get_crop_string(control_panel.crop_obb, control_panel.crop_viewport), ] ) show_command_modal(event.client, "mesh", command) else: server.add_gui_markdown("Mesh export is not currently supported with Gaussian Splatting") def populate_splat_tab( server: viser.ViserServer, control_panel: ControlPanel, config_path: Path, viewing_gsplat: bool, ) -> None: if viewing_gsplat: server.add_gui_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) @generate_command.on_click def _(event: viser.GuiEvent) -> None: assert event.client is not None command = " ".join( [ "ns-export gaussian-splat", f"--load-config {config_path}", f"--output-dir {output_directory.value}", get_crop_string(control_panel.crop_obb, control_panel.crop_viewport), ] ) show_command_modal(event.client, "splat", command) else: server.add_gui_markdown("Splat export is only supported with Gaussian Splatting methods")