fix: annotation lock

Resolve "Optimize user selection draw code"

See merge request slumber/multi-user!142

multi_user/bl_types/bl_gpencil.py

@@ -28,7 +28,8 @@ 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
+from .bl_material import load_materials_slots, dump_materials_slots
 
 STROKE_POINT = [
     'co',
@@ -65,36 +66,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 +81,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 +121,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 +146,6 @@ def dump_layer(layer):
         'opacity',
         'channel_color',
         'color',
-        # 'thickness', #TODO: enabling only for annotation
         'tint_color',
         'tint_factor',
         'vertex_paint_opacity',
@@ -187,7 +162,7 @@ def dump_layer(layer):
         'hide',
         'annotation_hide',
         'lock',
-        # 'lock_frame',
+        'lock_frame',
         # 'lock_material',
         # 'use_mask_layer',
         'use_lights',
@@ -195,12 +170,13 @@ def dump_layer(layer):
         'select',
         'show_points',
         'show_in_front',
+        # 'thickness'
         # 'parent',
         # 'parent_type',
         # 'parent_bone',
         # 'matrix_inverse',
     ]
-    if layer.id_data.is_annotation:
+    if layer.thickness != 0:
         dumper.include_filter.append('thickness')
 
     dumped_layer = dumper.dump(layer)
@@ -255,10 +231,10 @@ class BlGpencil(ReplicatedDatablock):
 
     @staticmethod
     def load(data: dict, datablock: object):
-        datablock.materials.clear()
-        if "materials" in data.keys():
-            for mat in data['materials']:
-                datablock.materials.append(bpy.data.materials[mat])
+        # MATERIAL SLOTS
+        src_materials = data.get('materials', None)
+        if src_materials:
+            load_materials_slots(src_materials, datablock.materials)
 
         loader = Loader()
         loader.load(datablock, data)
@@ -286,7 +262,6 @@ class BlGpencil(ReplicatedDatablock):
         dumper = Dumper()
         dumper.depth = 2
         dumper.include_filter = [
-            'materials',
             'name',
             'zdepth_offset',
             'stroke_thickness_space',
@@ -294,7 +269,7 @@ class BlGpencil(ReplicatedDatablock):
             'stroke_depth_order'
         ]
         data = dumper.dump(datablock)
-
+        data['materials'] = dump_materials_slots(datablock.materials)
         data['layers'] = {}
 
         for layer in datablock.layers:
@@ -323,7 +298,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_material.py

@@ -387,11 +387,10 @@ def load_materials_slots(src_materials: list, dst_materials: bpy.types.bpy_prop_
 
     for mat_uuid, mat_name in src_materials:
         mat_ref = None
-        if mat_uuid is not None:
+        if mat_uuid:
             mat_ref = get_datablock_from_uuid(mat_uuid, None)
         else:
             mat_ref = bpy.data.materials[mat_name]
-
         dst_materials.append(mat_ref)
 
 

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():
@@ -470,7 +471,6 @@ class BlScene(ReplicatedDatablock):
             'name',
             'world',
             'id',
-            'grease_pencil',
             'frame_start',
             'frame_end',
             'frame_step',
@@ -530,6 +530,9 @@ class BlScene(ReplicatedDatablock):
         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/operators.py

@@ -285,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/presence.py

@@ -94,18 +94,21 @@ def project_to_viewport(region: bpy.types.Region, rv3d: bpy.types.RegionView3D,
     return [target.x, target.y, target.z]
 
 
-def bbox_from_obj(obj: bpy.types.Object) -> list:
+def bbox_from_obj(obj: bpy.types.Object, index: int = 1) -> list:
     """ Generate a bounding box for a given object by using its world matrix
 
         :param obj: target object
         :type obj: bpy.types.Object
+        :param index: indice offset
+        :type index: int 
         :return: list of 8 points [(x,y,z),...], list of 12 link between these points [(1,2),...]
     """
     radius = 1.0 # Radius of the bounding box
+    index = 8*index
     vertex_indices = (
-            (0, 1), (0, 2), (1, 3), (2, 3),
-            (4, 5), (4, 6), (5, 7), (6, 7),
-            (0, 4), (1, 5), (2, 6), (3, 7))
+            (0+index, 1+index), (0+index, 2+index), (1+index, 3+index), (2+index, 3+index),
+            (4+index, 5+index), (4+index, 6+index), (5+index, 7+index), (6+index, 7+index),
+            (0+index, 4+index), (1+index, 5+index), (2+index, 6+index), (3+index, 7+index))
 
     if obj.type == 'EMPTY':
         radius = obj.empty_display_size
@@ -117,9 +120,12 @@ def bbox_from_obj(obj: bpy.types.Object) -> list:
         radius = obj.data.display_size
     elif hasattr(obj, 'bound_box'):
         vertex_indices = (
-            (0, 1), (1, 2), (2, 3), (0, 3),
-            (4, 5), (5, 6), (6, 7), (4, 7),
-            (0, 4), (1, 5), (2, 6), (3, 7))
+            (0+index, 1+index), (1+index, 2+index),
+            (2+index, 3+index), (0+index, 3+index),
+            (4+index, 5+index), (5+index, 6+index),
+            (6+index, 7+index), (4+index, 7+index),
+            (0+index, 4+index), (1+index, 5+index),
+            (2+index, 6+index), (3+index, 7+index))
         vertex_pos = get_bb_coords_from_obj(obj)
         return vertex_pos, vertex_indices
 
@@ -136,26 +142,21 @@ def bbox_from_obj(obj: bpy.types.Object) -> list:
 
     return vertex_pos, vertex_indices
 
-def bbox_from_instance_collection(ic: bpy.types.Object) -> list:
+def bbox_from_instance_collection(ic: bpy.types.Object, index: int = 0) -> list:
     """ Generate a bounding box for a given instance collection by using its objects
 
         :param ic: target instance collection
         :type ic: bpy.types.Object
-        :param radius: bounding box radius
-        :type radius: float
+        :param index: indice offset
+        :type index: int
         :return: list of 8*objs points [(x,y,z),...], tuple of 12*objs link between these points [(1,2),...]
     """
     vertex_pos = []
     vertex_indices = ()
 
     for obj_index, obj in enumerate(ic.instance_collection.objects):
-        vertex_pos_temp, vertex_indices_temp = bbox_from_obj(obj)
+        vertex_pos_temp, vertex_indices_temp = bbox_from_obj(obj, index=index+obj_index)
         vertex_pos += vertex_pos_temp
-        vertex_indices_list_temp = list(list(indice) for indice in vertex_indices_temp)
-        for indice in vertex_indices_list_temp:
-            indice[0] += 8*obj_index
-            indice[1] += 8*obj_index
-        vertex_indices_temp = tuple(tuple(indice) for indice in vertex_indices_list_temp)
         vertex_indices += vertex_indices_temp
 
     bbox_corners = [ic.matrix_world @ mathutils.Vector(vertex) for vertex in vertex_pos]
@@ -223,7 +224,7 @@ def get_bb_coords_from_obj(object: bpy.types.Object, instance: bpy.types.Object
 
     bbox_corners = [base @ mathutils.Vector(
         corner) for corner in object.bound_box]
-    
+
 
     return [(point.x, point.y, point.z) for point in bbox_corners]
 
@@ -322,6 +323,8 @@ class UserSelectionWidget(Widget):
             username):
         self.username = username
         self.settings = bpy.context.window_manager.session
+        self.current_selection_ids = []
+        self.current_selected_objects = []
 
     @property
     def data(self):
@@ -331,6 +334,15 @@ class UserSelectionWidget(Widget):
         else:
             return None
 
+    @property
+    def selected_objects(self):
+        user_selection = self.data.get('selected_objects')
+        if self.current_selection_ids != user_selection:
+            self.current_selected_objects = [find_from_attr("uuid", uid, bpy.data.objects) for uid in user_selection]
+            self.current_selection_ids = user_selection
+
+        return self.current_selected_objects
+
     def poll(self):
         if self.data is None:
             return False
@@ -344,27 +356,32 @@ class UserSelectionWidget(Widget):
             self.settings.presence_show_selected and \
             self.settings.enable_presence
 
-    def draw(self):        
-        user_selection = self.data.get('selected_objects')
-        for select_obj in user_selection:
-            obj = find_from_attr("uuid", select_obj, bpy.data.objects)
-            if not obj:
-                return
-            if obj.instance_collection:
-                vertex_pos, vertex_indices = bbox_from_instance_collection(obj)
+    def draw(self):
+        vertex_pos = []
+        vertex_ind = []
+        collection_offset = 0
+        for obj_index, obj in enumerate(self.selected_objects):
+            if obj is None:
+                continue
+            obj_index+=collection_offset
+            if hasattr(obj, 'instance_collection') and obj.instance_collection:
+                bbox_pos, bbox_ind = bbox_from_instance_collection(obj, index=obj_index)
+                collection_offset+=len(obj.instance_collection.objects)-1
             else :
-                vertex_pos, vertex_indices = bbox_from_obj(obj)
+                bbox_pos, bbox_ind = bbox_from_obj(obj, index=obj_index)
+            vertex_pos += bbox_pos
+            vertex_ind += bbox_ind
 
-            shader = gpu.shader.from_builtin('3D_UNIFORM_COLOR')
-            batch = batch_for_shader(
-                shader,
-                'LINES',
-                {"pos": vertex_pos},
-                indices=vertex_indices)
+        shader = gpu.shader.from_builtin('3D_UNIFORM_COLOR')
+        batch = batch_for_shader(
+            shader,
+            'LINES',
+            {"pos": vertex_pos},
+            indices=vertex_ind)
 
-            shader.bind()
-            shader.uniform_float("color", self.data.get('color'))
-            batch.draw(shader)
+        shader.bind()
+        shader.uniform_float("color", self.data.get('color'))
+        batch.draw(shader)
 
 class UserNameWidget(Widget):
     draw_type = 'POST_PIXEL'

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,51 @@ 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)
+                    self._annotating = False
+
 class DynamicRightSelectTimer(Timer):
     def __init__(self, timeout=.1):
         super().__init__(timeout)
-        self._last_selection = []
+        self._last_selection = set()
         self._user = None
-        self._annotating = False
 
     def execute(self):
         settings = utils.get_preferences()
@@ -152,83 +192,46 @@ 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(
+                current_selection = set(utils.get_selected_objects(
                     bpy.context.scene,
                     bpy.data.window_managers['WinMan'].windows[0].view_layer
-                )
+                ))
                 if current_selection != self._last_selection:
-                    obj_common = [
-                        o for o in self._last_selection if o not in current_selection]
-                    obj_ours = [
-                        o for o in current_selection if o not in self._last_selection]
+                    to_lock = list(current_selection.difference(self._last_selection))
+                    to_release = list(self._last_selection.difference(current_selection))
+                    instances_to_lock = list()
 
-                    # change old selection right to common
-                    for obj in obj_common:
-                        node = session.repository.graph.get(obj)
+                    for node_id in to_lock:
+                        node = session.repository.graph.get(node_id)
+                        instance_mode = node.data.get('instance_type')
+                        if instance_mode and instance_mode == 'COLLECTION':
+                            to_lock.remove(node_id)
+                            instances_to_lock.append(node_id)
+                    if instances_to_lock:
+                        try:
+                            porcelain.lock(session.repository,
+                                            instances_to_lock,
+                                            ignore_warnings=True,
+                                            affect_dependencies=False)
+                        except NonAuthorizedOperationError as e:
+                            logging.warning(e)
 
-                        if node and (node.owner == settings.username or node.owner == RP_COMMON):
-                            recursive = True
-                            if node.data and 'instance_type' in node.data.keys():
-                                recursive = node.data['instance_type'] != 'COLLECTION'
-                            try:
-                                porcelain.unlock(session.repository,
-                                                node.uuid,
-                                                ignore_warnings=True,
-                                                affect_dependencies=recursive)
-                            except NonAuthorizedOperationError:
-                                logging.warning(
-                                    f"Not authorized to change {node} owner")
-
-                    # change new selection to our
-                    for obj in obj_ours:
-                        node = session.repository.graph.get(obj)
-
-                        if node and node.owner == RP_COMMON:
-                            recursive = True
-                            if node.data and 'instance_type' in node.data.keys():
-                                recursive = node.data['instance_type'] != 'COLLECTION'
-
-                            try:
-                                porcelain.lock(session.repository,
-                                               node.uuid,
-                                               ignore_warnings=True,
-                                               affect_dependencies=recursive)
-                            except NonAuthorizedOperationError:
-                                logging.warning(
-                                    f"Not authorized to change {node} owner")
-                        else:
-                            return
+                    if to_release:
+                        try:
+                            porcelain.unlock(session.repository,
+                                            to_release,
+                                            ignore_warnings=True,
+                                            affect_dependencies=True)
+                        except NonAuthorizedOperationError as e:
+                            logging.warning(e)
+                    if to_lock:
+                        try:
+                            porcelain.lock(session.repository,
+                                            to_lock,
+                                            ignore_warnings=True,
+                                            affect_dependencies=True)
+                        except NonAuthorizedOperationError as e:
+                            logging.warning(e)
 
                     self._last_selection = current_selection
 
@@ -242,17 +245,16 @@ class DynamicRightSelectTimer(Timer):
                     # Fix deselection until right managment refactoring (with Roles concepts)
                     if len(current_selection) == 0 :
                         owned_keys = [k for k, v in session.repository.graph.items() if v.owner==settings.username]
-                        for key in owned_keys:
-                            node = session.repository.graph.get(key)
+                        if owned_keys:
                             try:
                                 porcelain.unlock(session.repository,
-                                                key,
+                                                owned_keys,
                                                 ignore_warnings=True,
                                                 affect_dependencies=True)
-                            except NonAuthorizedOperationError:
-                                logging.warning(
-                                    f"Not authorized to change {key} owner")
+                            except NonAuthorizedOperationError as e:
+                                logging.warning(e)
 
+            # Objects selectability
             for obj in bpy.data.objects:
                 object_uuid = getattr(obj, 'uuid', None)
                 if object_uuid: