FrameCmds: Make replace frame option to be undoable/redoable

This commit makes "replace frame" option to be undoable, it allows to replace frame and then undo or redo the same action.
diasurgical · Nov 19, 2023 · 1cbc1dc · 1cbc1dc
1 parent 8dae7f2
commit 1cbc1dc
Show file tree

Hide file tree

Showing 7 changed files with 78 additions and 17 deletions.
diff --git a/source/celview.cpp b/source/celview.cpp
@@ -229,29 +229,39 @@ void CelView::sendAddFrameCmd(IMAGE_FILE_MODE mode, int index, const QString &im
     undoStack->push(command);
 }
 
-void CelView::sendRemoveFrameCmd()
+void CelView::replaceCurrentFrame(int frameIdx, const QImage &image)
 {
-    // send a command to undostack, making deleting frame undo/redoable
-    RemoveFrameCommand *command = new RemoveFrameCommand(this->currentFrameIndex, this->gfx->getFrameImage(this->currentFrameIndex));
-    QObject::connect(command, &RemoveFrameCommand::removed, this, &CelView::removeCurrentFrame);
-    QObject::connect(command, &RemoveFrameCommand::inserted, this, &CelView::insertImageFile);
+    this->gfx->replaceFrame(frameIdx, image);
 
-    this->undoStack->push(command);
+    // update the view
+    this->initialize(this->gfx);
+    this->displayFrame();
 }
 
-void CelView::replaceCurrentFrame(const QString &imagefilePath)
+void CelView::sendReplaceCurrentFrameCmd(const QString &imagefilePath)
 {
     QImage image = QImage(imagefilePath);
 
     if (image.isNull()) {
         return;
     }
 
-    this->gfx->replaceFrame(this->currentFrameIndex, image);
+    // send a command to undostack, making replacing frame undo/redoable
+    ReplaceFrameCommand *command = new ReplaceFrameCommand(this->currentFrameIndex, image, this->gfx->getFrameImage(this->currentFrameIndex));
+    QObject::connect(command, &ReplaceFrameCommand::replaced, this, &CelView::replaceCurrentFrame);
+    QObject::connect(command, &ReplaceFrameCommand::undoReplaced, this, &CelView::replaceCurrentFrame);
 
-    // update the view
-    this->initialize(this->gfx);
-    this->displayFrame();
+    undoStack->push(command);
+}
+
+void CelView::sendRemoveFrameCmd()
+{
+    // send a command to undostack, making deleting frame undo/redoable
+    RemoveFrameCommand *command = new RemoveFrameCommand(this->currentFrameIndex, this->gfx->getFrameImage(this->currentFrameIndex));
+    QObject::connect(command, &RemoveFrameCommand::removed, this, &CelView::removeCurrentFrame);
+    QObject::connect(command, &RemoveFrameCommand::inserted, this, &CelView::insertImageFile);
+
+    this->undoStack->push(command);
 }
 
 void CelView::removeCurrentFrame(int frameIdx)

diff --git a/source/celview.h b/source/celview.h
@@ -60,7 +60,8 @@ class CelView : public QWidget {
     int getCurrentFrameIndex();
     void framePixelClicked(unsigned x, unsigned y);
     void insertImageFiles(IMAGE_FILE_MODE mode, const QStringList &imagefilePaths, bool append);
-    void replaceCurrentFrame(const QString &imagefilePath);
+    void sendReplaceCurrentFrameCmd(const QString &imagefilePath);
+    void replaceCurrentFrame(int frameIdx, const QImage &image);
     void removeCurrentFrame(int frameIdx);
     void regroupFrames(int numGroups);
     void updateGroupIndex();

diff --git a/source/framecmds.cpp b/source/framecmds.cpp
@@ -22,6 +22,24 @@ void RemoveFrameCommand::redo()
     emit this->removed(frameIndexToRevert);
 }
 
+ReplaceFrameCommand::ReplaceFrameCommand(int currentFrameIndex, const QImage imgToReplace, const QImage imgToRestore, QUndoCommand *parent)
+    : frameIndexToReplace(currentFrameIndex)
+    , imgToReplace(imgToReplace)
+    , imgToRestore(imgToRestore)
+{
+}
+
+void ReplaceFrameCommand::undo()
+{
+    emit this->undoReplaced(frameIndexToReplace, imgToRestore);
+}
+
+void ReplaceFrameCommand::redo()
+{
+    // emit this signal which will call LevelCelView/CelView::replaceCurrentFrame
+    emit this->replaced(frameIndexToReplace, imgToReplace);
+}
+
 AddFrameCommand::AddFrameCommand(IMAGE_FILE_MODE mode, int index, const QString imagefilePath, QUndoCommand *parent)
     : startingIndex(index)
     , mode(mode)

diff --git a/source/framecmds.h b/source/framecmds.h
@@ -23,6 +23,26 @@ class RemoveFrameCommand : public QObject, public QUndoCommand {
     int frameIndexToRevert = 0;
 };
 
+class ReplaceFrameCommand : public QObject, public QUndoCommand {
+    Q_OBJECT
+
+public:
+    explicit ReplaceFrameCommand(int currentFrameIndex, const QImage imgToReplace, const QImage imgToRestore, QUndoCommand *parent = nullptr);
+    ~ReplaceFrameCommand() = default;
+
+    void undo() override;
+    void redo() override;
+
+signals:
+    void undoReplaced(int idxToRemove, const QImage imgToRestore);
+    void replaced(int idxToReplace, const QImage imgToReplace);
+
+private:
+    QImage imgToReplace;
+    QImage imgToRestore;
+    int frameIndexToReplace = 0;
+};
+
 class AddFrameCommand : public QObject, public QUndoCommand {
     Q_OBJECT
 

diff --git a/source/levelcelview.cpp b/source/levelcelview.cpp
@@ -714,7 +714,7 @@ void LevelCelView::insertTiles(IMAGE_FILE_MODE mode, const QStringList &imagefil
     this->displayFrame();
 }
 
-void LevelCelView::replaceCurrentFrame(const QString &imagefilePath)
+void LevelCelView::sendReplaceCurrentFrameCmd(const QString &imagefilePath)
 {
     QImage image = QImage(imagefilePath);
 
@@ -728,7 +728,17 @@ void LevelCelView::replaceCurrentFrame(const QString &imagefilePath)
         return;
     }
 
-    D1GfxFrame *frame = this->gfx->replaceFrame(this->currentFrameIndex, image);
+    // send a command to undostack, making replacing frame undo/redoable
+    ReplaceFrameCommand *command = new ReplaceFrameCommand(this->currentFrameIndex, image, this->gfx->getFrameImage(this->currentFrameIndex));
+    QObject::connect(command, &ReplaceFrameCommand::replaced, this, &LevelCelView::replaceCurrentFrame);
+    QObject::connect(command, &ReplaceFrameCommand::undoReplaced, this, &LevelCelView::replaceCurrentFrame);
+
+    undoStack->push(command);
+}
+
+void LevelCelView::replaceCurrentFrame(int frameIdx, const QImage &image)
+{
+    D1GfxFrame *frame = this->gfx->replaceFrame(frameIdx, image);
 
     if (frame != nullptr) {
         LevelTabFrameWidget::selectFrameType(frame);

diff --git a/source/levelcelview.h b/source/levelcelview.h
@@ -51,14 +51,16 @@ class LevelCelView : public QWidget {
     int getCurrentFrameIndex();
     int getCurrentSubtileIndex();
     int getCurrentTileIndex();
-    void replaceCurrentFrame(const QString &imagefilePath);
 
     void framePixelClicked(unsigned x, unsigned y);
 
     void insertImageFiles(IMAGE_FILE_MODE mode, const QStringList &imagefilePaths, bool append);
 
     void sendAddFrameCmd(IMAGE_FILE_MODE mode, int index, const QString &imagefilePath);
 
+    void sendReplaceCurrentFrameCmd(const QString &imagefilePath);
+    void replaceCurrentFrame(int frameIdx, const QImage &image);
+
     void sendRemoveFrameCmd();
     void removeCurrentFrame(int idx);
 

diff --git a/source/mainwindow.cpp b/source/mainwindow.cpp
@@ -1084,10 +1084,10 @@ void MainWindow::on_actionReplace_Frame_triggered()
     this->ui->statusBar->repaint();
 
     if (this->celView != nullptr) {
-        this->celView->replaceCurrentFrame(imgFilePath);
+        this->celView->sendReplaceCurrentFrameCmd(imgFilePath);
     }
     if (this->levelCelView != nullptr) {
-        this->levelCelView->replaceCurrentFrame(imgFilePath);
+        this->levelCelView->sendReplaceCurrentFrameCmd(imgFilePath);
     }
     this->updateWindow();