custom scene

CHANGELOG.md

@@ -9,10 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added custom scene `compas_notebook.scene.Scene`.
+
 ### Changed
 
 ### Removed
 
+* Removed `scene=None` parameter from viewer constructor.
+
 
 ## [0.6.1] 2024-05-12
 

src/compas_notebook/__init__.py

@@ -2,6 +2,7 @@
 
 import os
 
+from .viewer import Viewer
 
 __author__ = ["tom van mele"]
 __copyright__ = "ETH Zurich - Block Research Group"
@@ -18,7 +19,7 @@
 TEMP = os.path.abspath(os.path.join(HOME, "temp"))
 
 
-__all__ = ["HOME", "DATA", "DOCS", "TEMP"]
+__all__ = ["HOME", "DATA", "DOCS", "TEMP", "Viewer"]
 
 __all_plugins__ = [
     "compas_notebook.scene",

src/compas_notebook/scene/__init__.py

@@ -24,6 +24,8 @@
 from compas.datastructures import Graph
 from compas.datastructures import Mesh
 
+from .scene import NotebookScene
+
 from .sceneobject import ThreeSceneObject
 
 from .boxobject import ThreeBoxObject
@@ -85,6 +87,7 @@ def register_scene_objects():
 
 
 __all__ = [
+    "NotebookScene",
     "ThreeBoxObject",
     "ThreeCapsuleObject",
     "ThreeConeObject",

src/compas_notebook/scene/scene.py

@@ -0,0 +1,6 @@
+from compas.scene import Scene
+
+
+class NotebookScene(Scene):
+    def __init__(self, name: str = "NotebookScene", context: str = "Notebook"):
+        super().__init__(name=name, context=context)

src/compas_notebook/viewer.py

@@ -6,6 +6,7 @@
 
 from .config import Config
 from .controller import Controller
+from .scene import NotebookScene
 
 
 class Viewer:
@@ -39,11 +40,10 @@ class Viewer:
     def __init__(
         self,
         config: Config = None,
-        scene: Scene = None,
         controller: Controller = None,
     ):
+        self._scene = None
         self.config = config or Config()
-        self.scene = scene or Scene(context="Notebook")
         self.controller = controller or Controller(viewer=self)
 
         # move this to a UI class
@@ -56,6 +56,17 @@ def __init__(
     # System methods
     # =============================================================================
 
+    @property
+    def scene(self):
+        if self._scene is None:
+            self._scene = NotebookScene()
+        return self._scene
+
+    @scene.setter
+    def scene(self, scene: Scene) -> None:
+        scene = scene or NotebookScene()
+        self._scene: NotebookScene = NotebookScene.__from_data__(scene.__data__)
+
     def show(self) -> None:
         """Display the viewer in the notebook."""
         self.init_webgl()