Merge pull request #10399 from peppy/editor-beatmap-batch-change-support

Add editor beatmap batch change support

osu.Game/Screens/Edit/Compose/Components/SelectionHandler.cs

@@ -239,10 +239,7 @@ namespace osu.Game.Screens.Edit.Compose.Components
         private void deleteSelected()
         {
             ChangeHandler?.BeginChange();
-
+            EditorBeatmap?.RemoveRange(selectedBlueprints.Select(b => b.HitObject));
-            foreach (var h in selectedBlueprints.ToList())
-                EditorBeatmap?.Remove(h.HitObject);
-
             ChangeHandler?.EndChange();
         }
 

osu.Game/Screens/Edit/Editor.cs

@@ -484,8 +484,7 @@ namespace osu.Game.Screens.Edit
         protected void Cut()
         {
             Copy();
-            foreach (var h in editorBeatmap.SelectedHitObjects.ToArray())
+            editorBeatmap.RemoveRange(editorBeatmap.SelectedHitObjects.ToArray());
-                editorBeatmap.Remove(h);
         }
 
         protected void Copy()

osu.Game/Screens/Edit/EditorBeatmap.cs

@@ -91,14 +91,19 @@ namespace osu.Game.Screens.Edit
 
         private readonly HashSet<HitObject> pendingUpdates = new HashSet<HitObject>();
 
+        private bool isBatchApplying;
+
         /// <summary>
         /// Adds a collection of <see cref="HitObject"/>s to this <see cref="EditorBeatmap"/>.
         /// </summary>
         /// <param name="hitObjects">The <see cref="HitObject"/>s to add.</param>
         public void AddRange(IEnumerable<HitObject> hitObjects)
         {
-            foreach (var h in hitObjects)
+            ApplyBatchChanges(_ =>
-                Add(h);
+            {
+                foreach (var h in hitObjects)
+                    Add(h);
+            });
         }
 
         /// <summary>
@@ -126,12 +131,17 @@ namespace osu.Game.Screens.Edit
 
             mutableHitObjects.Insert(index, hitObject);
 
-            // must be run after any change to hitobject ordering
+            if (isBatchApplying)
-            beatmapProcessor?.PreProcess();
+                batchPendingInserts.Add(hitObject);
-            processHitObject(hitObject);
+            else
-            beatmapProcessor?.PostProcess();
+            {
+                // must be run after any change to hitobject ordering
+                beatmapProcessor?.PreProcess();
+                processHitObject(hitObject);
+                beatmapProcessor?.PostProcess();
 
-            HitObjectAdded?.Invoke(hitObject);
+                HitObjectAdded?.Invoke(hitObject);
+            }
         }
 
         /// <summary>
@@ -159,6 +169,19 @@ namespace osu.Game.Screens.Edit
             return true;
         }
 
+        /// <summary>
+        /// Removes a collection of <see cref="HitObject"/>s to this <see cref="EditorBeatmap"/>.
+        /// </summary>
+        /// <param name="hitObjects">The <see cref="HitObject"/>s to remove.</param>
+        public void RemoveRange(IEnumerable<HitObject> hitObjects)
+        {
+            ApplyBatchChanges(_ =>
+            {
+                foreach (var h in hitObjects)
+                    Remove(h);
+            });
+        }
+
         /// <summary>
         /// Finds the index of a <see cref="HitObject"/> in this <see cref="EditorBeatmap"/>.
         /// </summary>
@@ -180,22 +203,56 @@ namespace osu.Game.Screens.Edit
             bindable.UnbindAll();
             startTimeBindables.Remove(hitObject);
 
-            // must be run after any change to hitobject ordering
+            if (isBatchApplying)
+                batchPendingDeletes.Add(hitObject);
+            else
+            {
+                // must be run after any change to hitobject ordering
+                beatmapProcessor?.PreProcess();
+                processHitObject(hitObject);
+                beatmapProcessor?.PostProcess();
+
+                HitObjectRemoved?.Invoke(hitObject);
+            }
+        }
+
+        private readonly List<HitObject> batchPendingInserts = new List<HitObject>();
+
+        private readonly List<HitObject> batchPendingDeletes = new List<HitObject>();
+
+        /// <summary>
+        /// Apply a batch of operations in one go, without performing Pre/Postprocessing each time.
+        /// </summary>
+        /// <param name="applyFunction">The function which will apply the batch changes.</param>
+        public void ApplyBatchChanges(Action<EditorBeatmap> applyFunction)
+        {
+            if (isBatchApplying)
+                throw new InvalidOperationException("Attempting to perform a batch application from within an existing batch");
+
+            isBatchApplying = true;
+
+            applyFunction(this);
+
             beatmapProcessor?.PreProcess();
-            processHitObject(hitObject);
+
+            foreach (var h in batchPendingDeletes) processHitObject(h);
+            foreach (var h in batchPendingInserts) processHitObject(h);
+
             beatmapProcessor?.PostProcess();
 
-            HitObjectRemoved?.Invoke(hitObject);
+            foreach (var h in batchPendingDeletes) HitObjectRemoved?.Invoke(h);
+            foreach (var h in batchPendingInserts) HitObjectAdded?.Invoke(h);
+
+            batchPendingDeletes.Clear();
+            batchPendingInserts.Clear();
+
+            isBatchApplying = false;
         }
 
         /// <summary>
         /// Clears all <see cref="HitObjects"/> from this <see cref="EditorBeatmap"/>.
         /// </summary>
-        public void Clear()
+        public void Clear() => RemoveRange(HitObjects.ToArray());
-        {
-            foreach (var h in HitObjects.ToArray())
-                Remove(h);
-        }
 
         protected override void Update()
         {

osu.Game/Screens/Edit/LegacyEditorBeatmapPatcher.cs

@@ -68,16 +68,19 @@ namespace osu.Game.Screens.Edit
             toRemove.Sort();
             toAdd.Sort();
 
-            // Apply the changes.
+            editorBeatmap.ApplyBatchChanges(eb =>
-            for (int i = toRemove.Count - 1; i >= 0; i--)
-                editorBeatmap.RemoveAt(toRemove[i]);
-
-            if (toAdd.Count > 0)
             {
-                IBeatmap newBeatmap = readBeatmap(newState);
+                // Apply the changes.
-                foreach (var i in toAdd)
+                for (int i = toRemove.Count - 1; i >= 0; i--)
-                    editorBeatmap.Insert(i, newBeatmap.HitObjects[i]);
+                    eb.RemoveAt(toRemove[i]);
-            }
+
+                if (toAdd.Count > 0)
+                {
+                    IBeatmap newBeatmap = readBeatmap(newState);
+                    foreach (var i in toAdd)
+                        eb.Insert(i, newBeatmap.HitObjects[i]);
+                }
+            });
         }
 
         private string readString(byte[] state) => Encoding.UTF8.GetString(state);