Add Clear Frames and Remove Cells commands

Some logic from OT PR 4475 "make delete command behavior selectable by Contrail Co.,ltd." ported over

Co-authored-by: shun-iwasawa <shun.iwasawa@ponoc.jp>

toonz/sources/include/toonzqt/selectioncommandids.h

@@ -21,6 +21,7 @@
 #define MI_ClearFrames "MI_ClearFrames"
 #define MI_SelectAll "MI_SelectAll"
 #define MI_InvertSelection "MI_InvertSelection"
+#define MI_RemoveCells "MI_RemoveCells"
 
 #define MI_BlendColors "MI_BlendColors"
 #define MI_EraseUnusedStyles "MI_EraseUnusedStyles"

toonz/sources/toonz/cellselection.cpp

@@ -129,13 +129,17 @@ bool pasteCellsWithoutUndo(const TCellData *cellData, int &r0, int &c0, int &r1,
 
 //-----------------------------------------------------------------------------
 
-void deleteCellsWithoutUndo(int &r0, int &c0, int &r1, int &c1) {
+void deleteCellsWithoutUndo(int &r0, int &c0, int &r1, int &c1, bool doShift) {
   try {
     TXsheet *xsh = TApp::instance()->getCurrentXsheet()->getXsheet();
     int c;
     for (c = c0; c <= c1; c++) {
       if (xsh->isColumnEmpty(c)) continue;
-      xsh->clearCells(r0, c, r1 - r0 + 1);
+
+      if (doShift)
+        xsh->removeCells(r0, c, r1 - r0 + 1);
+      else
+        xsh->clearCells(r0, c, r1 - r0 + 1);
       // when the column becomes empty after deletion,
       // ColumnCmd::DeleteColumn() will take care of column related operations
       // like disconnecting from fx nodes etc.
@@ -295,8 +299,11 @@ class DeleteCellsUndo final : public TUndo {
   TCellSelection *m_selection;
   QMimeData *m_data;
 
+  bool m_doShift;  // whether clear cell or remove and shift cells up
+
 public:
-  DeleteCellsUndo(TCellSelection *selection, QMimeData *data) : m_data(data) {
+  DeleteCellsUndo(TCellSelection *selection, QMimeData *data, bool doShift)
+      : m_data(data), m_doShift(doShift) {
     int r0, c0, r1, c1;
     selection->getSelectedCells(r0, c0, r1, c1);
     if (c0 < 0) c0 = 0;  // Ignore camera column
@@ -313,20 +320,24 @@ public:
     m_selection->getSelectedCells(r0, c0, r1, c1);
 
     const TCellData *cellData = dynamic_cast<const TCellData *>(m_data);
-    pasteCellsWithoutUndo(cellData, r0, c0, r1, c1, false, false);
+    // insert cells if the delete operation had shifted cells up
+    pasteCellsWithoutUndo(cellData, r0, c0, r1, c1, m_doShift, false, !m_doShift);
     TApp::instance()->getCurrentXsheet()->notifyXsheetChanged();
   }
 
   void redo() const override {
     int r0, c0, r1, c1;
     m_selection->getSelectedCells(r0, c0, r1, c1);
-    deleteCellsWithoutUndo(r0, c0, r1, c1);
+    deleteCellsWithoutUndo(r0, c0, r1, c1, m_doShift);
     TApp::instance()->getCurrentXsheet()->notifyXsheetChanged();
   }
 
   int getSize() const override { return sizeof(*this); }
 
-  QString getHistoryString() override { return QObject::tr("Delete Cells"); }
+  QString getHistoryString() override {
+    return m_doShift ? QObject::tr("Remove Cells")
+                     : QObject::tr("Delete Cells");
+  }
   int getHistoryType() override { return HistoryType::Xsheet; }
 };
 
@@ -1554,9 +1565,12 @@ void TCellSelection::enableCommands() {
     enableCommand(this, MI_PasteInto, &TCellSelection::pasteKeyframesInto);
 
   enableCommand(this, MI_Cut, &TCellSelection::cutCells);
-  enableCommand(this, MI_Clear, &TCellSelection::deleteCells);
+  enableCommand(this, MI_Clear, &TCellSelection::clearCells);
   enableCommand(this, MI_Insert, &TCellSelection::insertCells);
 
+  enableCommand(this, MI_ClearFrames, &TCellSelection::clearFrames);
+  enableCommand(this, MI_RemoveCells, &TCellSelection::removeCells);
+
   enableCommand(this, MI_PasteInto, &TCellSelection::overWritePasteCells);
 
   enableCommand(this, MI_FillEmptyCell, &TCellSelection::fillEmptyCell);
@@ -1589,7 +1603,9 @@ void TCellSelection::setAlternativeCommandNames() {
       {MI_PasteInto, QObject::tr("Overwrite Paste Cells", "TCellSelection")},
       {MI_Cut, QObject::tr("Cut Cells", "TCellSelection")},
       {MI_Clear, QObject::tr("Delete Cells", "TCellSelection")},
-      {MI_Insert, QObject::tr("Insert Cells", "TCellSelection")}};
+      {MI_Insert, QObject::tr("Insert Cells", "TCellSelection")},
+      {MI_RemoveCells, QObject::tr("Remove Cells", "TCellSelection")},
+      {MI_ClearFrames, QObject::tr("Clear Frames", "TCellSelection")}};
 }
 
 //-----------------------------------------------------------------------------
@@ -2604,14 +2620,30 @@ void TCellSelection::pasteDuplicateCells() {
 
 //-----------------------------------------------------------------------------
 
-void TCellSelection::deleteCells() {
+void TCellSelection::clearCells() { deleteCells(false); }
+
+//-----------------------------------------------------------------------------
+
+void TCellSelection::removeCells() { deleteCells(true); }
+
+//-----------------------------------------------------------------------------
+
+void TCellSelection::deleteCells(bool withShift) {
   if (isEmpty()) return;
   int r0, c0, r1, c1;
   getSelectedCells(r0, c0, r1, c1);
   if (c0 < 0) c0 = 0;  // Ignore camera column
   TXsheet *xsh   = TApp::instance()->getCurrentXsheet()->getXsheet();
   // if all the selected cells are already empty, then do nothing
-  if (xsh->isRectEmpty(CellPosition(r0, c0), CellPosition(r1, c1))) return;
+  if (!withShift &&
+      xsh->isRectEmpty(CellPosition(r0, c0), CellPosition(r1, c1)))
+    return;
+
+  // if with "Clear Cell" behavior and all the selected cells are already empty,
+  // then do nothing
+  if (!withShift &&
+      xsh->isRectEmpty(CellPosition(r0, c0), CellPosition(r1, c1)))
+    return;
 
   std::set<int> removedColIds;
   // check if the operation may remove expression reference as column becomes
@@ -2632,9 +2664,9 @@ void TCellSelection::deleteCells() {
   }
 
   DeleteCellsUndo *undo =
-      new DeleteCellsUndo(new TCellSelection(m_range), data);
+      new DeleteCellsUndo(new TCellSelection(m_range), data, withShift);
 
-  deleteCellsWithoutUndo(r0, c0, r1, c1);
+  deleteCellsWithoutUndo(r0, c0, r1, c1, withShift);
 
   TUndoManager::manager()->add(undo);
 
@@ -2655,6 +2687,48 @@ void TCellSelection::deleteCells() {
 
 //-----------------------------------------------------------------------------
 
+void TCellSelection::clearFrames() { 
+  if (isEmpty()) return;
+
+  // set up basics
+  bool initUndo = false;
+  TXsheet *xsh  = TApp::instance()->getCurrentXsheet()->getXsheet();
+  int r, r0, c0, c, r1, c1;
+
+  getSelectedCells(r0, c0, r1, c1);
+
+  for (c = c0; c <= c1; c++) {
+    TXshColumn *column = xsh->getColumn(c);
+    if (!column || column->isEmpty() || column->isLocked() ||
+        !column->getLevelColumn())
+      continue;
+
+    for (r = r1; r >= r0; r--) {
+      TXshCell cell = xsh->getCell(r, c, false);
+
+      if (cell.isEmpty() || cell.getFrameId().isStopFrame() ||
+          cell.m_level->getChildLevel() || !cell.getImage(false))
+        continue;
+
+      TXshSimpleLevel *sl = cell.getSimpleLevel();
+      if (!sl) continue;
+
+      if (!initUndo) {
+        initUndo = true;
+        TUndoManager::manager()->beginBlock();
+      }
+
+      std::set<TFrameId> frames;
+      frames.insert(cell.getFrameId());
+      FilmstripCmd::clear(sl, frames);
+    }
+  }
+
+  if (initUndo) TUndoManager::manager()->endBlock();
+}
+
+//-----------------------------------------------------------------------------
+
 void TCellSelection::cutCells() { cutCells(false); }
 
 //-----------------------------------------------------------------------------

toonz/sources/toonz/cellselection.h

@@ -48,7 +48,10 @@ public:
   void pasteCells();
   void doPaste();  // choose pasting behavior by preference option
   void pasteDuplicateCells();
-  void deleteCells();
+  void deleteCells(bool withShift = false);
+  void clearCells();
+  void removeCells();
+  void clearFrames();
   void cutCells();
   void cutCells(bool withoutCopy);
 

toonz/sources/toonz/mainwindow.cpp

@@ -1939,6 +1939,7 @@ void MainWindow::defineActions() {
                        tr("Remove everything from the recent project list."));
   // createMenuEditAction(MI_PasteNew, QT_TR_NOOP("&Paste New"),  "");
   createMenuEditAction(MI_ClearFrames, QT_TR_NOOP("&Clear Frames"), "");
+  createMenuEditAction(MI_RemoveCells, QT_TR_NOOP("&Remove Cells"), "", "");
 
   // Menu - Cleanup
 

toonz/sources/toonz/menubar.cpp

@@ -383,6 +383,9 @@ void TopBar::loadMenubar() {
   addMenuItem(editMenu, MI_Insert);
   addMenuItem(editMenu, MI_InsertBelow);
   addMenuItem(editMenu, MI_Clear);
+  addMenuItem(editMenu, MI_RemoveCells);
+  editMenu->addSeparator();
+  addMenuItem(editMenu, MI_ClearFrames);
   editMenu->addSeparator();
   addMenuItem(editMenu, MI_SelectAll);
   addMenuItem(editMenu, MI_InvertSelection);
@@ -460,7 +463,6 @@ void TopBar::loadMenubar() {
   addMenuItem(levelMenu, MI_ExportLevel);
   levelMenu->addSeparator();
   addMenuItem(levelMenu, MI_AddFrames);
-  addMenuItem(levelMenu, MI_ClearFrames);
   addMenuItem(levelMenu, MI_Renumber);
   addMenuItem(levelMenu, MI_ReplaceLevel);
   addMenuItem(levelMenu, MI_RevertToCleanedUp);

toonz/sources/toonz/xshcellviewer.cpp

@@ -4167,6 +4167,8 @@ void CellArea::createCellMenu(QMenu &menu, bool isCellSelected, TXshCell cell,
 
     if (!isImplicitCell) menu.addAction(cmdManager->getAction(MI_Clear));
     menu.addAction(cmdManager->getAction(MI_Insert));
+    menu.addAction(cmdManager->getAction(MI_RemoveCells));
+    if (!isImplicitCell) menu.addAction(cmdManager->getAction(MI_ClearFrames));
     if (!soundTextCellsSelected) {
       menu.addAction(cmdManager->getAction(MI_CreateBlankDrawing));
       menu.addAction(cmdManager->getAction(MI_Duplicate));