Docs + backwards compatibility

nerfstudio-project · Oct 11, 2023 · f2b0f3c · f2b0f3c
1 parent cadaa33
commit f2b0f3c
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 12 deletions.
diff --git a/docs/source/gui_handles.md b/docs/source/gui_handles.md
@@ -50,9 +50,4 @@ connected clients. When a GUI element is added to a client (for example, via
    :undoc-members:
    :inherited-members:
 
-.. autoapiclass:: viser.GuiEvent
-   :members:
-   :undoc-members:
-   :inherited-members:
-
 <!-- prettier-ignore-end -->
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -66,6 +66,7 @@ URL (default: `http://localhost:8080`).
    ./client_handles.md
    ./gui_handles.md
    ./scene_handles.md
+   ./events.md
    ./icons.md
 
 

diff --git a/docs/source/scene_handles.md b/docs/source/scene_handles.md
@@ -25,6 +25,11 @@ connected clients. When a scene node is added to a client (for example, via
    :undoc-members:
    :inherited-members:
 
+.. autoapiclass:: viser.GlbHandle
+   :members:
+   :undoc-members:
+   :inherited-members:
+
 .. autoapiclass:: viser.Gui3dContainerHandle
    :members:
    :undoc-members:
@@ -55,9 +60,4 @@ connected clients. When a scene node is added to a client (for example, via
    :undoc-members:
    :inherited-members:
 
-.. autoapiclass:: viser.ClickEvent
-   :members:
-   :undoc-members:
-   :inherited-members:
-
 <!-- prettier-ignore-end -->
diff --git a/src/viser/__init__.py b/src/viser/__init__.py
@@ -10,9 +10,7 @@
 from ._gui_handles import GuiTabGroupHandle as GuiTabGroupHandle
 from ._gui_handles import GuiTabHandle as GuiTabHandle
 from ._icons_enum import Icon as Icon
-from ._scene_handles import ScenePointerEvent as ScenePointerEvent
 from ._scene_handles import CameraFrustumHandle as CameraFrustumHandle
-from ._scene_handles import SceneNodePointerEvent as SceneNodePointerEvent
 from ._scene_handles import FrameHandle as FrameHandle
 from ._scene_handles import GlbHandle as GlbHandle
 from ._scene_handles import Gui3dContainerHandle as Gui3dContainerHandle
@@ -21,6 +19,8 @@
 from ._scene_handles import MeshHandle as MeshHandle
 from ._scene_handles import PointCloudHandle as PointCloudHandle
 from ._scene_handles import SceneNodeHandle as SceneNodeHandle
+from ._scene_handles import SceneNodePointerEvent as SceneNodePointerEvent
+from ._scene_handles import ScenePointerEvent as ScenePointerEvent
 from ._scene_handles import TransformControlsHandle as TransformControlsHandle
 from ._viser import CameraHandle as CameraHandle
 from ._viser import ClientHandle as ClientHandle
@@ -29,3 +29,4 @@
 if not TYPE_CHECKING:
     # Backwards compatibility.
     GuiHandle = GuiInputHandle
+    ClickEvent = SceneNodePointerEvent