Viewer Pythonification (#163)

This PR refactors the Viewer class to have a minimal API and adds a
viewer python class which does most of the heavy lifting for logic and
error checks. It also adds docstrings.

---------

Signed-off-by: Francis Williams <[email protected]>

Author: fwilliams

fvdb/_Cpp.pyi

@@ -101,7 +101,7 @@ class GaussianSplat3d:
         image_height: int,
         near: float,
         far: float,
-        projection_type=...,
+        projection_type: str = ...,
         min_radius_2d: float = ...,
         eps_2d: float = ...,
         antialias: bool = ...,
@@ -114,7 +114,7 @@ class GaussianSplat3d:
         image_height: int,
         near: float,
         far: float,
-        projection_type=...,
+        projection_type: str = ...,
         sh_degree_to_use: int = ...,
         min_radius_2d: float = ...,
         eps_2d: float = ...,
@@ -128,7 +128,7 @@ class GaussianSplat3d:
         image_height: int,
         near: float,
         far: float,
-        projection_type=...,
+        projection_type: str = ...,
         sh_degree_to_use: int = ...,
         min_radius_2d: float = ...,
         eps_2d: float = ...,
@@ -142,7 +142,7 @@ class GaussianSplat3d:
         image_height: int,
         near: float,
         far: float,
-        projection_type=...,
+        projection_type: str = ...,
         tile_size: int = ...,
         min_radius_2d: float = ...,
         eps_2d: float = ...,
@@ -165,7 +165,7 @@ class GaussianSplat3d:
         image_height: int,
         near: float,
         far: float,
-        projection_type=...,
+        projection_type: str = ...,
         sh_degree_to_use: int = ...,
         tile_size: int = ...,
         min_radius_2d: float = ...,
@@ -180,7 +180,7 @@ class GaussianSplat3d:
         image_height: int,
         near: float,
         far: float,
-        projection_type=...,
+        projection_type: str = ...,
         sh_degree_to_use: int = ...,
         tile_size: int = ...,
         min_radius_2d: float = ...,
@@ -195,7 +195,7 @@ class GaussianSplat3d:
         image_height: int,
         near: float,
         far: float,
-        projection_type=...,
+        projection_type: str = ...,
         tile_size: int = ...,
         min_radius_2d: float = ...,
         eps_2d: float = ...,
@@ -210,7 +210,7 @@ class GaussianSplat3d:
         image_height: int,
         near: float,
         far: float,
-        projection_type=...,
+        projection_type: str = ...,
         tile_size: int = ...,
         min_radius_2d: float = ...,
         eps_2d: float = ...,
@@ -225,7 +225,7 @@ class GaussianSplat3d:
         image_height: int,
         near: float,
         far: float,
-        projection_type=...,
+        projection_type: str = ...,
         tile_size: int = ...,
         min_radius_2d: float = ...,
         eps_2d: float = ...,
@@ -241,7 +241,7 @@ class GaussianSplat3d:
         image_height: int,
         near: float,
         far: float,
-        projection_type=...,
+        projection_type: str = ...,
         tile_size: int = ...,
         min_radius_2d: float = ...,
         eps_2d: float = ...,
@@ -813,7 +813,7 @@ class ProjectedGaussianSplats:
     @property
     def opacities(self) -> torch.Tensor: ...
     @property
-    def projection_type(self): ...
+    def projection_type(self) -> str: ...
     @property
     def radii(self) -> torch.Tensor: ...
     @property
@@ -899,6 +899,54 @@ class SparseConvPackInfo:
     @property
     def use_tf32(self) -> bool: ...
 
+class GaussianSplat3dView:
+    @property
+    def tile_size(self) -> int: ...
+    @tile_size.setter
+    def tile_size(self, value: int) -> None: ...
+    @property
+    def min_radius_2d(self) -> float: ...
+    @min_radius_2d.setter
+    def min_radius_2d(self, value: float) -> None: ...
+    @property
+    def eps_2d(self) -> float: ...
+    @eps_2d.setter
+    def eps_2d(self, value: float) -> None: ...
+    @property
+    def antialias(self) -> bool: ...
+    @antialias.setter
+    def antialias(self, value: bool) -> None: ...
+    @property
+    def sh_degree_to_use(self) -> int: ...
+    @sh_degree_to_use.setter
+    def sh_degree_to_use(self, value: int) -> None: ...
+    @property
+    def near(self) -> float: ...
+    @near.setter
+    def near(self, value: float) -> None: ...
+    @property
+    def far(self) -> float: ...
+    @far.setter
+    def far(self, value: float) -> None: ...
+
+class Viewer:
+    def __init__(self, ip_address: str, port: int, verbose: bool) -> None: ...
+    def start_server(self) -> None: ...
+    def stop_server(self) -> None: ...
+    def add_gaussian_splat_3d(self, name: str, gaussian_splat_3d: GaussianSplat3d) -> GaussianSplat3dView: ...
+    def camera_origin(self) -> tuple[float, float, float]: ...
+    def set_camera_origin(self, ox: float, oy: float, oz: float) -> None: ...
+    def camera_view_direction(self) -> tuple[float, float, float]: ...
+    def set_camera_view_direction(self, dx: float, dy: float, dz: float) -> None: ...
+    def camera_up_direction(self) -> tuple[float, float, float]: ...
+    def set_camera_up_direction(self, ux: float, uy: float, uz: float) -> None: ...
+    def camera_near(self) -> float: ...
+    def set_camera_near(self, near: float) -> None: ...
+    def camera_far(self) -> float: ...
+    def set_camera_far(self, near: float) -> None: ...
+    def camera_projection_type(self) -> str: ...
+    def set_camera_projection_type(self, projection_type: str) -> None: ...
+
 class config:
     enable_ultra_sparse_acceleration: ClassVar[bool] = ...
     pedantic_error_checking: ClassVar[bool] = ...

fvdb/types.py

@@ -1002,3 +1002,52 @@ def to_Vec3fBatch(
     return to_FloatingTensorBroadcastableRank2(
         x, (1, 3), dtype, value_constraint=value_constraint, do_broadcast_to=True
     )
+
+
+def to_Mat44f(
+    x: NumericMaxRank2,
+    dtype: torch.dtype = torch.float32,
+    value_constraint: ValueConstraint = ValueConstraint.NONE,
+) -> torch.Tensor:
+    """
+    Converts a NumericMaxRank2 to a Mat44f tensor, reshaped to (4, 4).
+
+    Args:
+        x (NumericMaxRank2): The input tensor.
+        dtype (torch.dtype): The floating dtype of the output tensor. Defaults to torch.float32.
+        value_constraint: Constraint on the value of the scalar.
+            default: ValueConstraint.NONE
+            if ValueConstraint.NON_NEGATIVE, the scalar must be non-negative
+            if ValueConstraint.POSITIVE, the scalar must be positive
+
+    Returns:
+        A torch.Tensor of dtype dtype and shape (4, 4).
+    """
+    return to_FloatingTensorBroadcastableRank2(
+        x, (4, 4), dtype, value_constraint=value_constraint, do_broadcast_to=True
+    )
+
+
+def to_Mat44fBroadcastable(
+    x: NumericMaxRank2,
+    dtype: torch.dtype = torch.float32,
+    value_constraint: ValueConstraint = ValueConstraint.NONE,
+) -> torch.Tensor:
+    """
+    Converts a NumericMaxRank2 to a Mat44f tensor that respects the shape of the input without reshaping,
+    but verifies that it can be broadcasted to the shape (4, 4).
+
+    Args:
+        x (NumericMaxRank2): The input tensor.
+        dtype (torch.dtype): The floating dtype of the output tensor. Defaults to torch.float32.
+        value_constraint: Constraint on the value of the scalar.
+            default: ValueConstraint.NONE
+            if ValueConstraint.NON_NEGATIVE, the scalar must be non-negative
+            if ValueConstraint.POSITIVE, the scalar must be positive
+
+    Returns:
+        A torch.Tensor of dtype dtype and shape (4, 4).
+    """
+    return to_FloatingTensorBroadcastableRank2(
+        x, (4, 4), dtype, value_constraint=value_constraint, do_broadcast_to=False
+    )

fvdb/viz/__init__.py

@@ -1,7 +1,7 @@
 # Copyright Contributors to the OpenVDB Project
 # SPDX-License-Identifier: Apache-2.0
 #
-from .._Cpp.viz import Viewer, GaussianSplat3dView
+from .viewer import GaussianSplat3dView, Viewer
 
 __all__ = [
     "Viewer",