PartDesign: Implement preview for Booleans

This commit is contained in:
Kacper Donat
2025-08-12 20:28:14 +02:00
parent 0aa95996d9
commit 18792297f6
7 changed files with 208 additions and 73 deletions

View File

@@ -1,6 +1,7 @@
/***************************************************************************
* Copyright (c) 2013 Jan Rheinländer *
* <jrheinlaender@users.sourceforge.net> *
* Copyright (c) 2025 Kacper Donat <kacper@kadet.net> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
@@ -26,30 +27,39 @@
#ifndef _PreComp_
# include <QMenu>
# include <QMessageBox>
# include <Inventor/nodes/SoTransform.h>
#endif
#include "ViewProviderBoolean.h"
#include "StyleParameters.h"
#include "TaskBooleanParameters.h"
#include <Base/ServiceProvider.h>
#include <Mod/PartDesign/App/FeatureBoolean.h>
#include <Gui/Application.h>
#include <Gui/Control.h>
#include <Gui/Command.h>
#include <Gui/Document.h>
#include <Gui/MainWindow.h>
#include <Gui/Utilities.h>
#include <Mod/PartDesign/App/Body.h>
#include <Mod/Sketcher/Gui/TaskDlgEditSketch.h>
using namespace PartDesignGui;
PROPERTY_SOURCE_WITH_EXTENSIONS(PartDesignGui::ViewProviderBoolean,PartDesignGui::ViewProvider)
const char* PartDesignGui::ViewProviderBoolean::DisplayEnum[] = {"Result","Tools",nullptr};
const char* PartDesignGui::ViewProviderBoolean::DisplayEnum[] = {"Result", "Tools", nullptr};
ViewProviderBoolean::ViewProviderBoolean()
: pcToolsPreview(new SoGroup)
, pcBasePreviewToggle(new SoToggleSwitch)
{
sPixmap = "PartDesign_Boolean.svg";
Gui::ViewProviderGeoFeatureGroupExtension::initExtension(this);
ViewProviderGeoFeatureGroupExtension::initExtension(this);
ADD_PROPERTY(Display,((long)0));
Display.setEnums(DisplayEnum);
@@ -57,62 +67,19 @@ ViewProviderBoolean::ViewProviderBoolean()
ViewProviderBoolean::~ViewProviderBoolean() = default;
void ViewProviderBoolean::setupContextMenu(QMenu* menu, QObject* receiver, const char* member)
{
addDefaultAction(menu, QObject::tr("Edit Boolean"));
PartDesignGui::ViewProvider::setupContextMenu(menu, receiver, member);
}
bool ViewProviderBoolean::setEdit(int ModNum)
{
if (ModNum == ViewProvider::Default ) {
// When double-clicking on the item for this fillet the
// object unsets and sets its edit mode without closing
// the task panel
Gui::TaskView::TaskDialog *dlg = Gui::Control().activeDialog();
TaskDlgBooleanParameters *booleanDlg = qobject_cast<TaskDlgBooleanParameters *>(dlg);
if (booleanDlg && booleanDlg->getBooleanView() != this)
booleanDlg = nullptr; // another pad left open its task panel
if (dlg && !booleanDlg) {
QMessageBox msgBox(Gui::getMainWindow());
msgBox.setText(QObject::tr("A dialog is already open in the task panel"));
msgBox.setInformativeText(QObject::tr("Close this dialog?"));
msgBox.setStandardButtons(QMessageBox::Yes | QMessageBox::No);
msgBox.setDefaultButton(QMessageBox::Yes);
int ret = msgBox.exec();
if (ret == QMessageBox::Yes)
Gui::Control().closeDialog();
else
return false;
}
// clear the selection (convenience)
Gui::Selection().clearSelection();
// always change to PartDesign WB, remember where we come from
oldWb = Gui::Command::assureWorkbench("PartDesignWorkbench");
// start the edit dialog
if (booleanDlg)
Gui::Control().showDialog(booleanDlg);
else
Gui::Control().showDialog(new TaskDlgBooleanParameters(this));
return true;
}
else {
return PartGui::ViewProviderPart::setEdit(ModNum); // clazy:exclude=skipped-base-method
}
ViewProvider::setupContextMenu(menu, receiver, member);
}
bool ViewProviderBoolean::onDelete(const std::vector<std::string> &s)
{
PartDesign::Boolean* pcBoolean = getObject<PartDesign::Boolean>();
auto* feature = getObject<PartDesign::Boolean>();
// if abort command deleted the object the bodies are visible again
std::vector<App::DocumentObject*> bodies = pcBoolean->Group.getValues();
for (auto body : bodies) {
for (auto body : feature->Group.getValues()) {
if (auto vp = Gui::Application::Instance->getViewProvider(body)) {
vp->show();
}
@@ -121,11 +88,6 @@ bool ViewProviderBoolean::onDelete(const std::vector<std::string> &s)
return ViewProvider::onDelete(s);
}
void ViewProviderBoolean::attach(App::DocumentObject* obj)
{
PartGui::ViewProviderPartExt::attach(obj);
}
const char* ViewProviderBoolean::getDefaultDisplayMode() const
{
return "Flat Lines";
@@ -133,18 +95,140 @@ const char* ViewProviderBoolean::getDefaultDisplayMode() const
void ViewProviderBoolean::onChanged(const App::Property* prop) {
PartDesignGui::ViewProvider::onChanged(prop);
ViewProvider::onChanged(prop);
if(prop == &Display) {
if (prop == &Display) {
const auto getDisplayMode = [this]() {
if (Display.getValue() != 0) {
return "Group";
}
if(Display.getValue() == 0) {
auto vp = getBodyViewProvider();
if(vp)
setDisplayMode(vp->DisplayMode.getValueAsString());
else
setDisplayMode("Flat Lines");
} else {
setDisplayMode("Group");
}
if (auto bodyViewProvider = getBodyViewProvider()) {
return bodyViewProvider->DisplayMode.getValueAsString();
}
return getDefaultDisplayMode();
};
setDisplayMode(getDisplayMode());
}
if (prop == &Visibility) {
updateBasePreviewVisibility();
}
}
void ViewProviderBoolean::updateData(const App::Property* prop)
{
auto feature = getObject<PartDesign::Boolean>();
if (prop == &feature->Type) {
const auto* styleParameterManager = Base::provideService<Gui::StyleParameters::ParameterManager>();
const auto type = feature->Type.getValueAsString();
const std::map<std::string_view, Gui::StyleParameters::ParameterDefinition<Base::Color>> lookup {
{"Cut", StyleParameters::PreviewSubtractiveColor},
{"Common", StyleParameters::PreviewCommonColor},
{"Fuse", StyleParameters::PreviewAdditiveColor},
};
if (lookup.contains(type)) {
PreviewColor.setValue(styleParameterManager->resolve(lookup.at(type)));
}
updateBasePreviewVisibility();
}
ViewProvider::updateData(prop);
}
void ViewProviderBoolean::attachPreview()
{
ViewProvider::attachPreview();
pcPreviewRoot->addChild(this->pcToolsPreview);
pcPreviewRoot->addChild(this->pcBasePreviewToggle);
}
void ViewProviderBoolean::updatePreview()
{
const auto* styleParameterManager = Base::provideService<Gui::StyleParameters::ParameterManager>();
const float toolTransparency = static_cast<float>(styleParameterManager->resolve(StyleParameters::PreviewToolTransparency).value);
auto boolean = getObject<PartDesign::Boolean>();
if (!boolean) {
return;
}
const auto addToolPreview = [this, toolTransparency](App::DocumentObject* tool) {
const auto feature = freecad_cast<Part::Feature*>(tool);
if (!feature) {
return;
}
Part::TopoShape toolShape = feature->Shape.getShape();
auto pcToolPreview = new PartGui::SoPreviewShape;
updatePreviewShape(toolShape, pcToolPreview);
pcToolPreview->transparency.setValue(toolTransparency);
pcToolPreview->color.connectFrom(&pcPreviewShape->color);
pcToolPreview->lineWidth.connectFrom(&pcPreviewShape->lineWidth);
pcToolsPreview->addChild(pcToolPreview);
};
const auto addBaseShapePreview = [this, toolTransparency, boolean]() {
auto baseFeature = dynamic_cast<PartDesign::Feature*>(boolean->BaseFeature.getValue());
if (!baseFeature) {
return;
}
auto baseFeatureViewProvider = freecad_cast<ViewProvider*>(Gui::Application::Instance->getViewProvider(baseFeature));
if (!baseFeatureViewProvider) {
return;
}
auto pcBaseShapePreview = new PartGui::SoPreviewShape;
updatePreviewShape(baseFeature->Shape.getShape(), pcBaseShapePreview);
pcBaseShapePreview->transparency.setValue(toolTransparency);
pcBaseShapePreview->color.setValue(baseFeatureViewProvider->ShapeAppearance.getDiffuseColor().asValue<SbColor>());
pcBaseShapePreview->lineWidth.connectFrom(&pcPreviewShape->lineWidth);
pcBasePreviewToggle->addChild(pcBaseShapePreview);
};
try {
const auto& tools = boolean->Group.getValues();
if (tools.empty()) {
return;
}
Gui::coinRemoveAllChildren(pcToolsPreview);
Gui::coinRemoveAllChildren(pcBasePreviewToggle);
addBaseShapePreview();
std::ranges::for_each(tools, addToolPreview);
} catch (const Base::Exception& e) {
e.reportException();
}
ViewProvider::updatePreview();
}
TaskDlgFeatureParameters* ViewProviderBoolean::getEditDialog()
{
return new TaskDlgBooleanParameters(this);
}
void ViewProviderBoolean::updateBasePreviewVisibility()
{
auto feature = getObject<PartDesign::Boolean>();
// enable base preview for Common operation only and when the final result is shown
pcBasePreviewToggle->on = strcmp(feature->Type.getValueAsString(), "Common") == 0 && Visibility.getValue();
}