BRAYNS-659 Release 3.9.0. (#1280)

BlueBrain · Aug 16, 2024 · 4716c12 · 4716c12
1 parent 8da0e63
commit 4716c12
Show file tree

Hide file tree

Showing 7 changed files with 139 additions and 6 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -18,7 +18,7 @@ set(BUILD_SHARED_LIBS ON)
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-project(Brayns VERSION 3.8.3)
+project(Brayns VERSION 3.9.0)
 
 # Extra CMake scripts
 list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/CMake)

diff --git a/python/brayns/version.py b/python/brayns/version.py
@@ -18,5 +18,5 @@
 # along with this library; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
-VERSION = "3.8.3"
+VERSION = "3.9.0"
 """Version tag of brayns Python package (major.minor.patch)."""
diff --git a/python/doc/source/conf.py b/python/doc/source/conf.py
@@ -58,7 +58,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = "3.8.3"
+version = "3.9.0"
 # The full version, including alpha/beta/rc tags.
 release = version
 

diff --git a/python/doc/source/jsonrpcapi/api_core_methods.rst b/python/doc/source/jsonrpcapi/api_core_methods.rst
@@ -13,7 +13,7 @@ mesh
 
 Can load the following formats: **off**, **stl**, **ply**, **obj**.
 
-This loader does not support loading binary data using 'upload-model'.
+This loader supports loading binary data using 'upload-model'.
 
 .. jsonschema::
 
@@ -4418,6 +4418,24 @@ progress notifications.
                 "description": "Path to save the buffer as EXR, encoded data is returned if unset",
                 "type": "string"
             },
+            "image_end": {
+                "description": "Image region end XY normalized",
+                "type": "array",
+                "items": {
+                    "type": "number"
+                },
+                "minItems": 2,
+                "maxItems": 2
+            },
+            "image_start": {
+                "description": "Image region start XY normalized",
+                "type": "array",
+                "items": {
+                    "type": "number"
+                },
+                "minItems": 2,
+                "maxItems": 2
+            },
             "renderer": {
                 "title": "EngineObjectData",
                 "description": "Renderer",
@@ -4597,6 +4615,50 @@ This entrypoint has no params, the "params" field can hence be omitted or null.
 
 ----
 
+get-camera-region
+~~~~~~~~~~~~~~~~~
+
+Retreive the current camera image region.
+
+**Params**:
+
+This entrypoint has no params, the "params" field can hence be omitted or null.
+
+**Result**:
+
+.. jsonschema::
+
+    {
+        "type": "object",
+        "properties": {
+            "image_end": {
+                "description": "Camera image region upper bound XY normalized",
+                "type": "array",
+                "items": {
+                    "type": "number"
+                },
+                "minItems": 2,
+                "maxItems": 2
+            },
+            "image_start": {
+                "description": "Camera image region lower bound XY normalized",
+                "type": "array",
+                "items": {
+                    "type": "number"
+                },
+                "minItems": 2,
+                "maxItems": 2
+            }
+        },
+        "required": [
+            "image_end",
+            "image_start"
+        ],
+        "additionalProperties": false
+    }
+
+----
+
 get-camera-type
 ~~~~~~~~~~~~~~~
 
@@ -6796,6 +6858,51 @@ null.
 
 ----
 
+set-camera-region
+~~~~~~~~~~~~~~~~~
+
+Update the camera image region.
+
+**Params**:
+
+.. jsonschema::
+
+    {
+        "type": "object",
+        "properties": {
+            "image_end": {
+                "description": "Camera image region upper bound XY normalized",
+                "type": "array",
+                "items": {
+                    "type": "number"
+                },
+                "minItems": 2,
+                "maxItems": 2
+            },
+            "image_start": {
+                "description": "Camera image region lower bound XY normalized",
+                "type": "array",
+                "items": {
+                    "type": "number"
+                },
+                "minItems": 2,
+                "maxItems": 2
+            }
+        },
+        "required": [
+            "image_end",
+            "image_start"
+        ],
+        "additionalProperties": false
+    }
+
+**Result**:
+
+This entrypoint has no result, the "result" field is still present but is always
+null.
+
+----
+
 set-camera-view
 ~~~~~~~~~~~~~~~
 
@@ -7720,6 +7827,15 @@ progress notifications.
                 "description": "Path to save image, raw encoded data will be returned if empty",
                 "type": "string"
             },
+            "image_end": {
+                "description": "Image region end XY normalized",
+                "type": "array",
+                "items": {
+                    "type": "number"
+                },
+                "minItems": 2,
+                "maxItems": 2
+            },
             "image_settings": {
                 "title": "ImageSettings",
                 "description": "Image settings",
@@ -7749,6 +7865,15 @@ progress notifications.
                 },
                 "additionalProperties": false
             },
+            "image_start": {
+                "description": "Image region start XY normalized",
+                "type": "array",
+                "items": {
+                    "type": "number"
+                },
+                "minItems": 2,
+                "maxItems": 2
+            },
             "metadata": {
                 "title": "ImageMetadata",
                 "description": "Metadata information to embed into the image",

diff --git a/python/doc/source/metadata.json b/python/doc/source/metadata.json
@@ -1,7 +1,7 @@
 {
     "name": "brayns",
     "description": "Brayns python API",
-    "version": "3.8.3",
+    "version": "3.9.0",
     "repository": {
         "type": "git",
         "url": "https://github.com/BlueBrain/Brayns.git"

diff --git a/python/doc/source/pythonapi/core.rst b/python/doc/source/pythonapi/core.rst
@@ -139,6 +139,14 @@ near_clip
     :undoc-members:
     :show-inheritance:
 
+region
+------
+
+.. automodule:: brayns.core.region
+    :members: get_camera_region, set_camera_region
+    :undoc-members:
+    :show-inheritance:
+
 view
 ----
 

diff --git a/python/setup.cfg b/python/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = brayns
-version = 3.8.3
+version = 3.9.0
 url = https://github.com/BlueBrain/Brayns
 download_url = https://github.com/BlueBrain/Brayns
 project_urls =