feature/view-setting-config

CHANGELOG.md

@@ -9,24 +9,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added `view_port` and `camera` in the config
+
 ### Changed
 
 ### Removed
 
-
 ## [0.10.1] 2023-12-12
 
 ### Added
 
-
 ### Changed
 
-
 ### Removed
 
 * Removed dependency on `cython`.
 
-
 ## [0.10.0] 2023-11-27
 
 ### Added

docs/examples/control/example_camera_config.py

@@ -0,0 +1,36 @@
+from compas.geometry import Box
+from compas.geometry import Frame
+from compas_view2.app import App
+
+# If you input incomplete configuration, the rest will be filled by the default values.
+
+config = {
+    "view": {
+        "show_grid": True,
+        "view_mode": "shaded",
+        "background_color": [1, 1, 1, 1],
+        "selection_color": [1.0, 1.0, 0.0],
+        "view_port": "CUSTOM",
+        "camera": {
+            "fov": 45,
+            "near": 0.1,
+            "far": 1000,
+            "position": [-15, -15, 15],
+            "target": [0, 0, 0],
+            "scale": 1,
+        },
+    }
+}
+
+viewer_default = App()
+viewer_custom = App(config=config)
+
+
+box = Box(Frame([0, 0, 0], [1, 0, 0], [0, 1, 0]), 1, 1, 1)
+
+viewer_default.add(box)
+viewer_custom.add(box)
+
+
+viewer_default.run()
+viewer_custom.run()

docs/examples/control/example_camera_config.rst

@@ -0,0 +1,31 @@
+*******************************************************************************
+Camera Config
+*******************************************************************************
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+
+Default Camera Config
+====================
+
+By default, the camera is configed 45 dregees perspective:
+
+.. figure:: /_images/example_camera_config.jpg
+    :figclass: figure
+    :class: figure-img img-fluid
+
+
+
+Custom Camera Config
+====================
+
+You can customize the camera configreation by passing the dictionary to the viewer: fov, near, fac 100, position, target, scale.
+
+
+.. figure:: /_images/example_camera_config_2.jpg
+    :figclass: figure
+    :class: figure-img img-fluid
+
+.. literalinclude:: example_camera_config.py
+    :language: python

docs/examples/control/example_custom_keys.rst

@@ -7,7 +7,7 @@ Custom Keys
     :nosignatures:
 
 Default Keys
-===========
+=============
 
 By default, the keys are like:
 
@@ -18,7 +18,7 @@ By default, the keys are like:
 
 
 Custom Keys
-===========
+=============
 
 You can customize the keys by modifying the ``keys`` parameter of the configuration.
 

docs/tutorials/tutorial_basics.rst

@@ -189,7 +189,7 @@ use the "on" decorator (:meth:`compas_view2.app.App.on`) on a callback function.
 
 
 Zoom, Pan, Rotate, and Select
-=================
+===========================
 
 After launching the viewer, the view can be transformed by zooming, panning, and rotating. Object selection is also possible.
 

docs/tutorials/tutorial_configuration.rst

@@ -25,7 +25,7 @@ Thinking of the ``options`` in :mod:`Rhino` , the ``preferences..`` in :mod:`Ble
 
 
 Customize Your Viewer
-===================
+=====================
 
 There are two ways to customize your viewer:
 
@@ -65,7 +65,7 @@ This is a quick way to customize your viewer. It is suitable for task-specific c
 
 
 Configuration Structure
-====================
+======================
 The default configuration file can be downloaded here: :download:`Link <files/config_default.json>`,
 or can be printed by the following code:
 

docs/tutorials/tutorial_software_concepts.rst

@@ -25,21 +25,21 @@ to help you better the design concepts behind it.
 
 
 Software Architecture
-===========
+===================
 
 .. figure:: /_images/software_concept.png
      :figclass: figure
      :class: figure-img img-fluid
 
 
 UI Components
-===========
+===============
 .. figure:: /_images/UI.PNG
      :figclass: figure
      :class: figure-img img-fluid
 
 Configuration Structure
-===========
+=====================
 .. figure:: /_images/config_structure.png
      :figclass: figure
      :class: figure-img img-fluid

requirements-dev.txt

@@ -16,7 +16,7 @@ m2r2
 nbsphinx
 pydocstyle
 pytest
-sphinx == 7.1.2
+sphinx >=3.4, <=7.1.2
 sphinx_compas_theme >=0.15.18
 twine
 wheel

src/compas_view2/app/config_default.json

@@ -14,8 +14,17 @@
     "view": {
         "show_grid": true,
         "view_mode": "shaded",
+        "view_port": "CUSTOM",
         "background_color": [1, 1, 1, 1],
-        "selection_color": [1.0, 1.0, 0.0]
+        "selection_color": [1.0, 1.0, 0.0],
+        "camera": {
+            "fov": 45,
+            "near": 0.1,
+            "far": 1000,
+            "position":[-1.5, -1.5, 1.5],
+            "target": [0, 0, 0],
+            "scale": 1
+        }
     },
     "statusbar": {
         "texts": "Ready",

src/compas_view2/app/controller.py

@@ -431,7 +431,7 @@ def view_front(self):
         None
 
         """
-        self.app.view.current = self.app.view.FRONT
+        self.app.view.current = self.app.view.VIEW_ANGLES["FRONT"]
         self.app.view.camera.reset_position()
         self.app.view.update_projection()
         self.app.view.update()
@@ -444,7 +444,7 @@ def view_right(self):
         None
 
         """
-        self.app.view.current = self.app.view.RIGHT
+        self.app.view.current = self.app.view.VIEW_ANGLES["RIGHT"]
         self.app.view.camera.reset_position()
         self.app.view.update_projection()
         self.app.view.update()
@@ -457,7 +457,7 @@ def view_top(self):
         None
 
         """
-        self.app.view.current = self.app.view.TOP
+        self.app.view.current = self.app.view.VIEW_ANGLES["TOP"]
         self.app.view.camera.reset_position()
         self.app.view.update_projection()
         self.app.view.update()
@@ -470,7 +470,7 @@ def view_perspective(self):
         None
 
         """
-        self.app.view.current = self.app.view.PERSPECTIVE
+        self.app.view.current = self.app.view.VIEW_ANGLES["PERSPECTIVE"]
         self.app.view.camera.reset_position()
         self.app.view.update_projection()
         self.app.view.update()

src/compas_view2/scene/camera.py

@@ -232,13 +232,13 @@ def _on_target_update(self, target):
     def reset_position(self):
         """Reset the position of the camera based current view type."""
         self.target.set(0, 0, 0)
-        if self.view.current == self.view.PERSPECTIVE:
+        if self.view.current == self.view.VIEW_ANGLES["PERSPECTIVE"] or self.view.current == self.view.VIEW_ANGLES["CUSTOM"]:
             self.rotation.set(pi / 4, 0, -pi / 4)
-        if self.view.current == self.view.TOP:
+        if self.view.current == self.view.VIEW_ANGLES["TOP"]:
             self.rotation.set(0, 0, 0)
-        if self.view.current == self.view.FRONT:
+        if self.view.current == self.view.VIEW_ANGLES["FRONT"]:
             self.rotation.set(pi / 2, 0, 0)
-        if self.view.current == self.view.RIGHT:
+        if self.view.current == self.view.VIEW_ANGLES["RIGHT"]:
             self.rotation.set(pi / 2, 0, pi / 2)
 
     def rotate(self, dx, dy):
@@ -257,10 +257,10 @@ def rotate(self, dx, dy):
 
         Notes
         -----
-        Camera rotations are only available if the current view is a perspective view (``camera.view.current == camera.view.PERSPECTIVE``).
+        Camera rotations are only available if the current view is a perspective view (``camera.view.current == camera.view.VIEW_ANGLES["PERSPECTIVE"]``).
 
         """
-        if self.view.current == self.view.PERSPECTIVE:
+        if self.view.current == self.view.VIEW_ANGLES["PERSPECTIVE"] or self.view.current == self.view.VIEW_ANGLES["CUSTOM"]:
             self.rotation += [-self.rotation_delta * dy, 0, -self.rotation_delta * dx]
 
     def pan(self, dx, dy):
@@ -320,7 +320,7 @@ def projection(self, width, height):
 
         """
         aspect = width / height
-        if self.view.current == self.view.PERSPECTIVE:
+        if self.view.current == self.view.VIEW_ANGLES["PERSPECTIVE"] or self.view.current == self.view.VIEW_ANGLES["CUSTOM"]:
             P = perspective(self.fov, aspect, self.near * self.scale, self.far * self.scale)
         else:
             left = -self.distance

src/compas_view2/views/view.py

@@ -1,11 +1,11 @@
 import time
-from OpenGL import GL
 
+from OpenGL import GL
 from qtpy import QtCore
 from qtpy import QtWidgets
 
-from compas_view2.scene import Camera
 from compas_view2.objects import GridObject
+from compas_view2.scene import Camera
 
 
 class View(QtWidgets.QOpenGLWidget):
@@ -19,23 +19,20 @@ class View(QtWidgets.QOpenGLWidget):
         The view configuration.
     """
 
-    FRONT = 1
-    RIGHT = 2
-    TOP = 3
-    PERSPECTIVE = 4
+    VIEW_ANGLES = {"CUSTOM": 0, "FRONT": 1, "RIGHT": 2, "TOP": 3, "PERSPECTIVE": 4}
 
     def __init__(self, app, view_config):
         super().__init__()
         self.setFocusPolicy(QtCore.Qt.StrongFocus)
         self._opacity = 1.0
-        self._current = View.PERSPECTIVE
+        self._current = self.VIEW_ANGLES[view_config["view_port"]]
         self.shader_model = None
         self.app = app
         self.color = view_config["background_color"]
         self.mode = view_config["view_mode"]
         self.selection_color = view_config["selection_color"]
         self.show_grid = view_config["show_grid"]
-        self.camera = Camera(self)
+        self.camera = Camera(self, **view_config["camera"]) if self._current == 0 else Camera(self)
         self.grid = GridObject(1, 10, 10)
         self.objects = {}
         self.keys = {"shift": False, "control": False, "f": False}

src/compas_view2/views/view120.py

@@ -120,7 +120,7 @@ def sort_objects_from_viewworld(self, viewworld):
 
     def paint(self):
         viewworld = self.camera.viewworld()
-        if self.current != self.PERSPECTIVE:
+        if self.current != self.VIEW_ANGLES["PERSPECTIVE"]  or self.current != self.VIEW_ANGLES["CUSTOM"]:
             self.update_projection()
 
         # Draw instance maps