Merge branch '145-support-volume-objects' into 'develop'

Resolve "Support volume objects"

See merge request slumber/multi-user!79

README.md

@@ -51,7 +51,7 @@ Currently, not all data-block are supported for replication over the wire. The f
 | compositing |   ❌    |         [Planned](https://gitlab.com/slumber/multi-user/-/issues/46)         |
 | texts       |   ❌    |         [Planned](https://gitlab.com/slumber/multi-user/-/issues/81)         |
 | nla         |   ❌    |                                                                              |
-| volumes     |   ❌    |                                                                              |
+| volumes     |   ✔️    |                                                                              |
 | particles   |   ❌    |        [On-going](https://gitlab.com/slumber/multi-user/-/issues/24)         |
 | speakers    |   ❗    |         [Partial](https://gitlab.com/slumber/multi-user/-/issues/65)         |
 | vse         |   ❗    |                       Mask and Clip not supported yet                        |

multi_user/bl_types/__init__.py

@@ -15,6 +15,7 @@
 #
 # ##### END GPL LICENSE BLOCK #####
 
+import bpy
 
 __all__ = [
     'bl_object',
@@ -40,9 +41,12 @@ __all__ = [
     'bl_file',
     'bl_sequencer',
     'bl_node_group',
-    'bl_texture'
+    'bl_texture',
 ]  # Order here defines execution order
 
+if bpy.app.version[1] >= 91:
+    __all__.append('bl_volume')
+
 from . import *
 from replication.data import ReplicatedDataFactory
 

multi_user/bl_types/bl_object.py

@@ -63,6 +63,9 @@ def find_data_from_name(name=None):
         else:
             logging.warning(
                 "Lightprobe replication only supported since 2.83. See https://developer.blender.org/D6396")
+    elif bpy.app.version[1] >= 91 and name in bpy.data.volumes.keys():
+        # Only supported since 2.91 
+        instance = bpy.data.volumes[name]
     return instance
 
 

multi_user/bl_types/bl_texture.py

@@ -47,7 +47,7 @@ class BlTexture(BlDatablock):
         dumper.exclude_filter = [
             'tag',
             'original',
-            'user',
+            'users',
             'uuid',
             'is_embedded_data',
             'is_evaluated',

multi_user/bl_types/bl_volume.py

@@ -0,0 +1,76 @@
+# ##### BEGIN GPL LICENSE BLOCK #####
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+# ##### END GPL LICENSE BLOCK #####
+
+
+import bpy
+import mathutils
+from pathlib import Path
+
+from .dump_anything import Loader, Dumper
+from .bl_datablock import BlDatablock
+
+
+class BlVolume(BlDatablock):
+    bl_id = "volumes"
+    bl_class = bpy.types.Volume
+    bl_delay_refresh = 1
+    bl_delay_apply = 1
+    bl_automatic_push = True
+    bl_check_common = False
+    bl_icon = 'VOLUME_DATA'
+
+    def _load_implementation(self, data, target):
+        loader = Loader()
+        loader.load(target, data)
+        loader.load(target.display, data['display'])
+
+    def _construct(self, data):
+        return bpy.data.volumes.new(data["name"])
+
+    def _dump_implementation(self, data, instance=None):
+        assert(instance)
+
+        dumper = Dumper()
+        dumper.depth = 1
+        dumper.exclude_filter = [
+            'tag',
+            'original',
+            'users',
+            'uuid',
+            'is_embedded_data',
+            'is_evaluated',
+            'name_full',
+            'use_fake_user'
+        ]
+
+        data = dumper.dump(instance)
+
+        data['display'] = dumper.dump(instance.display)
+
+        return data
+
+    def _resolve_deps_implementation(self):
+        # TODO: resolve material
+        deps = []
+
+        external_vdb = Path(bpy.path.abspath(self.instance.filepath))
+        if external_vdb.exists() and not external_vdb.is_dir():
+            deps.append(external_vdb)
+
+        return deps
+
+

tests/test_bl_types/test_volume.py

@@ -0,0 +1,21 @@
+import os
+
+import pytest
+from deepdiff import DeepDiff
+
+import bpy
+import random
+from multi_user.bl_types.bl_volume import BlVolume
+
+def test_volume(clear_blend):
+    datablock = bpy.data.volumes.new("Test")
+
+    implementation = BlVolume()
+    expected = implementation._dump(datablock)
+    bpy.data.volumes.remove(datablock)
+
+    test = implementation._construct(expected)
+    implementation._load(expected, test)
+    result = implementation._dump(test)
+
+    assert not DeepDiff(expected, result)