#5623: Merge action nodes automatically set the active/inactive state…

… of the encapsulated actions when they are inserted into or removed from the scene, respectively.

include/imergeaction.h

@@ -22,6 +22,7 @@ enum class ActionType
 
 /**
  * Represents a merge action, i.e. one single step of a merge operation.
+ * Only active actions will be processed when the merge run starts.
  */ 
 class IMergeAction
 {
@@ -33,7 +34,17 @@ class IMergeAction
     // The type performed by this action
     virtual ActionType getType() const = 0;
 
-    // Applies all changes defined by this action.
+    // Activate this action, it will be executed during the merge
+    virtual void activate() = 0;
+
+    // Deactivate this action, it will NOT be executed during the merge
+    virtual void deactivate() = 0;
+
+    // Returns the active state of this action
+    virtual bool isActive() const = 0;
+
+    // Applies all changes defined by this action (if it is active,
+    // deactivated action will not take any effect).
     // It's the caller's responsibility to set up any Undo operations.
     // Implementations are allowed to throw std::runtime_errors on failure.
     virtual void applyChanges() = 0;

libs/scene/merge/MergeAction.h

@@ -20,9 +20,12 @@ class MergeAction :
 private:
     ActionType _type;
 
+    bool _isActive;
+
 protected:
     MergeAction(ActionType type) :
-        _type(type)
+        _type(type),
+        _isActive(true)
     {}
 
 public:
@@ -32,6 +35,21 @@ class MergeAction :
     {
         return _type;
     }
+
+    virtual void activate() override
+    {
+        _isActive = true;
+    }
+
+    virtual void deactivate() override
+    {
+        _isActive = false;
+    }
+
+    virtual bool isActive() const override
+    {
+        return _isActive;
+    }
 };
 
 // Various implementations of the above MergeAction base type following
@@ -58,6 +76,8 @@ class RemoveNodeFromParentAction :
 
     void applyChanges() override
     {
+        if (!isActive()) return;
+
         removeNodeFromParent(_nodeToRemove);
     }
 
@@ -124,6 +144,8 @@ class AddCloneToParentAction :
 public:
     void applyChanges() override
     {
+        if (!isActive()) return;
+
         addNodeToContainer(_cloneToBeInserted, _parent);
     }
 
@@ -184,6 +206,8 @@ class SetEntityKeyValueAction :
 
     void applyChanges() override
     {
+        if (!isActive()) return;
+
         // No post-clone callback since we don't care about selection groups right now
         auto entity = Node_getEntity(_node);
 

libs/scene/merge/MergeOperation.h

@@ -35,7 +35,7 @@ class MergeOperation
 
     void addAction(const MergeAction::Ptr& action);
 
-    // Executes all actions defined in this operation
+    // Executes all active actions defined in this operation
     void applyActions();
 
     void foreachAction(const std::function<void(const MergeAction::Ptr&)>& visitor);

radiant/ui/merge/MergeControlDialog.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include "iselection.h"
 #include <sigc++/connection.h>
 #include "wxutil/window/TransientWindow.h"
 #include "wxutil/XmlResourceBasedWidget.h"

radiantcore/map/Map.cpp

@@ -168,10 +168,26 @@ void Map::loadMapResourceFromLocation(const MapLocation& location)
 
 void Map::finishMergeOperation()
 {
+    if (getEditMode() != EditMode::Merge)
+    {
+        rWarning() << "Not in merge edit mode, cannot finish any operation" << std::endl;
+        return;
+    }
+
+    if (!_mergeOperation)
+    {
+        rError() << "Cannot merge, no active operation attached to this map." << std::endl;
+        return;
+    }
+
+    UndoableCommand cmd("mergeMap");
+    _mergeOperation->applyActions();
 
+    cleanupMergeOperation();
+    setEditMode(EditMode::Normal);
 }
 
-void Map::abortMergeOperation()
+void Map::cleanupMergeOperation()
 {
     for (const auto& mergeAction : _mergeActionNodes)
     {
@@ -180,7 +196,12 @@ void Map::abortMergeOperation()
 
     _mergeActionNodes.clear();
     _mergeOperation.reset();
-    setEditMode(EditMode::Normal);
+}
+
+void Map::abortMergeOperation()
+{
+    // Remove the nodes and switch back to normal without applying the operation
+    cleanupMergeOperation();
 }
 
 void Map::setMapName(const std::string& newName)

radiantcore/map/Map.h

@@ -266,6 +266,8 @@ class Map :
 	void emitMapEvent(MapEvent ev);
 
 	void clearMapResource();
+
+    void cleanupMergeOperation();
 };
 
 } // namespace map

radiantcore/map/MergeActionNode.h

@@ -44,6 +44,13 @@ class MergeActionNode final :
         });
     }
 
+    void onInsertIntoScene(scene::IMapRootNode& rootNode) override
+    {
+        SelectableNode::onInsertIntoScene(rootNode);
+
+        _action->activate();
+    }
+
     void onRemoveFromScene(scene::IMapRootNode& rootNode) override
     {
         auto addNodeAction = std::dynamic_pointer_cast<scene::merge::AddCloneToParentAction>(_action);
@@ -62,6 +69,8 @@ class MergeActionNode final :
             return true;
         });
 
+        _action->deactivate();
+
         SelectableNode::onRemoveFromScene(rootNode);
     }