[TD]Refactor Dimensions for 3d upgrade

- separate validation, geometry and reference handling into individual files - improve 3d reference geometry handling - eliminate duplicate dim creation code - add Dimension reference repair dialog - Refactor formatting out of DrawViewDimension - move dimension repaint control to ViewProvider
2022-10-28 08:46:37 -04:00
parent aeeb62d204
commit 1b547dff72
39 changed files with 5181 additions and 2544 deletions
--- a/src/Mod/TechDraw/Gui/TaskDimRepair.cpp
+++ b/src/Mod/TechDraw/Gui/TaskDimRepair.cpp
@@ -0,0 +1,346 @@
+/***************************************************************************
+ *   Copyright (c) 2022 WandererFan <wandererfan@gmail.com >               *
+ *                                                                         *
+ *   This file is part of the FreeCAD CAx development system.              *
+ *                                                                         *
+ *   This library is free software; you can redistribute it and/or         *
+ *   modify it under the terms of the GNU Library General Public           *
+ *   License as published by the Free Software Foundation; either          *
+ *   version 2 of the License, or (at your option) any later version.      *
+ *                                                                         *
+ *   This library  is distributed in the hope that it will be useful,      *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU Library General Public License for more details.                  *
+ *                                                                         *
+ *   You should have received a copy of the GNU Library General Public     *
+ *   License along with this library; see the file COPYING.LIB. If not,    *
+ *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
+ *   Suite 330, Boston, MA  02111-1307, USA                                *
+ *                                                                         *
+ ***************************************************************************/
+
+#include "PreCompiled.h"
+
+#include <QMessageBox>
+#include <QTableWidgetItem>
+
+#ifndef _PreComp_
+#include <cmath>
+#endif // #ifndef _PreComp_
+
+#include <Base/Console.h>
+#include <Base/Tools.h>
+#include <Base/Vector3D.h>
+
+#include <Gui/Application.h>
+#include <Gui/BitmapFactory.h>
+#include <Gui/Command.h>
+#include <Gui/Document.h>
+#include <Gui/MainWindow.h>
+#include <Gui/Selection.h>
+#include <Gui/ViewProvider.h>
+
+#include <App/Application.h>
+#include <App/Document.h>
+#include <App/DocumentObject.h>
+
+#include <Mod/TechDraw/App/DrawView.h>
+#include <Mod/TechDraw/App/DrawViewPart.h>
+#include <Mod/TechDraw/App/DrawUtil.h>
+
+#include "PreferencesGui.h"
+#include "DimensionValidators.h"
+#include "TaskDimRepair.h"
+#include <Mod/TechDraw/Gui/ui_TaskDimRepair.h>
+
+using namespace Gui;
+using namespace TechDraw;
+using namespace TechDrawGui;
+
+TaskDimRepair::TaskDimRepair(TechDraw::DrawViewDimension* inDvd,
+                             ReferenceVector references2d,
+                             ReferenceVector references3d) :
+    ui(new Ui_TaskDimRepair),
+    m_dim(inDvd),
+    m_references2d(references2d),
+    m_references3d(references3d)
+{
+    ui->setupUi(this);
+
+    connect(ui->pbSelection, SIGNAL(clicked(bool)), this, SLOT(slotUseSelection()));
+
+    saveDimState();
+    setUiPrimary();
+}
+
+TaskDimRepair::~TaskDimRepair()
+{
+}
+
+void TaskDimRepair::setUiPrimary()
+{
+    setWindowTitle(QObject::tr("Dimension Repair"));
+    ui->leName->setReadOnly(true);
+    ui->leLabel->setReadOnly(true);
+
+    ui->leName->setText(Base::Tools::fromStdString(m_dim->getNameInDocument()));
+    ui->leLabel->setText(Base::Tools::fromStdString(m_dim->Label.getValue()));
+
+    std::string objName = m_dim->getViewPart()->getNameInDocument();
+    std::string objLabel = m_dim->getViewPart()->Label.getValue();
+    ui->leObject2d->setText(Base::Tools::fromStdString(objName + " / " + objLabel));
+    const std::vector<std::string>& subElements2d = m_dim->References2D.getSubValues();
+    std::vector<std::string> noLabels(subElements2d.size());
+    fillList(ui->lwGeometry2d, subElements2d, noLabels);
+
+    const std::vector<App::DocumentObject*>& objs3d = m_dim->References3D.getValues();
+    QStringList headers;
+    headers << tr("Object Name")
+            << tr("Object Label")
+            << tr("SubElement");
+    ui->twReferences3d->setHorizontalHeaderLabels(headers);
+
+    ReferenceVector references3d;
+    if (!m_references3d.empty()) {
+        references3d = m_references3d;
+    } else if (!objs3d.empty()) {
+        references3d = m_dim->getEffectiveReferences();
+    }
+    loadTableWidget(ui->twReferences3d, references3d);
+}
+
+void TaskDimRepair::saveDimState()
+{
+    m_saveMeasureType = m_dim->MeasureType.getValue();
+    m_saveDimType = m_dim->Type.getValue();
+    m_dimType = m_dim->Type.getValue();
+    m_saveObjs3d = m_dim->References3D.getValues();
+    m_saveSubs3d = m_dim->References3D.getSubValues();
+    m_saveDvp = static_cast<DrawViewPart*>(m_dim->References2D.getValues().front());
+    m_saveSubs2d = m_dim->References2D.getSubValues();
+}
+
+//restore the start conditions
+void TaskDimRepair::restoreDimState()
+{
+//    Base::Console().Message("TDR::restoreDimState()\n");
+    if (m_dim != nullptr) {
+        std::vector<App::DocumentObject*> objs2d(m_saveSubs2d.size());
+        std::iota(objs2d.begin(), objs2d.end(), m_saveDvp);
+        m_dim->References2D.setValues(objs2d, m_saveSubs2d);
+        m_dim->References3D.setValues(m_saveObjs3d, m_saveSubs3d);
+    }
+}
+
+//similar to code in CommandCreateDims.cpp
+//use the current selection to replace the references in dim
+void TaskDimRepair::slotUseSelection()
+{
+    const std::vector<App::DocumentObject*> dimObjects = Gui::Selection().getObjectsOfType(TechDraw::DrawViewDimension::getClassTypeId());
+    if (dimObjects.empty()) {
+        //selection does not include a dimension, so we need to add our dimension to keep the
+        //validators happy
+        //bool accepted =
+        static_cast<void> (Gui::Selection().addSelection(m_dim->getDocument()->getName(),
+                                                         m_dim->getNameInDocument()));
+    }
+    ReferenceVector references2d;
+    ReferenceVector references3d;
+    TechDraw::DrawViewPart* dvp = TechDraw::getReferencesFromSelection(references2d, references3d);
+    if (dvp != m_saveDvp) {
+        QMessageBox::warning(Gui::getMainWindow(),
+                             QObject::tr("Incorrect Selection"),
+                             QObject::tr("Can not use references from a different View"));
+        return;
+    }
+
+    StringVector acceptableGeometry( { "Edge", "Vertex" } );
+    std::vector<int> minimumCounts( { 1, 1 } );
+    std::vector<DimensionGeometryType> acceptableDimensionGeometrys;    //accept anything
+    DimensionGeometryType geometryRefs2d = validateDimSelection(references2d,
+                                                                acceptableGeometry,
+                                                                minimumCounts,
+                                                                acceptableDimensionGeometrys);
+    if (geometryRefs2d == isInvalid) {
+        QMessageBox::warning(Gui::getMainWindow(),
+                             QObject::tr("Incorrect Selection"),
+                             QObject::tr("Can not make a dimension from selection"));
+        return;
+    }
+    //what 3d geometry configuration did we receive?
+    DimensionGeometryType geometryRefs3d(isInvalid);
+    if (geometryRefs2d == TechDraw::isViewReference  &&
+        !references3d.empty()) {
+        geometryRefs3d = validateDimSelection3d(dvp,
+                                                references3d,
+                                                acceptableGeometry,
+                                                minimumCounts,
+                                                acceptableDimensionGeometrys);
+        if ( geometryRefs3d == isInvalid) {
+            QMessageBox::warning(Gui::getMainWindow(),
+                                 QObject::tr("Incorrect Selection"),
+                                 QObject::tr("Can not make dimension from selection"));
+            return;
+        }
+    }
+
+    m_dimType = mapGeometryTypeToDimType(m_dim->Type.getValue(),
+                                         geometryRefs2d,
+                                         geometryRefs3d);
+    m_references2d = references2d;
+    if (references3d.empty()) {
+        m_references3d.clear();
+    } else {
+        m_references3d = references3d;
+    }
+    updateUi();
+}
+
+void TaskDimRepair::updateUi()
+{
+//    Base::Console().Message("TDR::updateUi()\n");
+    std::string objName = m_dim->getViewPart()->getNameInDocument();
+    std::string objLabel = m_dim->getViewPart()->Label.getValue();
+    ui->leObject2d->setText(Base::Tools::fromStdString(objName + " / " + objLabel));
+
+    std::vector<std::string> subElements2d;
+    for (auto& ref : m_references2d) {
+        subElements2d.push_back(ref.getSubName());
+    }
+    std::vector<std::string> noLabels(subElements2d.size());
+    fillList(ui->lwGeometry2d, subElements2d, noLabels);
+    loadTableWidget(ui->twReferences3d, m_references3d);
+}
+
+void TaskDimRepair::loadTableWidget(QTableWidget* tw, ReferenceVector refs)
+{
+//    Base::Console().Message("TDR::loadTableWidget() - refs: %d\n", refs.size());
+    tw->clearContents();
+    tw->setRowCount(refs.size() + 1);
+    size_t iRow = 0;
+    for (auto& ref : refs) {
+        QString qName = Base::Tools::fromStdString(ref.getObject()->getNameInDocument());
+        QTableWidgetItem* itemName = new QTableWidgetItem(qName);
+        itemName->setTextAlignment(Qt::AlignRight | Qt::AlignVCenter);
+        tw->setItem(iRow,0, itemName);
+        QString qLabel = Base::Tools::fromStdString(std::string(ref.getObject()->Label.getValue()));
+        QTableWidgetItem* itemLabel = new QTableWidgetItem(qLabel);
+        itemLabel->setTextAlignment(Qt::AlignRight | Qt::AlignVCenter);
+        tw->setItem(iRow,1, itemLabel);
+        QString qSubName = Base::Tools::fromStdString(ref.getSubName());
+        QTableWidgetItem* itemSubName = new QTableWidgetItem(qSubName);
+        itemSubName->setTextAlignment(Qt::AlignRight | Qt::AlignVCenter);
+        tw->setItem(iRow,2, itemSubName);
+        iRow++;
+    }
+}
+
+void TaskDimRepair::fillList(QListWidget* lwItems, std::vector<std::string> labels, std::vector<std::string> names)
+{
+    QListWidgetItem* item;
+    QString qLabel;
+    QString qName;
+    QString qText;
+    int labelCount = labels.size();
+    int i = 0;
+    lwItems->clear();
+    for (; i < labelCount; i++) {
+        qLabel = Base::Tools::fromStdString(labels[i]);
+        qName = Base::Tools::fromStdString(names[i]);
+        qText = QString::fromUtf8("%1 %2").arg(qName, qLabel);
+        item = new QListWidgetItem(qText, lwItems);
+        item->setTextAlignment(Qt::AlignRight | Qt::AlignVCenter);
+        item->setData(Qt::UserRole, qName);
+    }
+}
+void TaskDimRepair::replaceReferences()
+{
+    if (m_dim) {
+        m_dim->setReferences2d(m_references2d);
+        m_dim->setReferences3d(m_references3d);
+    }
+}
+
+void TaskDimRepair::updateTypes()
+{
+    if (m_references3d.empty()) {
+        m_dim->MeasureType.setValue("Projected");
+    } else {
+        m_dim->MeasureType.setValue("True");
+    }
+    m_dim->Type.setValue(m_dimType);
+}
+
+
+bool TaskDimRepair::accept()
+{
+//    Base::Console().Message("TDR::accept()\n");
+    Gui::Command::doCommand(Gui::Command::Gui, "Gui.ActiveDocument.resetEdit()");
+    replaceReferences();
+    updateTypes();
+    m_dim->recomputeFeature();
+    return true;
+}
+
+bool TaskDimRepair::reject()
+{
+//    Base::Console().Message("TDR::reject()\n");
+    restoreDimState();
+    Gui::Command::doCommand(Gui::Command::Gui, "Gui.ActiveDocument.resetEdit()");
+    return false;
+}
+
+void TaskDimRepair::changeEvent(QEvent *e)
+{
+    if (e->type() == QEvent::LanguageChange) {
+        ui->retranslateUi(this);
+    }
+}
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+TaskDlgDimReference::TaskDlgDimReference(TechDraw::DrawViewDimension* inDvd,
+                             ReferenceVector references2d,
+                             ReferenceVector references3d) :
+    TaskDialog()
+{
+    widget  = new TaskDimRepair(inDvd, references2d, references3d);
+    taskbox = new Gui::TaskView::TaskBox(Gui::BitmapFactory().pixmap("TechDraw_DimensionRepair"),
+                                         widget->windowTitle(), true, 0);
+    taskbox->groupLayout()->addWidget(widget);
+    Content.push_back(taskbox);
+}
+
+
+TaskDlgDimReference::~TaskDlgDimReference()
+{
+}
+
+void TaskDlgDimReference::update()
+{
+    //widget->updateTask();
+}
+
+//==== calls from the TaskView ===============================================================
+void TaskDlgDimReference::open()
+{
+}
+
+void TaskDlgDimReference::clicked(int i)
+{
+    Q_UNUSED(i);
+}
+
+bool TaskDlgDimReference::accept()
+{
+    widget->accept();
+    return true;
+}
+
+bool TaskDlgDimReference::reject()
+{
+    widget->reject();
+    return true;
+}
+
+#include <Mod/TechDraw/Gui/moc_TaskDimRepair.cpp>