diff --git a/CMakeLists.txt b/CMakeLists.txt index 7aca64c35..f4640b04c 100644 --- 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.2.1) +project(Brayns VERSION 3.2.2) # Extra CMake scripts list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/CMake) diff --git a/Changelog.md b/Changelog.md index bee811a04..591db2145 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,5 +1,18 @@ # Change Log +## [3.2.2](https://github.com/BlueBrain/Brayns/tree/3.2.2) + +**Implemented fixes and enhancements:** + +- Use libsonata endfeet mesh path [\#1201] (https://github.com/BlueBrain/Brayns/pull/1201) +- Add healthcheck for Docker [\#1200](https://github.com/BlueBrain/Brayns/pull/1200) +- Replace glm with rkcommon math [\#1198](https://github.com/BlueBrain/Brayns/pull/1198) +- Add morphology section coloring [\#1196](https://github.com/BlueBrain/Brayns/pull/1196) +- Add principled material [\#1195](https://github.com/BlueBrain/Brayns/pull/1195) +- Add bbp metadata to image [\#1194](https://github.com/BlueBrain/Brayns/pull/1194) +- Optimize morphology section geometry mapping [\#1193](https://github.com/BlueBrain/Brayns/pull/1193) +- Include zlib and bzip2 include dirs [\#1192](https://github.com/BlueBrain/Brayns/pull/1192) + ## [3.2.1](https://github.com/BlueBrain/Brayns/tree/3.2.1) **Implemented fixes and enhancements:** diff --git a/python/brayns/version.py b/python/brayns/version.py index 8096caa8e..abf4db6ea 100644 --- 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.2.1" +VERSION = "3.2.2" """Version tag of brayns Python package (major.minor.patch).""" diff --git a/python/doc/source/conf.py b/python/doc/source/conf.py index 423a44cac..dfa0d29e8 100644 --- 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.2.1" +version = "3.2.2" # 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 index dea718a7f..149fd02cd 100644 --- a/python/doc/source/jsonrpcapi/api_core_methods.rst +++ b/python/doc/source/jsonrpcapi/api_core_methods.rst @@ -4870,6 +4870,172 @@ Returns the material of the given model as a plastic material, if possible. ---- +get-material-principled +~~~~~~~~~~~~~~~~~~~~~~~ + +Returns the material of the given model as a principled material, if possible. + +**Params**: + +.. jsonschema:: + + { + "type": "object", + "properties": { + "id": { + "description": "Model ID", + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "id" + ], + "additionalProperties": false + } + +**Result**: + +.. jsonschema:: + + { + "type": "object", + "properties": { + "anisotropy": { + "description": "Specular anisotropy reflection weight (Specular highlights depends on surface type/shape)", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "anisotropy_rotation": { + "description": "Rotation of the specular anisotropy reflection effect", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "back_light": { + "description": "For thin objects, weight of reflection and transmission (1 = 50/50, 2 = only transmission)", + "type": "number", + "minimum": 0, + "maximum": 2 + }, + "coat": { + "description": "Clear coat weight (thin lacquered/glossy layer on top of the surface)", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "coat_color": { + "description": "Clear coat color", + "type": "array", + "items": { + "type": "number" + }, + "minItems": 3, + "maxItems": 3 + }, + "coat_ior": { + "description": "Clear coat index of refraction", + "type": "number" + }, + "coat_roughness": { + "description": "Clear coat diffuse/specular reflection roughness", + "type": "number" + }, + "coat_thickness": { + "description": "Clear coat thickness", + "type": "number" + }, + "diffuse": { + "description": "Diffuse reflection weight", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "edge_color": { + "description": "Edge tint for metallic surfaces", + "type": "array", + "items": { + "type": "number" + }, + "minItems": 3, + "maxItems": 3 + }, + "ior": { + "description": "Dielectric index of refraction", + "type": "number", + "minimum": 1 + }, + "metallic": { + "description": "Alpha parameter between dielectric and metallic", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "roughness": { + "description": "Diffuse and specular reflection roughness", + "type": "number" + }, + "sheen": { + "description": "Sheen effect weight (fabric-like effect such as satin or velvet)", + "type": "number" + }, + "sheen_color": { + "description": "Sheen color", + "type": "array", + "items": { + "type": "number" + }, + "minItems": 3, + "maxItems": 3 + }, + "sheen_roughness": { + "description": "Sheen diffuse/specular reflection roughness", + "type": "number" + }, + "sheen_tint": { + "description": "Strenght of sheen color (0 = white, 1 = sheen color)", + "type": "number" + }, + "specular": { + "description": "Specular reflection/transmission weight", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "thickness": { + "description": "Thickness of the object if thin = true", + "type": "number" + }, + "thin": { + "description": "Specified wether the object is solid or thin (hollow)", + "type": "boolean" + }, + "transmission": { + "description": "Specular transmission weight", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "transmission_color": { + "description": "Transmission attenuation color", + "type": "array", + "items": { + "type": "number" + }, + "minItems": 3, + "maxItems": 3 + }, + "transmission_depth": { + "description": "Distance from surface at which the color will equal transmission color", + "type": "number" + } + }, + "additionalProperties": false + } + +---- + get-material-type ~~~~~~~~~~~~~~~~~ @@ -6786,6 +6952,175 @@ null. ---- +set-material-principled +~~~~~~~~~~~~~~~~~~~~~~~ + +Updates the material of the given model to a principled material. This material is only usable with the production renderer. + +**Params**: + +.. jsonschema:: + + { + "type": "object", + "properties": { + "material": { + "title": "Principled", + "description": "Material parameters", + "type": "object", + "properties": { + "anisotropy": { + "description": "Specular anisotropy reflection weight (Specular highlights depends on surface type/shape)", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "anisotropy_rotation": { + "description": "Rotation of the specular anisotropy reflection effect", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "back_light": { + "description": "For thin objects, weight of reflection and transmission (1 = 50/50, 2 = only transmission)", + "type": "number", + "minimum": 0, + "maximum": 2 + }, + "coat": { + "description": "Clear coat weight (thin lacquered/glossy layer on top of the surface)", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "coat_color": { + "description": "Clear coat color", + "type": "array", + "items": { + "type": "number" + }, + "minItems": 3, + "maxItems": 3 + }, + "coat_ior": { + "description": "Clear coat index of refraction", + "type": "number" + }, + "coat_roughness": { + "description": "Clear coat diffuse/specular reflection roughness", + "type": "number" + }, + "coat_thickness": { + "description": "Clear coat thickness", + "type": "number" + }, + "diffuse": { + "description": "Diffuse reflection weight", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "edge_color": { + "description": "Edge tint for metallic surfaces", + "type": "array", + "items": { + "type": "number" + }, + "minItems": 3, + "maxItems": 3 + }, + "ior": { + "description": "Dielectric index of refraction", + "type": "number", + "minimum": 1 + }, + "metallic": { + "description": "Alpha parameter between dielectric and metallic", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "roughness": { + "description": "Diffuse and specular reflection roughness", + "type": "number" + }, + "sheen": { + "description": "Sheen effect weight (fabric-like effect such as satin or velvet)", + "type": "number" + }, + "sheen_color": { + "description": "Sheen color", + "type": "array", + "items": { + "type": "number" + }, + "minItems": 3, + "maxItems": 3 + }, + "sheen_roughness": { + "description": "Sheen diffuse/specular reflection roughness", + "type": "number" + }, + "sheen_tint": { + "description": "Strenght of sheen color (0 = white, 1 = sheen color)", + "type": "number" + }, + "specular": { + "description": "Specular reflection/transmission weight", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "thickness": { + "description": "Thickness of the object if thin = true", + "type": "number" + }, + "thin": { + "description": "Specified wether the object is solid or thin (hollow)", + "type": "boolean" + }, + "transmission": { + "description": "Specular transmission weight", + "type": "number", + "minimum": 0, + "maximum": 1 + }, + "transmission_color": { + "description": "Transmission attenuation color", + "type": "array", + "items": { + "type": "number" + }, + "minItems": 3, + "maxItems": 3 + }, + "transmission_depth": { + "description": "Distance from surface at which the color will equal transmission color", + "type": "number" + } + }, + "additionalProperties": false + }, + "model_id": { + "description": "ID of the model to apply the material", + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "material", + "model_id" + ], + "additionalProperties": false + } + +**Result**: + +This entrypoint has no result, the "result" field is still present but is always +null. + +---- + set-renderer-interactive ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -7038,6 +7373,39 @@ progress notifications. }, "additionalProperties": false }, + "metadata": { + "title": "ImageMetadata", + "description": "Metadata information to embed into the image", + "type": "object", + "properties": { + "description": { + "description": "Image description", + "type": "string" + }, + "keywords": { + "description": "List of keywords to describe the image contents", + "type": "array", + "items": { + "type": "string" + } + }, + "title": { + "description": "Image title", + "type": "string" + }, + "where_used": { + "description": "Event (publication, website, panel, etc.) for what the image was created", + "type": "string" + } + }, + "required": [ + "description", + "keywords", + "title", + "where_used" + ], + "additionalProperties": false + }, "renderer": { "title": "EngineObjectData", "description": "Renderer definition", diff --git a/python/doc/source/metadata.json b/python/doc/source/metadata.json index ffbee9e88..c7eb6f6a5 100644 --- a/python/doc/source/metadata.json +++ b/python/doc/source/metadata.json @@ -1,7 +1,7 @@ { "name": "brayns", "description": "Brayns python API", - "version": "3.2.1", + "version": "3.2.2", "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 index 93874f6bd..57d9720f7 100644 --- a/python/doc/source/pythonapi/core.rst +++ b/python/doc/source/pythonapi/core.rst @@ -47,7 +47,7 @@ material -------- .. automodule:: brayns.core.material - :members: CarPaintMaterial, EmissiveMaterial, get_material_name, get_material, GhostMaterial, GlassMaterial, Material, MatteMaterial, MetalMaterial, PhongMaterial, PlasticMaterial, set_material + :members: CarPaintMaterial, EmissiveMaterial, get_material_name, get_material, GhostMaterial, GlassMaterial, Material, MatteMaterial, MetalMaterial, PhongMaterial, PlasticMaterial, PrincipledMaterial, set_material :undoc-members: :show-inheritance: @@ -163,18 +163,18 @@ image :undoc-members: :show-inheritance: -pick ----- +snapshot +-------- -.. automodule:: brayns.core.pick - :members: pick, PickResult +.. automodule:: brayns.core.snapshot + :members: ImageMetadata, Snapshot :undoc-members: :show-inheritance: -snapshot --------- +pick +---- -.. automodule:: brayns.core.snapshot - :members: Snapshot +.. automodule:: brayns.core.pick + :members: pick, PickResult :undoc-members: :show-inheritance: \ No newline at end of file diff --git a/python/doc/source/pythonapi/plugins.rst b/python/doc/source/pythonapi/plugins.rst index 3cfb91a6e..af925f47e 100644 --- a/python/doc/source/pythonapi/plugins.rst +++ b/python/doc/source/pythonapi/plugins.rst @@ -55,7 +55,7 @@ morphology ---------- .. automodule:: brayns.plugins.morphology - :members: GeometryType, Morphology, MorphologyLoader + :members: GeometryType, Morphology, MorphologyColorMethod, MorphologyLoader :undoc-members: :show-inheritance: diff --git a/python/setup.cfg b/python/setup.cfg index 1ef647487..a5bf0453e 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = brayns -version = 3.2.1 +version = 3.2.2 url = https://github.com/BlueBrain/Brayns download_url = https://github.com/BlueBrain/Brayns project_urls =