Files
create/src/Mod/PartDesign/Gui/TaskBooleanParameters.cpp
André Caldas 89dbab9b0e Avoids using getNameInDocument() to test if DocumentObject is attached to a Document.
This patch substitutes by isAttachedToDocument() (almost) everywhere where
getNameInDocument() is used for this purpose.

The very few places not touched by this patch demand a (just a little) less trivial change.
When we change the returning type of getNameInDocument() to std::string,
those places will be easily found, because they shall generate a compiler error
(converting std::string to bool).

Rationale:
The fact that getNameInDocument() return nullptr to indicate
that the object is not attached to a document is responsible for lots of bugs
where the developer does not check for "nullptr".

The idea is to eliminate all those uses of getNameInDocument() and, in the near future,
make getNameInDocument() return always a valid std::string.
2023-12-11 17:37:58 +01:00

398 lines
15 KiB
C++

/***************************************************************************
* Copyright (c) 2013 Jan Rheinländer *
* <jrheinlaender@users.sourceforge.net> *
* *
* 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"
#ifndef _PreComp_
# include <QAction>
# include <QMessageBox>
#endif
#include <App/Document.h>
#include <App/DocumentObject.h>
#include <Gui/Application.h>
#include <Gui/BitmapFactory.h>
#include <Gui/Command.h>
#include <Gui/Selection.h>
#include <Gui/ViewProvider.h>
#include <Mod/PartDesign/App/Body.h>
#include <Mod/PartDesign/App/FeatureBoolean.h>
#include "ui_TaskBooleanParameters.h"
#include "TaskBooleanParameters.h"
using namespace PartDesignGui;
using namespace Gui;
/* TRANSLATOR PartDesignGui::TaskBooleanParameters */
TaskBooleanParameters::TaskBooleanParameters(ViewProviderBoolean *BooleanView,QWidget *parent)
: TaskBox(Gui::BitmapFactory().pixmap("PartDesign_Boolean"), tr("Boolean parameters"), true, parent)
, ui(new Ui_TaskBooleanParameters)
, BooleanView(BooleanView)
{
selectionMode = none;
// we need a separate container widget to add all controls to
proxy = new QWidget(this);
ui->setupUi(proxy);
QMetaObject::connectSlotsByName(this);
connect(ui->buttonBodyAdd, &QToolButton::toggled,
this, &TaskBooleanParameters::onButtonBodyAdd);
connect(ui->buttonBodyRemove, &QToolButton::toggled,
this, &TaskBooleanParameters::onButtonBodyRemove);
connect(ui->comboType, qOverload<int>(&QComboBox::currentIndexChanged),
this, &TaskBooleanParameters::onTypeChanged);
this->groupLayout()->addWidget(proxy);
PartDesign::Boolean* pcBoolean = static_cast<PartDesign::Boolean*>(BooleanView->getObject());
std::vector<App::DocumentObject*> bodies = pcBoolean->Group.getValues();
for (auto body : bodies) {
QListWidgetItem* item = new QListWidgetItem(ui->listWidgetBodies);
item->setText(QString::fromUtf8(body->Label.getValue()));
item->setData(Qt::UserRole, QString::fromLatin1(body->getNameInDocument()));
}
// Create context menu
QAction* action = new QAction(tr("Remove"), this);
action->setShortcut(QKeySequence::Delete);
#if QT_VERSION >= QT_VERSION_CHECK(5, 10, 0)
// display shortcut behind the context menu entry
action->setShortcutVisibleInContextMenu(true);
#endif
ui->listWidgetBodies->addAction(action);
connect(action, &QAction::triggered, this, &TaskBooleanParameters::onBodyDeleted);
ui->listWidgetBodies->setContextMenuPolicy(Qt::ActionsContextMenu);
int index = pcBoolean->Type.getValue();
ui->comboType->setCurrentIndex(index);
}
void TaskBooleanParameters::onSelectionChanged(const Gui::SelectionChanges& msg)
{
if (selectionMode == none)
return;
if (msg.Type == Gui::SelectionChanges::AddSelection) {
if (strcmp(msg.pDocName, BooleanView->getObject()->getDocument()->getName()) != 0)
return;
// get the selected object
PartDesign::Boolean* pcBoolean = static_cast<PartDesign::Boolean*>(BooleanView->getObject());
std::string body(msg.pObjectName);
if (body.empty())
return;
App::DocumentObject* pcBody = pcBoolean->getDocument()->getObject(body.c_str());
if (!pcBody)
return;
// if the selected object is not a body then get the body it is part of
if (!pcBody->isDerivedFrom<PartDesign::Body>()) {
pcBody = PartDesign::Body::findBodyOf(pcBody);
if (!pcBody)
return;
body = pcBody->getNameInDocument();
}
std::vector<App::DocumentObject*> bodies = pcBoolean->Group.getValues();
if (selectionMode == bodyAdd) {
if (std::find(bodies.begin(), bodies.end(), pcBody) == bodies.end()) {
bodies.push_back(pcBody);
pcBoolean->Group.setValues(std::vector<App::DocumentObject*>());
pcBoolean->addObjects(bodies);
QListWidgetItem* item = new QListWidgetItem(ui->listWidgetBodies);
item->setText(QString::fromUtf8(pcBody->Label.getValue()));
item->setData(Qt::UserRole, QString::fromLatin1(pcBody->getNameInDocument()));
pcBoolean->getDocument()->recomputeFeature(pcBoolean);
ui->buttonBodyAdd->setChecked(false);
exitSelectionMode();
// Hide the bodies
if (bodies.size() == 1) {
// Hide base body and added body
Gui::ViewProviderDocumentObject* vp = dynamic_cast<Gui::ViewProviderDocumentObject*>(
Gui::Application::Instance->getViewProvider(pcBoolean->BaseFeature.getValue()));
if (vp)
vp->hide();
vp = dynamic_cast<Gui::ViewProviderDocumentObject*>(
Gui::Application::Instance->getViewProvider(bodies.front()));
if (vp)
vp->hide();
BooleanView->show();
} else {
// Hide newly added body
Gui::ViewProviderDocumentObject* vp = dynamic_cast<Gui::ViewProviderDocumentObject*>(
Gui::Application::Instance->getViewProvider(bodies.back()));
if (vp)
vp->hide();
}
}
}
else if (selectionMode == bodyRemove) {
std::vector<App::DocumentObject*>::iterator b = std::find(bodies.begin(), bodies.end(), pcBody);
if (b != bodies.end()) {
bodies.erase(b);
pcBoolean->setObjects(bodies);
QString internalName = QString::fromStdString(body);
for (int row = 0; row < ui->listWidgetBodies->count(); row++) {
QListWidgetItem* item = ui->listWidgetBodies->item(row);
QString name = item->data(Qt::UserRole).toString();
if (name == internalName) {
ui->listWidgetBodies->takeItem(row);
delete item;
break;
}
}
pcBoolean->getDocument()->recomputeFeature(pcBoolean);
ui->buttonBodyRemove->setChecked(false);
exitSelectionMode();
// Make bodies visible again
Gui::ViewProviderDocumentObject* vp = dynamic_cast<Gui::ViewProviderDocumentObject*>(
Gui::Application::Instance->getViewProvider(pcBody));
if (vp)
vp->show();
if (bodies.empty()) {
Gui::ViewProviderDocumentObject* vp = dynamic_cast<Gui::ViewProviderDocumentObject*>(
Gui::Application::Instance->getViewProvider(pcBoolean->BaseFeature.getValue()));
if (vp)
vp->show();
BooleanView->hide();
}
}
}
}
}
void TaskBooleanParameters::onButtonBodyAdd(bool checked)
{
if (checked) {
PartDesign::Boolean* pcBoolean = static_cast<PartDesign::Boolean*>(BooleanView->getObject());
Gui::Document* doc = BooleanView->getDocument();
BooleanView->hide();
if (pcBoolean->Group.getValues().empty() && pcBoolean->BaseFeature.getValue())
doc->setHide(pcBoolean->BaseFeature.getValue()->getNameInDocument());
selectionMode = bodyAdd;
Gui::Selection().clearSelection();
} else {
exitSelectionMode();
}
}
void TaskBooleanParameters::onButtonBodyRemove(bool checked)
{
if (checked) {
Gui::Document* doc = Gui::Application::Instance->activeDocument();
if (doc)
BooleanView->show();
selectionMode = bodyRemove;
Gui::Selection().clearSelection();
} else {
exitSelectionMode();
}
}
void TaskBooleanParameters::onTypeChanged(int index)
{
PartDesign::Boolean* pcBoolean = static_cast<PartDesign::Boolean*>(BooleanView->getObject());
switch (index) {
case 0: pcBoolean->Type.setValue("Fuse"); break;
case 1: pcBoolean->Type.setValue("Cut"); break;
case 2: pcBoolean->Type.setValue("Common"); break;
default: pcBoolean->Type.setValue("Fuse");
}
pcBoolean->getDocument()->recomputeFeature(pcBoolean);
}
const std::vector<std::string> TaskBooleanParameters::getBodies() const
{
std::vector<std::string> result;
for (int i = 0; i < ui->listWidgetBodies->count(); i++)
result.push_back(ui->listWidgetBodies->item(i)->data(Qt::UserRole).toString().toStdString());
return result;
}
int TaskBooleanParameters::getType() const
{
return ui->comboType->currentIndex();
}
void TaskBooleanParameters::onBodyDeleted()
{
PartDesign::Boolean* pcBoolean = static_cast<PartDesign::Boolean*>(BooleanView->getObject());
std::vector<App::DocumentObject*> bodies = pcBoolean->Group.getValues();
int index = ui->listWidgetBodies->currentRow();
if (index < 0 && (size_t) index > bodies.size())
return;
App::DocumentObject* body = bodies[index];
QString internalName = ui->listWidgetBodies->item(index)->data(Qt::UserRole).toString();
for (auto it = bodies.begin(); it != bodies.end(); ++it) {
if (internalName == QLatin1String((*it)->getNameInDocument())) {
body = *it;
bodies.erase(it);
break;
}
}
ui->listWidgetBodies->model()->removeRow(index);
pcBoolean->setObjects(bodies);
pcBoolean->getDocument()->recomputeFeature(pcBoolean);
// Make bodies visible again
Gui::ViewProviderDocumentObject* vp = dynamic_cast<Gui::ViewProviderDocumentObject*>(
Gui::Application::Instance->getViewProvider(body));
if (vp)
vp->show();
if (bodies.empty()) {
Gui::ViewProviderDocumentObject* vp = dynamic_cast<Gui::ViewProviderDocumentObject*>(
Gui::Application::Instance->getViewProvider(pcBoolean->BaseFeature.getValue()));
if (vp)
vp->show();
BooleanView->hide();
}
}
TaskBooleanParameters::~TaskBooleanParameters() = default;
void TaskBooleanParameters::changeEvent(QEvent *e)
{
TaskBox::changeEvent(e);
if (e->type() == QEvent::LanguageChange) {
ui->comboType->blockSignals(true);
int index = ui->comboType->currentIndex();
ui->retranslateUi(proxy);
ui->comboType->setCurrentIndex(index);
}
}
void TaskBooleanParameters::exitSelectionMode()
{
selectionMode = none;
Gui::Document* doc = Gui::Application::Instance->activeDocument();
if (doc)
doc->setShow(BooleanView->getObject()->getNameInDocument());
}
//**************************************************************************
//**************************************************************************
// TaskDialog
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
TaskDlgBooleanParameters::TaskDlgBooleanParameters(ViewProviderBoolean *BooleanView)
: TaskDialog(),BooleanView(BooleanView)
{
assert(BooleanView);
parameter = new TaskBooleanParameters(BooleanView);
Content.push_back(parameter);
}
TaskDlgBooleanParameters::~TaskDlgBooleanParameters() = default;
//==== calls from the TaskView ===============================================================
void TaskDlgBooleanParameters::open()
{
}
void TaskDlgBooleanParameters::clicked(int)
{
}
bool TaskDlgBooleanParameters::accept()
{
auto obj = BooleanView->getObject();
if(!obj || !obj->isAttachedToDocument())
return false;
BooleanView->Visibility.setValue(true);
try {
std::vector<std::string> bodies = parameter->getBodies();
if (bodies.empty()) {
QMessageBox::warning(parameter, tr("Empty body list"),
tr("The body list cannot be empty"));
return false;
}
std::stringstream str;
str << Gui::Command::getObjectCmd(obj) << ".setObjects( [";
for (const auto & body : bodies) {
str << "App.getDocument('" << obj->getDocument()->getName() << "').getObject('" << body << "'),";
}
str << "])";
Gui::Command::runCommand(Gui::Command::Doc,str.str().c_str());
}
catch (const Base::Exception& e) {
QMessageBox::warning(parameter, tr("Boolean: Accept: Input error"), QCoreApplication::translate("Exception", e.what()));
return false;
}
FCMD_OBJ_CMD(obj,"Type = " << parameter->getType());
Gui::Command::doCommand(Gui::Command::Doc,"App.ActiveDocument.recompute()");
Gui::Command::doCommand(Gui::Command::Gui,"Gui.activeDocument().resetEdit()");
Gui::Command::commitCommand();
return true;
}
bool TaskDlgBooleanParameters::reject()
{
// Show the bodies again
PartDesign::Boolean* obj = static_cast<PartDesign::Boolean*>(BooleanView->getObject());
Gui::Document* doc = Gui::Application::Instance->activeDocument();
if (doc) {
if (obj->BaseFeature.getValue()) {
doc->setShow(obj->BaseFeature.getValue()->getNameInDocument());
std::vector<App::DocumentObject*> bodies = obj->Group.getValues();
for (auto body : bodies) {
doc->setShow(body->getNameInDocument());
}
}
}
// roll back the done things
Gui::Command::abortCommand();
Gui::Command::doCommand(Gui::Command::Gui,"Gui.activeDocument().resetEdit()");
return true;
}
#include "moc_TaskBooleanParameters.cpp"