refactor: remove gpencil dump stroke legacy

Related to #166 and #215

docs/conf.py

@@ -19,10 +19,10 @@ import sys
 
 project = 'multi-user'
 copyright = '2020, Swann Martinez'
-author = 'Swann Martinez, with contributions from Poochy'
+author = 'Swann Martinez, Poochy, Fabian'
 
 # The full version, including alpha/beta/rc tags
-release = '0.2.0'
+release = '0.5.0-develop'
 
 
 # -- General configuration ---------------------------------------------------

multi_user/bl_types/bl_camera.py

@@ -56,7 +56,7 @@ class BlCamera(ReplicatedDatablock):
         background_images = data.get('background_images')
 
         datablock.background_images.clear()
-
+        # TODO: Use image uuid
         if background_images:
             for img_name, img_data in background_images.items():
                 img_id = img_data.get('image')

multi_user/bl_types/bl_gpencil.py

@@ -28,7 +28,7 @@ from replication.protocol import ReplicatedDatablock
 from .bl_datablock import resolve_datablock_from_uuid
 from .bl_action import dump_animation_data, load_animation_data, resolve_animation_dependencies
 from ..utils import get_preferences
-
+from ..timers import is_annotating
 
 STROKE_POINT = [
     'co',
@@ -65,36 +65,9 @@ def dump_stroke(stroke):
 
         :param stroke: target grease pencil stroke
         :type stroke: bpy.types.GPencilStroke
-        :return: dict
+        :return: (p_count, p_data)
     """
-
-    assert(stroke)
-
-    dumper = Dumper()
-    dumper.include_filter = [
-        "aspect",
-        "display_mode",
-        "draw_cyclic",
-        "end_cap_mode",
-        "hardeness",
-        "line_width",
-        "material_index",
-        "start_cap_mode",
-        "uv_rotation",
-        "uv_scale",
-        "uv_translation",
-        "vertex_color_fill",
-    ]
-    dumped_stroke = dumper.dump(stroke)
-
-    # Stoke points
-    p_count = len(stroke.points)
-    dumped_stroke['p_count'] = p_count
-    dumped_stroke['points'] = np_dump_collection(stroke.points, STROKE_POINT)
-
-    # TODO: uv_factor, uv_rotation
-
-    return dumped_stroke
+    return (len(stroke.points), np_dump_collection(stroke.points, STROKE_POINT))
 
 
 def load_stroke(stroke_data, stroke):
@@ -107,12 +80,12 @@ def load_stroke(stroke_data, stroke):
     """
     assert(stroke and stroke_data)
 
-    stroke.points.add(stroke_data["p_count"])
-    np_load_collection(stroke_data['points'], stroke.points, STROKE_POINT)
+    stroke.points.add(stroke_data[0])
+    np_load_collection(stroke_data[1], stroke.points, STROKE_POINT)
 
     # HACK: Temporary fix to trigger a BKE_gpencil_stroke_geometry_update to 
     # fix fill issues
-    stroke.uv_scale = stroke_data["uv_scale"]
+    stroke.uv_scale = 1.0
 
 
 def dump_frame(frame):
@@ -147,10 +120,12 @@ def load_frame(frame_data, frame):
 
     assert(frame and frame_data)
 
+    # Load stroke points
     for stroke_data in frame_data['strokes_points']:
         target_stroke = frame.strokes.new()
         load_stroke(stroke_data, target_stroke)
 
+    # Load stroke metadata
     np_load_collection(frame_data['strokes'], frame.strokes, STROKE)
 
 
@@ -170,7 +145,6 @@ def dump_layer(layer):
         'opacity',
         'channel_color',
         'color',
-        # 'thickness', #TODO: enabling only for annotation
         'tint_color',
         'tint_factor',
         'vertex_paint_opacity',
@@ -323,7 +297,8 @@ class BlGpencil(ReplicatedDatablock):
         return bpy.context.mode == 'OBJECT' \
             or layer_changed(datablock, data) \
             or frame_changed(data) \
-            or get_preferences().sync_flags.sync_during_editmode
+            or get_preferences().sync_flags.sync_during_editmode \
+            or is_annotating(bpy.context)
 
 _type = bpy.types.GreasePencil
 _class = BlGpencil

multi_user/bl_types/bl_image.py

@@ -69,11 +69,12 @@ class BlImage(ReplicatedDatablock):
     @staticmethod
     def load(data: dict, datablock: object):
         loader = Loader()
-        loader.load(data, datablock)
+        loader.load(datablock, data)
 
+        # datablock.name = data.get('name')
         datablock.source = 'FILE'
         datablock.filepath_raw = get_filepath(data['filename'])
-        color_space_name = data["colorspace_settings"]["name"]
+        color_space_name = data.get("colorspace")
 
         if color_space_name:
             datablock.colorspace_settings.name = color_space_name
@@ -92,12 +93,10 @@ class BlImage(ReplicatedDatablock):
             "name",
             # 'source',
             'size',
-            'height',
-            'alpha',
-            'float_buffer',
-            'alpha_mode',
-            'colorspace_settings']
+            'alpha_mode']
         data.update(dumper.dump(datablock))
+        data['colorspace'] = datablock.colorspace_settings.name
+
         return data
 
     @staticmethod
@@ -132,10 +131,7 @@ class BlImage(ReplicatedDatablock):
         if datablock.is_dirty:
             datablock.save()
 
-        if not data or (datablock and (datablock.name != data.get('name'))):
-            return True
-        else:
-            return False
+        return True
 
 _type = bpy.types.Image
 _class = BlImage

multi_user/bl_types/bl_material.py

@@ -124,8 +124,7 @@ def dump_node(node: bpy.types.ShaderNode) -> dict:
         "show_preview",
         "show_texture",
         "outputs",
-        "width_hidden",
-        "image"
+        "width_hidden"
     ]
 
     dumped_node = node_dumper.dump(node)

multi_user/bl_types/bl_object.py

@@ -620,10 +620,8 @@ class BlObject(ReplicatedDatablock):
 
         transform = data.get('transforms', None)
         if transform:
-            datablock.matrix_parent_inverse = mathutils.Matrix(
-                transform['matrix_parent_inverse'])
+            datablock.matrix_parent_inverse = mathutils.Matrix(transform['matrix_parent_inverse'])
             datablock.matrix_basis = mathutils.Matrix(transform['matrix_basis'])
-            datablock.matrix_local = mathutils.Matrix(transform['matrix_local'])
 
 
     @staticmethod

multi_user/bl_types/bl_scene.py

@@ -403,8 +403,9 @@ class BlScene(ReplicatedDatablock):
             datablock.world = bpy.data.worlds[data['world']]
 
         # Annotation
-        if 'grease_pencil' in data.keys():
-            datablock.grease_pencil = bpy.data.grease_pencils[data['grease_pencil']]
+        gpencil_uid = data.get('grease_pencil')
+        if gpencil_uid:
+            datablock.grease_pencil = resolve_datablock_from_uuid(gpencil_uid, bpy.data.grease_pencils)
 
         if get_preferences().sync_flags.sync_render_settings:
             if 'eevee' in data.keys():
@@ -445,6 +446,15 @@ class BlScene(ReplicatedDatablock):
         elif datablock.sequence_editor and not sequences:
             datablock.sequence_editor_clear()
 
+        # Timeline markers
+        markers = data.get('timeline_markers')
+        if markers:
+            datablock.timeline_markers.clear()
+            for name, frame, camera in markers:
+                marker = datablock.timeline_markers.new(name, frame=frame)
+                if camera:
+                    marker.camera = resolve_datablock_from_uuid(camera, bpy.data.objects)
+                marker.select = False
         # FIXME: Find a better way after the replication big refacotoring
         # Keep other user from deleting collection object by flushing their history
         flush_history()
@@ -461,7 +471,6 @@ class BlScene(ReplicatedDatablock):
             'name',
             'world',
             'id',
-            'grease_pencil',
             'frame_start',
             'frame_end',
             'frame_step',
@@ -517,6 +526,13 @@ class BlScene(ReplicatedDatablock):
                 dumped_sequences[seq.name] = dump_sequence(seq)
             data['sequences'] = dumped_sequences
 
+        # Timeline markers
+        if datablock.timeline_markers:
+            data['timeline_markers'] = [(m.name, m.frame, getattr(m.camera, 'uuid', None)) for m in datablock.timeline_markers]
+
+        if datablock.grease_pencil:
+            data['grease_pencil'] = datablock.grease_pencil.uuid
+ 
         return data
 
     @staticmethod

multi_user/handlers.py

@@ -52,7 +52,8 @@ def sanitize_deps_graph(remove_nodes: bool = False):
 def update_external_dependencies():
     """Force external dependencies(files such as images) evaluation 
     """
-    nodes_ids = [n.uuid for n in session.repository.graph.values() if n.data['type_id'] in ['WindowsPath', 'PosixPath']]
+    external_types = ['WindowsPath', 'PosixPath', 'Image']
+    nodes_ids = [n.uuid for n in session.repository.graph.values() if n.data['type_id'] in external_types]
     for node_id in nodes_ids:
         node = session.repository.graph.get(node_id)
         if node and node.owner in [session.repository.username, RP_COMMON]:
@@ -103,7 +104,8 @@ def on_scene_update(scene):
                 else:
                     continue
             elif isinstance(update.id, bpy.types.Scene):
-                scn_uuid = porcelain.add(session.repository, update.id)
+                scene = bpy.data.scenes.get(update.id.name)
+                scn_uuid = porcelain.add(session.repository, scene)
                 porcelain.commit(session.repository, scn_uuid)
                 porcelain.push(session.repository, 'origin', scn_uuid)
 

multi_user/operators.py

@@ -273,8 +273,7 @@ class SessionStartOperator(bpy.types.Operator):
 
         session_update = timers.SessionStatusUpdate()
         session_user_sync = timers.SessionUserSync()
-        session_background_executor = timers.MainThreadExecutor(
-            execution_queue=background_execution_queue)
+        session_background_executor = timers.MainThreadExecutor(execution_queue=background_execution_queue)
         session_listen = timers.SessionListenTimer(timeout=0.001)
 
         session_listen.register()
@@ -286,6 +285,7 @@ class SessionStartOperator(bpy.types.Operator):
         deleyables.append(session_update)
         deleyables.append(session_user_sync)
         deleyables.append(session_listen)
+        deleyables.append(timers.AnnotationUpdates())
 
         return {"FINISHED"}
 

multi_user/timers.py

@@ -41,7 +41,8 @@ this.registry = dict()
 def is_annotating(context: bpy.types.Context):
     """ Check if the annotate mode is enabled
     """
-    return bpy.context.workspace.tools.from_space_view3d_mode('OBJECT', create=False).idname == 'builtin.annotate'
+    active_tool = bpy.context.workspace.tools.from_space_view3d_mode('OBJECT', create=False)
+    return (active_tool and active_tool.idname == 'builtin.annotate')
 
 
 class Timer(object):
@@ -136,12 +137,50 @@ class ApplyTimer(Timer):
                                                 force=True)
 
 
+class AnnotationUpdates(Timer):
+    def __init__(self, timeout=1):
+        self._annotating = False
+        self._settings = utils.get_preferences()
+
+        super().__init__(timeout)
+
+    def execute(self):
+        if session and session.state == STATE_ACTIVE:
+            ctx = bpy.context
+            annotation_gp = ctx.scene.grease_pencil
+
+            if annotation_gp and not annotation_gp.uuid:
+                ctx.scene.update_tag()
+
+            # if an annotation exist and is tracked
+            if annotation_gp and annotation_gp.uuid:
+                registered_gp = session.repository.graph.get(annotation_gp.uuid)
+                if is_annotating(bpy.context):
+                    # try to get the right on it
+                    if registered_gp.owner == RP_COMMON:
+                        self._annotating = True
+                        logging.debug(
+                            "Getting the right on the annotation GP")
+                        porcelain.lock(session.repository,
+                                        registered_gp.uuid,
+                                        ignore_warnings=True,
+                                        affect_dependencies=False)
+
+                    if registered_gp.owner == self._settings.username:
+                        porcelain.commit(session.repository, annotation_gp.uuid)
+                        porcelain.push(session.repository, 'origin', annotation_gp.uuid)
+
+                elif self._annotating:
+                    porcelain.unlock(session.repository,
+                                    registered_gp.uuid,
+                                    ignore_warnings=True,
+                                    affect_dependencies=False)
+
 class DynamicRightSelectTimer(Timer):
     def __init__(self, timeout=.1):
         super().__init__(timeout)
         self._last_selection = []
         self._user = None
-        self._annotating = False
 
     def execute(self):
         settings = utils.get_preferences()
@@ -152,37 +191,6 @@ class DynamicRightSelectTimer(Timer):
                 self._user = session.online_users.get(settings.username)
 
             if self._user:
-                ctx = bpy.context
-                annotation_gp = ctx.scene.grease_pencil
-
-                if annotation_gp and not annotation_gp.uuid:
-                    ctx.scene.update_tag()
-
-                # if an annotation exist and is tracked
-                if annotation_gp and annotation_gp.uuid:
-                    registered_gp = session.repository.graph.get(annotation_gp.uuid)
-                    if is_annotating(bpy.context):
-                        # try to get the right on it
-                        if registered_gp.owner == RP_COMMON:
-                            self._annotating = True
-                            logging.debug(
-                                "Getting the right on the annotation GP")
-                            porcelain.lock(session.repository,
-                                            registered_gp.uuid,
-                                            ignore_warnings=True,
-                                            affect_dependencies=False)
-                        
-                        if registered_gp.owner == settings.username:
-                            gp_node = session.repository.graph.get(annotation_gp.uuid)
-                            porcelain.commit(session.repository, gp_node.uuid)
-                            porcelain.push(session.repository, 'origin', gp_node.uuid)
-
-                    elif self._annotating:
-                        porcelain.unlock(session.repository,
-                                        registered_gp.uuid,
-                                        ignore_warnings=True,
-                                        affect_dependencies=False)
-
                 current_selection = utils.get_selected_objects(
                     bpy.context.scene,
                     bpy.data.window_managers['WinMan'].windows[0].view_layer

multi_user/ui.py

@@ -599,20 +599,15 @@ class SESSION_PT_repository(bpy.types.Panel):
             # Properties
             owned_nodes = [k for k, v in  session.repository.graph.items() if v.owner==settings.username]
 
-            filtered_node = owned_nodes if runtime_settings.filter_owned else session.repository.graph.keys()
+            filtered_node = owned_nodes if runtime_settings.filter_owned else list(session.repository.graph.keys())
 
             if runtime_settings.filter_name:
-                for node_id in filtered_node:
-                    node_instance = session.repository.graph.get(node_id)
-                    name = node_instance.data.get('name')
-                    if runtime_settings.filter_name not in name:
-                        filtered_node.remove(node_id)
+                filtered_node = [n for n in filtered_node if runtime_settings.filter_name.lower() in session.repository.graph.get(n).data.get('name').lower()]
 
             if filtered_node:
                 col = layout.column(align=True)
                 for key in filtered_node:
                     draw_property(context, col, key)
-
             else:
                 layout.row().label(text="Empty")
 

tests/test_bl_types/test_scene.py

@@ -12,6 +12,8 @@ def test_scene(clear_blend):
     get_preferences().sync_flags.sync_render_settings = True
 
     datablock = bpy.data.scenes.new("toto")
+    datablock.timeline_markers.new('toto', frame=10)
+    datablock.timeline_markers.new('tata', frame=1)
     datablock.view_settings.use_curve_mapping = True
     # Test
     implementation = BlScene()