Allow one clipping plane dock widget per document

Author: theo-vt

src/Gui/Clipping.cpp

@@ -21,6 +21,7 @@
  ***************************************************************************/
 
 #include <limits>
+#include <functional>
 
 #include <Inventor/actions/SoGetBoundingBoxAction.h>
 #include <Inventor/nodes/SoClipPlane.h>
@@ -29,6 +30,8 @@
 #include <QDockWidget>
 #include <QPointer>
 
+#include <App/Application.h>
+
 #include "Clipping.h"
 #include "ui_Clipping.h"
 #include "DockWindowManager.h"
@@ -51,6 +54,10 @@ class Clipping::Private
     bool flipY {false};
     bool flipZ {false};
     SoTimerSensor* sensor;
+    App::Document* shownOn {nullptr};
+    QDockWidget* dockWidget {nullptr};
+    fastsignals::scoped_connection activeDocConnection;
+
     Private()
     {
         clipX = new SoClipPlane();
@@ -99,7 +106,7 @@ class Clipping::Private
 
 /* TRANSLATOR Gui::Dialog::Clipping */
 
-Clipping::Clipping(Gui::View3DInventor* view, QWidget* parent)
+Clipping::Clipping(Gui::View3DInventor* view, App::Document* showOn, QWidget* parent)
     : QDialog(parent)
     , d(new Private)
 {
@@ -124,6 +131,7 @@ Clipping::Clipping(Gui::View3DInventor* view, QWidget* parent)
     d->ui.dirZ->setRange(-max, max);
     d->ui.dirZ->setSingleStep(0.1f);
     d->ui.dirZ->setValue(1.0f);
+    d->shownOn = showOn;
 
     d->view = view;
     View3DInventorViewer* viewer = view->getViewer();
@@ -190,21 +198,23 @@ Clipping::Clipping(Gui::View3DInventor* view, QWidget* parent)
     }
 }
 
-Clipping* Clipping::makeDockWidget(Gui::View3DInventor* view)
+Clipping* Clipping::makeDockWidget(Gui::View3DInventor* view, App::Document* showOn)
 {
     // embed this dialog into a QDockWidget
-    auto clipping = new Clipping(view);
+    auto clipping = new Clipping(view, showOn);
     Gui::DockWindowManager* pDockMgr = Gui::DockWindowManager::instance();
     QDockWidget* dw = pDockMgr->addDockWindow("Clipping", clipping, Qt::LeftDockWidgetArea);
     dw->setFeatures(QDockWidget::DockWidgetMovable | QDockWidget::DockWidgetFloatable);
     dw->show();
+    clipping->d->dockWidget = dw;
 
     return clipping;
 }
 
 /** Destroys the object and frees any allocated resources */
 Clipping::~Clipping()
 {
+    d->activeDocConnection.disconnect();
     d->node->removeChild(d->clipX);
     d->node->removeChild(d->clipY);
     d->node->removeChild(d->clipZ);
@@ -216,6 +226,8 @@ Clipping::~Clipping()
 void Clipping::setupConnections()
 {
     // clang-format off
+    d->activeDocConnection = App::GetApplication().signalActiveDocument.connect(
+            std::bind(&Clipping::onActiveDocument, this, std::placeholders::_1));
     connect(d->ui.groupBoxX, &QGroupBox::toggled,
             this, &Clipping::onGroupBoxXToggled);
     connect(d->ui.groupBoxY, &QGroupBox::toggled,
@@ -259,7 +271,18 @@ void Clipping::reject()
         dw->deleteLater();
     }
 }
-
+void Clipping::onActiveDocument(const App::Document& doc)
+{
+    if (!d || !d->dockWidget) {
+        return;
+    }
+    if (&doc == d->shownOn) {
+        d->dockWidget->show();
+    }
+    else {
+        d->dockWidget->hide();
+    }
+}
 void Clipping::onGroupBoxXToggled(bool on)
 {
     if (on) {

src/Gui/Clipping.h

@@ -26,6 +26,11 @@
 #include <QDialog>
 #include <FCGlobal.h>
 
+namespace App
+{
+class Document;
+}
+
 namespace Gui
 {
 class View3DInventor;
@@ -40,12 +45,13 @@ class GuiExport Clipping: public QDialog
     Q_OBJECT
 
 public:
-    static Clipping* makeDockWidget(Gui::View3DInventor*);
-    Clipping(Gui::View3DInventor* view, QWidget* parent = nullptr);
+    static Clipping* makeDockWidget(Gui::View3DInventor*, App::Document* showOn);
+    Clipping(Gui::View3DInventor* view, App::Document* showOn, QWidget* parent = nullptr);
     ~Clipping() override;
 
 protected:
     void setupConnections();
+    void onActiveDocument(const App::Document& doc);
     void onGroupBoxXToggled(bool);
     void onGroupBoxYToggled(bool);
     void onGroupBoxZToggled(bool);

src/Gui/CommandView.cpp

@@ -21,6 +21,9 @@
  ***************************************************************************/
 
 #include <sstream>
+#include <vector>
+#include <tuple>
+
 #include <Inventor/events/SoMouseButtonEvent.h>
 #include <Inventor/nodes/SoOrthographicCamera.h>
 #include <Inventor/nodes/SoPerspectiveCamera.h>
@@ -640,7 +643,34 @@ void StdCmdFreezeViews::languageChange()
 // Std_ToggleClipPlane
 //===========================================================================
 
-DEF_STD_CMD_AC(StdCmdToggleClipPlane)
+class StdCmdToggleClipPlane: public Gui::Command
+{
+public:
+    StdCmdToggleClipPlane();
+    virtual ~StdCmdToggleClipPlane()
+    {}
+    virtual const char* className() const
+    {
+        return "StdCmdToggleClipPlane";
+    }
+
+protected:
+    virtual void activated(int iMsg);
+    virtual bool isActive(void);
+    virtual Gui::Action* createAction(void);
+
+private:
+    StdCmdToggleClipPlane(const StdCmdToggleClipPlane&) = delete;
+    StdCmdToggleClipPlane(StdCmdToggleClipPlane&&) = delete;
+    StdCmdToggleClipPlane& operator=(const StdCmdToggleClipPlane&) = delete;
+    StdCmdToggleClipPlane& operator=(StdCmdToggleClipPlane&&) = delete;
+
+    void garbageCollect();
+    bool hasClipping(App::Document* doc) const;
+
+private:
+    std::vector<std::pair<App::Document*, QPointer<Gui::Dialog::Clipping>>> clippings;
+};
 
 StdCmdToggleClipPlane::StdCmdToggleClipPlane()
     : Command("Std_ToggleClipPlane")
@@ -663,11 +693,15 @@ Action* StdCmdToggleClipPlane::createAction()
 void StdCmdToggleClipPlane::activated(int iMsg)
 {
     Q_UNUSED(iMsg);
-    static QPointer<Gui::Dialog::Clipping> clipping = nullptr;
-    if (!clipping) {
+    App::Document* doc = getActiveDocument();
+    if (!doc) {
+        return;
+    }
+    garbageCollect();  // remove dead pointers
+    if (!hasClipping(doc)) {
         auto view = qobject_cast<View3DInventor*>(getMainWindow()->activeWindow());
         if (view) {
-            clipping = Gui::Dialog::Clipping::makeDockWidget(view);
+            clippings.push_back(std::make_pair(doc, Gui::Dialog::Clipping::makeDockWidget(view, doc)));
         }
     }
 }
@@ -678,6 +712,31 @@ bool StdCmdToggleClipPlane::isActive()
     return view ? true : false;
 }
 
+void StdCmdToggleClipPlane::garbageCollect()
+{
+    // We assume the vector to be small
+    std::vector<std::pair<App::Document*, QPointer<Gui::Dialog::Clipping>>> newClippings;
+    newClippings.reserve(clippings.size());
+    std::copy_if(
+        clippings.begin(),
+        clippings.end(),
+        std::back_inserter(newClippings),
+        [](const std::pair<App::Document*, QPointer<Gui::Dialog::Clipping>>& clipPair) -> bool {
+            return clipPair.second != nullptr;
+        }
+    );
+    clippings = newClippings;
+}
+bool StdCmdToggleClipPlane::hasClipping(App::Document* doc) const
+{
+    return std::ranges::find(
+               clippings,
+               doc,
+               &std::pair<App::Document*, QPointer<Gui::Dialog::Clipping>>::first
+           )
+        != clippings.end();
+}
+
 //===========================================================================
 // StdCmdDrawStyle
 //===========================================================================

src/Mod/PartDesign/Gui/ViewProvider.cpp

@@ -172,10 +172,7 @@ bool ViewProvider::setEdit(int ModNum)
             }
         }
 
-        auto editDoc = Gui::Application::Instance->editDocument([this](Gui::Document* editdoc) {
-            return editdoc->getEditViewProvider() == this;
-        });
-        Gui::Control().showDialog(featureDlg, editDoc->getDocument());
+        Gui::Control().showDialog(featureDlg);
         return true;
     }
     else {