Files
create/src/Mod/Sketcher/Gui/Command.cpp
Abdullah Tahiri 5a0e7d4ee3 Sketcher: Rewrite grid command
==============================

Fix unresolved issues:
https://github.com/FreeCAD/FreeCAD/pull/7754/files#r1025493443
https://github.com/FreeCAD/FreeCAD/pull/7754/files#r1019077589
https://github.com/FreeCAD/FreeCAD/pull/7754/files#r1025502204

Summary:
- EventFilter unnecessary in light of new implemented signal aboutToshow. The data of the drop-down action is updated only when necessary (when it is going to be shown).
- Structure of individual commands under drop-down simplified to a single action, rendering the need for groupcommands obsolete, while keeping all the grid related controls and
the logic for controlling the grid in a single action class.
- Reduce the complexity and overload of isActive to the bare minimum (determining if it is active and updating the icon to the right icon if so).

Refactor:
- Better name for utils functions, as when a DSH is active, the edit mode VPSketch is a data member of DSH, sketchgui (so this function is not really necessary when the DSH is active).
2023-02-25 23:13:55 +01:00

1199 lines
47 KiB
C++

/***************************************************************************
* Copyright (c) 2008 Jürgen Riegel <juergen.riegel@web.de> *
* *
* 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 <QApplication>
# include <QInputDialog>
# include <QLabel>
# include <QMenu>
# include <QMessageBox>
# include <QHBoxLayout>
# include <QWidgetAction>
#endif
#include <App/DocumentObjectGroup.h>
#include <Gui/Application.h>
#include <App/OriginFeature.h>
#include <Gui/Action.h>
#include <Gui/BitmapFactory.h>
#include <Gui/CommandT.h>
#include <Gui/Control.h>
#include <Gui/Document.h>
#include <Gui/MainWindow.h>
#include <Gui/PrefWidgets.h>
#include <Gui/SelectionFilter.h>
#include <Gui/SelectionObject.h>
#include <Mod/Sketcher/App/Constraint.h>
#include <Mod/Sketcher/App/SketchObject.h>
#include <Mod/Part/App/Attacher.h>
#include <Mod/Part/App/Part2DObject.h>
#include "SketchMirrorDialog.h"
#include "SketchOrientationDialog.h"
#include "TaskSketcherValidation.h"
#include "ViewProviderSketch.h"
#include "Utils.h"
using namespace std;
using namespace SketcherGui;
using namespace Part;
using namespace Attacher;
namespace SketcherGui {
class ExceptionWrongInput : public Base::Exception {
public:
ExceptionWrongInput()
: ErrMsg(QString())
{
}
//Pass untranslated strings, enclosed in QT_TR_NOOP()
explicit ExceptionWrongInput(const char* ErrMsg){
this->ErrMsg = QObject::tr( ErrMsg );
this->setMessage(ErrMsg);
}
~ExceptionWrongInput() throw() override {}
QString ErrMsg;
};
Attacher::eMapMode SuggestAutoMapMode(Attacher::SuggestResult::eSuggestResult* pMsgId = nullptr,
QString* message = nullptr,
std::vector<Attacher::eMapMode>* allmodes = nullptr){
//convert pointers into valid references, to avoid checking for null pointers everywhere
Attacher::SuggestResult::eSuggestResult buf;
if (!pMsgId)
pMsgId = &buf;
Attacher::SuggestResult::eSuggestResult &msg = *pMsgId;
QString buf2;
if (!message)
message = &buf2;
QString &msg_str = *message;
App::PropertyLinkSubList tmpSupport;
Gui::Selection().getAsPropertyLinkSubList(tmpSupport);
Attacher::SuggestResult sugr;
AttachEngine3D eng;
eng.setUp(tmpSupport);
eng.suggestMapModes(sugr);
if (allmodes)
*allmodes = sugr.allApplicableModes;
msg = sugr.message;
switch(msg){
case Attacher::SuggestResult::srOK:
break;
case Attacher::SuggestResult::srNoModesFit:
msg_str = QObject::tr("There are no modes that accept the selected set of subelements");
break;
case Attacher::SuggestResult::srLinkBroken:
msg_str = QObject::tr("Broken link to support subelements");
break;
case Attacher::SuggestResult::srUnexpectedError:
msg_str = QObject::tr("Unexpected error");
break;
case Attacher::SuggestResult::srIncompatibleGeometry:
if(tmpSupport.getSubValues()[0].substr(0,4) == std::string("Face"))
msg_str = QObject::tr("Face is non-planar");
else
msg_str = QObject::tr("Selected shapes are of wrong form (e.g., a curved edge where a straight one is needed)");
break;
default:
msg_str = QObject::tr("Unexpected error");
assert(0/*no message for eSuggestResult enum item*/);
}
return sugr.bestFitMode;
}
} //namespace SketcherGui
/* Sketch commands =======================================================*/
DEF_STD_CMD_A(CmdSketcherNewSketch)
CmdSketcherNewSketch::CmdSketcherNewSketch()
:Command("Sketcher_NewSketch")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("Create sketch");
sToolTipText = QT_TR_NOOP("Create a new sketch.");
sWhatsThis = "Sketcher_NewSketch";
sStatusTip = sToolTipText;
sPixmap = "Sketcher_NewSketch";
}
void CmdSketcherNewSketch::activated(int iMsg)
{
Q_UNUSED(iMsg);
Attacher::eMapMode mapmode = Attacher::mmDeactivated;
bool bAttach = false;
if (Gui::Selection().hasSelection()){
Attacher::SuggestResult::eSuggestResult msgid = Attacher::SuggestResult::srOK;
QString msg_str;
std::vector<Attacher::eMapMode> validModes;
mapmode = SuggestAutoMapMode(&msgid, &msg_str, &validModes);
if (msgid == Attacher::SuggestResult::srOK)
bAttach = true;
if (msgid != Attacher::SuggestResult::srOK && msgid != Attacher::SuggestResult::srNoModesFit){
QMessageBox::warning(Gui::getMainWindow(),
QObject::tr("Sketch mapping"),
QObject::tr("Can't map the sketch to selected object. %1.").arg(msg_str));
return;
}
if (validModes.size() > 1){
validModes.insert(validModes.begin(), Attacher::mmDeactivated);
bool ok;
QStringList items;
items.push_back(QObject::tr("Don't attach"));
int iSugg = 0;//index of the auto-suggested mode in the list of valid modes
for (size_t i = 0 ; i < validModes.size() ; ++i){
items.push_back(QString::fromLatin1(AttachEngine::getModeName(validModes[i]).c_str()));
if (validModes[i] == mapmode)
iSugg = items.size()-1;
}
QString text = QInputDialog::getItem(Gui::getMainWindow(),
qApp->translate("Sketcher_NewSketch", "Sketch attachment"),
qApp->translate("Sketcher_NewSketch", "Select the method to attach this sketch to selected object"),
items, iSugg, false, &ok, Qt::MSWindowsFixedSizeDialogHint);
if (!ok)
return;
int index = items.indexOf(text);
if (index == 0){
bAttach = false;
mapmode = Attacher::mmDeactivated;
} else {
bAttach = true;
mapmode = validModes[index-1];
}
}
}
if (bAttach) {
std::vector<Gui::SelectionObject> objects = Gui::Selection().getSelectionEx();
//assert (objects.size() == 1); //should have been filtered out by SuggestAutoMapMode
//Gui::SelectionObject &sel_support = objects[0];
App::PropertyLinkSubList support;
Gui::Selection().getAsPropertyLinkSubList(support);
std::string supportString = support.getPyReprString();
// create Sketch on Face
std::string FeatName = getUniqueObjectName("Sketch");
openCommand(QT_TRANSLATE_NOOP("Command", "Create a new sketch on a face"));
doCommand(Doc,"App.activeDocument().addObject('Sketcher::SketchObject', '%s')", FeatName.c_str());
if (mapmode < Attacher::mmDummy_NumberOfModes)
doCommand(Gui,"App.activeDocument().%s.MapMode = \"%s\"",FeatName.c_str(),AttachEngine::getModeName(mapmode).c_str());
else
assert(0 /* mapmode index out of range */);
doCommand(Gui,"App.activeDocument().%s.Support = %s", FeatName.c_str(), supportString.c_str());
doCommand(Gui,"App.activeDocument().recompute()"); // recompute the sketch placement based on its support
doCommand(Gui,"Gui.activeDocument().setEdit('%s')", FeatName.c_str());
Part::Feature *part = static_cast<Part::Feature*>(support.getValue()); // if multi-part support, this will return 0
if (part){
App::DocumentObjectGroup* grp = part->getGroup();
if (grp) {
doCommand(Doc,
"App.activeDocument().%s.addObject(App.activeDocument().%s)",
grp->getNameInDocument(), FeatName.c_str());
}
}
}
else {
// ask user for orientation
SketchOrientationDialog Dlg;
Dlg.adjustSize();
if (Dlg.exec() != QDialog::Accepted)
return; // canceled
Base::Vector3d p = Dlg.Pos.getPosition();
Base::Rotation r = Dlg.Pos.getRotation();
std::string FeatName = getUniqueObjectName("Sketch");
openCommand(QT_TRANSLATE_NOOP("Command", "Create a new sketch"));
doCommand(Doc, "App.activeDocument().addObject('Sketcher::SketchObject', '%s')", FeatName.c_str());
doCommand(Doc,
"App.activeDocument().%s.Placement = App.Placement(App.Vector(%f, %f, %f), App.Rotation(%f, %f, %f, %f))",
FeatName.c_str(), p.x, p.y, p.z, r[0], r[1], r[2], r[3]);
doCommand(Doc,"App.activeDocument().%s.MapMode = \"%s\"",
FeatName.c_str(), AttachEngine::getModeName(Attacher::mmDeactivated).c_str());
doCommand(Gui,"Gui.activeDocument().setEdit('%s')", FeatName.c_str());
}
}
bool CmdSketcherNewSketch::isActive()
{
if (getActiveGuiDocument())
return true;
else
return false;
}
DEF_STD_CMD_A(CmdSketcherEditSketch)
CmdSketcherEditSketch::CmdSketcherEditSketch()
:Command("Sketcher_EditSketch")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("Edit sketch");
sToolTipText = QT_TR_NOOP("Edit the selected sketch.");
sWhatsThis = "Sketcher_EditSketch";
sStatusTip = sToolTipText;
sPixmap = "Sketcher_EditSketch";
}
void CmdSketcherEditSketch::activated(int iMsg)
{
Q_UNUSED(iMsg);
Gui::SelectionFilter SketchFilter("SELECT Sketcher::SketchObject COUNT 1");
if (SketchFilter.match()) {
Sketcher::SketchObject *Sketch = static_cast<Sketcher::SketchObject*>(SketchFilter.Result[0][0].getObject());
doCommand(Gui,"Gui.activeDocument().setEdit('%s')",Sketch->getNameInDocument());
}
}
bool CmdSketcherEditSketch::isActive()
{
return Gui::Selection().countObjectsOfType(Sketcher::SketchObject::getClassTypeId()) == 1;
}
DEF_STD_CMD_A(CmdSketcherLeaveSketch)
CmdSketcherLeaveSketch::CmdSketcherLeaveSketch()
: Command("Sketcher_LeaveSketch")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("Leave sketch");
sToolTipText = QT_TR_NOOP("Finish editing the active sketch.");
sWhatsThis = "Sketcher_LeaveSketch";
sStatusTip = sToolTipText;
sPixmap = "Sketcher_LeaveSketch";
eType = 0;
}
void CmdSketcherLeaveSketch::activated(int iMsg)
{
Q_UNUSED(iMsg);
Gui::Document *doc = getActiveGuiDocument();
if (doc) {
// checks if a Sketch Viewprovider is in Edit and is in no special mode
SketcherGui::ViewProviderSketch* vp = dynamic_cast<SketcherGui::ViewProviderSketch*>(doc->getInEdit());
if (vp && vp->getSketchMode() != ViewProviderSketch::STATUS_NONE)
vp->purgeHandler();
}
// See also TaskDlgEditSketch::reject
doCommand(Gui,"Gui.activeDocument().resetEdit()");
doCommand(Doc,"App.ActiveDocument.recompute()");
}
bool CmdSketcherLeaveSketch::isActive()
{
return isSketchInEdit(getActiveGuiDocument());
}
DEF_STD_CMD_A(CmdSketcherStopOperation)
CmdSketcherStopOperation::CmdSketcherStopOperation()
: Command("Sketcher_StopOperation")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("Stop operation");
sToolTipText = QT_TR_NOOP("When in edit mode, "
"stop the active operation "
"(drawing, constraining, etc.).");
sWhatsThis = "Sketcher_StopOperation";
sStatusTip = sToolTipText;
sPixmap = "process-stop";
eType = 0;
}
void CmdSketcherStopOperation::activated(int iMsg)
{
Q_UNUSED(iMsg);
Gui::Document *doc = getActiveGuiDocument();
if (doc) {
SketcherGui::ViewProviderSketch* vp = dynamic_cast<SketcherGui::ViewProviderSketch*>(doc->getInEdit());
if (vp) {
vp->purgeHandler();
}
}
}
bool CmdSketcherStopOperation::isActive()
{
return isSketchInEdit(getActiveGuiDocument());
}
DEF_STD_CMD_A(CmdSketcherReorientSketch)
CmdSketcherReorientSketch::CmdSketcherReorientSketch()
:Command("Sketcher_ReorientSketch")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("Reorient sketch...");
sToolTipText = QT_TR_NOOP("Place the selected sketch on one of the global coordinate planes.\n"
"This will clear the 'Support' property, if any.");
sWhatsThis = "Sketcher_ReorientSketch";
sStatusTip = sToolTipText;
sPixmap = "Sketcher_ReorientSketch";
}
void CmdSketcherReorientSketch::activated(int iMsg)
{
Q_UNUSED(iMsg);
Sketcher::SketchObject* sketch = Gui::Selection().getObjectsOfType<Sketcher::SketchObject>().front();
if (sketch->Support.getValue()) {
int ret = QMessageBox::question(Gui::getMainWindow(),
qApp->translate("Sketcher_ReorientSketch","Sketch has support"),
qApp->translate("Sketcher_ReorientSketch","Sketch with a support face cannot be reoriented.\n"
"Do you want to detach it from the support?"),
QMessageBox::Yes|QMessageBox::No);
if (ret == QMessageBox::No)
return;
sketch->Support.setValue(nullptr);
}
// ask user for orientation
SketchOrientationDialog Dlg;
if (Dlg.exec() != QDialog::Accepted)
return; // canceled
Base::Vector3d p = Dlg.Pos.getPosition();
Base::Rotation r = Dlg.Pos.getRotation();
// do the right view direction
std::string camstring;
switch (Dlg.DirType) {
case 0:
camstring = "#Inventor V2.1 ascii\\n"
"OrthographicCamera {\\n"
" viewportMapping ADJUST_CAMERA\\n"
" position 0 0 87\\n"
" orientation 0 0 1 0\\n"
" nearDistance -112.88701\\n"
" farDistance 287.28702\\n"
" aspectRatio 1\\n"
" focalDistance 87\\n"
" height 143.52005 }";
break;
case 1:
camstring = "#Inventor V2.1 ascii\\n"
"OrthographicCamera {\\n"
" viewportMapping ADJUST_CAMERA\\n"
" position 0 0 -87\\n"
" orientation -1 0 0 3.1415927\\n"
" nearDistance -112.88701\\n"
" farDistance 287.28702\\n "
" aspectRatio 1\\n"
" focalDistance 87\\n"
" height 143.52005 }";
break;
case 2:
camstring = "#Inventor V2.1 ascii\\n"
"OrthographicCamera {\\n"
" viewportMapping ADJUST_CAMERA\\n"
" position 0 -87 0\\n"
" orientation -1 0 0 4.712389\\n"
" nearDistance -112.88701\\n"
" farDistance 287.28702\\n"
" aspectRatio 1\\n"
" focalDistance 87\\n"
" height 143.52005\\n\\n}";
break;
case 3:
camstring = "#Inventor V2.1 ascii\\n"
"OrthographicCamera {\\n"
" viewportMapping ADJUST_CAMERA\\n"
" position 0 87 0\\n"
" orientation 0 0.70710683 0.70710683 3.1415927\\n"
" nearDistance -112.88701\\n"
" farDistance 287.28702\\n"
" aspectRatio 1\\n"
" focalDistance 87\\n"
" height 143.52005\\n\\n}";
break;
case 4:
camstring = "#Inventor V2.1 ascii\\n"
"OrthographicCamera {\\n"
" viewportMapping ADJUST_CAMERA\\n"
" position 87 0 0\\n"
" orientation 0.57735026 0.57735026 0.57735026 2.0943952\\n"
" nearDistance -112.887\\n"
" farDistance 287.28699\\n"
" aspectRatio 1\\n"
" focalDistance 87\\n"
" height 143.52005\\n\\n}";
break;
case 5:
camstring = "#Inventor V2.1 ascii\\n"
"OrthographicCamera {\\n"
" viewportMapping ADJUST_CAMERA\\n"
" position -87 0 0\\n"
" orientation -0.57735026 0.57735026 0.57735026 4.1887903\\n"
" nearDistance -112.887\\n"
" farDistance 287.28699\\n"
" aspectRatio 1\\n"
" focalDistance 87\\n"
" height 143.52005\\n\\n}";
break;
}
openCommand(QT_TRANSLATE_NOOP("Command", "Reorient sketch"));
Gui::cmdAppObjectArgs(sketch,
"Placement = App.Placement(App.Vector(%f, %f, %f), App.Rotation(%f, %f, %f, %f))",
p.x, p.y, p.z, r[0], r[1], r[2], r[3]);
doCommand(Gui,"Gui.ActiveDocument.setEdit('%s')", sketch->getNameInDocument());
}
bool CmdSketcherReorientSketch::isActive()
{
return Gui::Selection().countObjectsOfType(Sketcher::SketchObject::getClassTypeId()) == 1;
}
DEF_STD_CMD_A(CmdSketcherMapSketch)
CmdSketcherMapSketch::CmdSketcherMapSketch()
: Command("Sketcher_MapSketch")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("Map sketch to face...");
sToolTipText = QT_TR_NOOP("Set the 'Support' of a sketch.\n"
"First select the supporting geometry, for example, a face or an edge of a solid object,\n"
"then call this command, then choose the desired sketch.");
sWhatsThis = "Sketcher_MapSketch";
sStatusTip = sToolTipText;
sPixmap = "Sketcher_MapSketch";
}
void CmdSketcherMapSketch::activated(int iMsg)
{
Q_UNUSED(iMsg);
QString msg_str;
try {
Attacher::eMapMode suggMapMode;
std::vector<Attacher::eMapMode> validModes;
//check that selection is valid for at least some mapping mode.
Attacher::SuggestResult::eSuggestResult msgid = Attacher::SuggestResult::srOK;
suggMapMode = SuggestAutoMapMode(&msgid, &msg_str, &validModes);
App::Document* doc = App::GetApplication().getActiveDocument();
std::vector<App::DocumentObject*> sketches = doc->getObjectsOfType(Part::Part2DObject::getClassTypeId());
if (sketches.empty()) {
QMessageBox::warning(Gui::getMainWindow(),
qApp->translate("Sketcher_MapSketch", "No sketch found"),
qApp->translate("Sketcher_MapSketch", "The document doesn't have a sketch"));
return;
}
bool ok;
QStringList items;
for (std::vector<App::DocumentObject*>::iterator it = sketches.begin(); it != sketches.end(); ++it)
items.push_back(QString::fromUtf8((*it)->Label.getValue()));
QString text = QInputDialog::getItem(Gui::getMainWindow(),
qApp->translate("Sketcher_MapSketch", "Select sketch"),
qApp->translate("Sketcher_MapSketch", "Select a sketch from the list"),
items, 0, false, &ok, Qt::MSWindowsFixedSizeDialogHint);
if (!ok)
return;
int index = items.indexOf(text);
Part2DObject* sketch = static_cast<Part2DObject*>(sketches[index]);
// check circular dependency
std::vector<Gui::SelectionObject> selobjs = Gui::Selection().getSelectionEx();
for (size_t i = 0; i < selobjs.size(); ++i) {
App::DocumentObject* part = static_cast<Part::Feature*>(selobjs[i].getObject());
if (!part) {
assert(0);
throw Base::ValueError("Unexpected null pointer in CmdSketcherMapSketch::activated");
}
std::vector<App::DocumentObject*> input = part->getOutListRecursive();
if (std::find(input.begin(), input.end(), sketch) != input.end()) {
throw ExceptionWrongInput(QT_TR_NOOP("Some of the selected objects depend on the sketch to be mapped. "
"Circular dependencies are not allowed."));
}
}
//Ask for a new mode.
//outline:
// * find out the modes that are compatible with selection.
// * Test if current mode is OK.
// * fill in the dialog
// * execute the dialog
// * collect dialog result
// * action
bool bAttach = true;
bool bCurIncompatible = false;
// * find out the modes that are compatible with selection.
eMapMode curMapMode = eMapMode(sketch->MapMode.getValue());
// * Test if current mode is OK.
if (std::find(validModes.begin(), validModes.end(), curMapMode) == validModes.end())
bCurIncompatible = true;
// * fill in the dialog
validModes.insert(validModes.begin(), Attacher::mmDeactivated);
if(bCurIncompatible)
validModes.push_back(curMapMode);
//bool ok; //already defined
//QStringList items; //already defined
items.clear();
items.push_back(QObject::tr("Don't attach"));
int iSugg = 0; //index of the auto-suggested mode in the list of valid modes
int iCurr = 0; //index of current mode in the list of valid modes
for (size_t i = 0; i < validModes.size(); ++i) {
items.push_back(QString::fromLatin1(AttachEngine::getModeName(validModes[i]).c_str()));
if (validModes[i] == curMapMode) {
iCurr = items.size() - 1;
items.back().append(bCurIncompatible?
qApp->translate("Sketcher_MapSketch", " (incompatible with selection)")
:
qApp->translate("Sketcher_MapSketch", " (current)"));
}
if (validModes[i] == suggMapMode) {
iSugg = items.size() - 1;
if(iSugg == 1) {
iSugg = 0; // redirect deactivate to detach
} else {
items.back().append(qApp->translate("Sketcher_MapSketch", " (suggested)"));
}
}
}
// * execute the dialog
text = QInputDialog::getItem(Gui::getMainWindow(),
qApp->translate("Sketcher_MapSketch", "Sketch attachment"),
bCurIncompatible ?
qApp->translate("Sketcher_MapSketch",
"Current attachment mode is incompatible with the new selection.\n"
"Select the method to attach this sketch to selected objects.")
:
qApp->translate("Sketcher_MapSketch",
"Select the method to attach this sketch to selected objects."),
items,
bCurIncompatible ? iSugg : iCurr,
false,
&ok,
Qt::MSWindowsFixedSizeDialogHint);
// * collect dialog result
if (!ok)
return;
index = items.indexOf(text);
if (index == 0) {
bAttach = false;
suggMapMode = Attacher::mmDeactivated;
} else {
bAttach = true;
suggMapMode = validModes[index-1];
}
// * action
if (bAttach) {
App::PropertyLinkSubList support;
Gui::Selection().getAsPropertyLinkSubList(support);
std::string supportString = support.getPyReprString();
openCommand(QT_TRANSLATE_NOOP("Command", "Attach sketch"));
Gui::cmdAppObjectArgs(sketch, "MapMode = \"%s\"",AttachEngine::getModeName(suggMapMode).c_str());
Gui::cmdAppObjectArgs(sketch, "Support = %s",supportString.c_str());
commitCommand();
doCommand(Gui,"App.activeDocument().recompute()");
} else {
openCommand(QT_TRANSLATE_NOOP("Command", "Detach sketch"));
Gui::cmdAppObjectArgs(sketch, "MapMode = \"%s\"",AttachEngine::getModeName(suggMapMode).c_str());
Gui::cmdAppObjectArgs(sketch, "Support = None");
commitCommand();
doCommand(Gui,"App.activeDocument().recompute()");
}
} catch (ExceptionWrongInput &e) {
QMessageBox::warning(Gui::getMainWindow(),
qApp->translate("Sketcher_MapSketch", "Map sketch"),
qApp->translate("Sketcher_MapSketch",
"Can't map a sketch to support:\n"
"%1").arg(e.ErrMsg.length() ? e.ErrMsg : msg_str));
}
}
bool CmdSketcherMapSketch::isActive()
{
App::Document* doc = App::GetApplication().getActiveDocument();
Base::Type sketch_type = Base::Type::fromName("Sketcher::SketchObject");
std::vector<Gui::SelectionObject> selobjs = Gui::Selection().getSelectionEx();
if (doc && doc->countObjectsOfType(sketch_type) > 0 && !selobjs.empty())
return true;
return false;
}
DEF_STD_CMD_A(CmdSketcherViewSketch)
CmdSketcherViewSketch::CmdSketcherViewSketch()
: Command("Sketcher_ViewSketch")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("View sketch");
sToolTipText = QT_TR_NOOP("When in edit mode, "
"set the camera orientation perpendicular to the sketch plane.");
sWhatsThis = "Sketcher_ViewSketch";
sStatusTip = sToolTipText;
sPixmap = "Sketcher_ViewSketch";
sAccel = "Q, P";
eType = 0;
}
void CmdSketcherViewSketch::activated(int iMsg)
{
Q_UNUSED(iMsg);
Gui::Document *doc = getActiveGuiDocument();
SketcherGui::ViewProviderSketch* vp = dynamic_cast<SketcherGui::ViewProviderSketch*>(doc->getInEdit());
if (vp) {
runCommand(Gui,"Gui.ActiveDocument.ActiveView.setCameraOrientation("
"App.Placement(Gui.editDocument().EditingTransform).Rotation.Q)");
}
}
bool CmdSketcherViewSketch::isActive()
{
return isSketchInEdit(getActiveGuiDocument());
}
DEF_STD_CMD_A(CmdSketcherValidateSketch)
CmdSketcherValidateSketch::CmdSketcherValidateSketch()
: Command("Sketcher_ValidateSketch")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("Validate sketch...");
sToolTipText = QT_TR_NOOP("Validate a sketch by looking at missing coincidences,\n"
"invalid constraints, degenerated geometry, etc.");
sWhatsThis = "Sketcher_ValidateSketch";
sStatusTip = sToolTipText;
eType = 0;
sPixmap = "Sketcher_ValidateSketch";
}
void CmdSketcherValidateSketch::activated(int iMsg)
{
Q_UNUSED(iMsg);
std::vector<Gui::SelectionObject> selection = getSelection().getSelectionEx(nullptr, Sketcher::SketchObject::getClassTypeId());
if (selection.size() != 1) {
QMessageBox::warning(Gui::getMainWindow(),
qApp->translate("CmdSketcherValidateSketch", "Wrong selection"),
qApp->translate("CmdSketcherValidateSketch", "Select only one sketch."));
return;
}
Sketcher::SketchObject* Obj = static_cast<Sketcher::SketchObject*>(selection[0].getObject());
Gui::Control().showDialog(new TaskSketcherValidation(Obj));
}
bool CmdSketcherValidateSketch::isActive()
{
if (Gui::Control().activeDialog())
return false;
return Gui::Selection().countObjectsOfType(Sketcher::SketchObject::getClassTypeId()) == 1;
}
DEF_STD_CMD_A(CmdSketcherMirrorSketch)
CmdSketcherMirrorSketch::CmdSketcherMirrorSketch()
: Command("Sketcher_MirrorSketch")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("Mirror sketch");
sToolTipText = QT_TR_NOOP("Create a new mirrored sketch for each selected sketch\n"
"by using the X or Y axes, or the origin point,\n"
"as mirroring reference.");
sWhatsThis = "Sketcher_MirrorSketch";
sStatusTip = sToolTipText;
eType = 0;
sPixmap = "Sketcher_MirrorSketch";
}
void CmdSketcherMirrorSketch::activated(int iMsg)
{
Q_UNUSED(iMsg);
std::vector<Gui::SelectionObject> selection = getSelection().getSelectionEx(nullptr, Sketcher::SketchObject::getClassTypeId());
if (selection.empty()) {
QMessageBox::warning(Gui::getMainWindow(),
qApp->translate("CmdSketcherMirrorSketch", "Wrong selection"),
qApp->translate("CmdSketcherMirrorSketch", "Select one or more sketches."));
return;
}
int refgeoid = -1;
Sketcher::PointPos refposid = Sketcher::PointPos::none;
// Ask the user the type of mirroring
SketchMirrorDialog smd;
if (smd.exec() != QDialog::Accepted)
return;
refgeoid = smd.RefGeoid;
refposid = smd.RefPosid;
App::Document* doc = App::GetApplication().getActiveDocument();
openCommand(QT_TRANSLATE_NOOP("Command", "Create a mirrored sketch for each selected sketch"));
for (std::vector<Gui::SelectionObject>::const_iterator it=selection.begin(); it != selection.end(); ++it) {
// create Sketch
std::string FeatName = getUniqueObjectName("MirroredSketch");
doCommand(Doc,"App.activeDocument().addObject('Sketcher::SketchObject', '%s')", FeatName.c_str());
Sketcher::SketchObject* mirrorsketch = static_cast<Sketcher::SketchObject*>(doc->getObject(FeatName.c_str()));
const Sketcher::SketchObject* Obj = static_cast<const Sketcher::SketchObject*>((*it).getObject());
Base::Placement pl = Obj->Placement.getValue();
Base::Vector3d p = pl.getPosition();
Base::Rotation r = pl.getRotation();
doCommand(Doc,
"App.activeDocument().%s.Placement = App.Placement(App.Vector(%f, %f, %f), App.Rotation(%f, %f, %f, %f))",
FeatName.c_str(),
p.x, p.y, p.z, r[0], r[1], r[2], r[3]);
Sketcher::SketchObject* tempsketch = new Sketcher::SketchObject();
int addedGeometries = tempsketch->addGeometry(Obj->getInternalGeometry());
int addedConstraints = tempsketch->addConstraints(Obj->Constraints.getValues());
std::vector<int> geoIdList;
for (int i=0; i<=addedGeometries; i++)
geoIdList.push_back(i);
tempsketch->addSymmetric(geoIdList, refgeoid, refposid);
std::vector<Part::Geometry *> tempgeo = tempsketch->getInternalGeometry();
std::vector<Sketcher::Constraint *> tempconstr = tempsketch->Constraints.getValues();
// If value of addedGeometries or addedConstraints is -1, it gets added to vector begin iterator and that is invalid
std::vector<Part::Geometry *> mirrorgeo(tempgeo.begin() + (addedGeometries + 1), tempgeo.end());
std::vector<Sketcher::Constraint *> mirrorconstr(tempconstr.begin() + (addedConstraints + 1), tempconstr.end());
for (std::vector<Sketcher::Constraint *>::const_iterator itc=mirrorconstr.begin(); itc != mirrorconstr.end(); ++itc) {
if ((*itc)->First != Sketcher::GeoEnum::GeoUndef
|| (*itc)->First == Sketcher::GeoEnum::HAxis
|| (*itc)->First == Sketcher::GeoEnum::VAxis)
// not x, y axes or origin
(*itc)->First -= (addedGeometries + 1);
if ((*itc)->Second != Sketcher::GeoEnum::GeoUndef
|| (*itc)->Second == Sketcher::GeoEnum::HAxis
|| (*itc)->Second == Sketcher::GeoEnum::VAxis)
// not x, y axes or origin
(*itc)->Second -= (addedGeometries + 1);
if ((*itc)->Third != Sketcher::GeoEnum::GeoUndef
|| (*itc)->Third == Sketcher::GeoEnum::HAxis
|| (*itc)->Third == Sketcher::GeoEnum::VAxis)
// not x, y axes or origin
(*itc)->Third -= (addedGeometries + 1);
}
mirrorsketch->addGeometry(mirrorgeo);
mirrorsketch->addConstraints(mirrorconstr);
delete tempsketch;
}
doCommand(Gui,"App.activeDocument().recompute()");
}
bool CmdSketcherMirrorSketch::isActive()
{
return Gui::Selection().countObjectsOfType(Sketcher::SketchObject::getClassTypeId()) > 0;
}
DEF_STD_CMD_A(CmdSketcherMergeSketches)
CmdSketcherMergeSketches::CmdSketcherMergeSketches()
: Command("Sketcher_MergeSketches")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("Merge sketches");
sToolTipText = QT_TR_NOOP("Create a new sketch from merging two or more selected sketches.");
sWhatsThis = "Sketcher_MergeSketches";
sStatusTip = sToolTipText;
eType = 0;
sPixmap = "Sketcher_MergeSketch";
}
void CmdSketcherMergeSketches::activated(int iMsg)
{
Q_UNUSED(iMsg);
std::vector<Gui::SelectionObject> selection = getSelection().getSelectionEx(nullptr, Sketcher::SketchObject::getClassTypeId());
if (selection.size() < 2) {
QMessageBox::warning(Gui::getMainWindow(),
qApp->translate("CmdSketcherMergeSketches", "Wrong selection"),
qApp->translate("CmdSketcherMergeSketches", "Select at least two sketches."));
return;
}
App::Document* doc = App::GetApplication().getActiveDocument();
// create Sketch
std::string FeatName = getUniqueObjectName("Sketch");
openCommand(QT_TRANSLATE_NOOP("Command", "Merge sketches"));
doCommand(Doc,"App.activeDocument().addObject('Sketcher::SketchObject', '%s')", FeatName.c_str());
Sketcher::SketchObject* mergesketch = static_cast<Sketcher::SketchObject*>(doc->getObject(FeatName.c_str()));
int baseGeometry = 0;
int baseConstraints = 0;
for (std::vector<Gui::SelectionObject>::const_iterator it=selection.begin(); it != selection.end(); ++it) {
const Sketcher::SketchObject* Obj = static_cast<const Sketcher::SketchObject*>((*it).getObject());
int addedGeometries=mergesketch->addGeometry(Obj->getInternalGeometry());
int addedConstraints=mergesketch->addCopyOfConstraints(*Obj);
for (int i=0; i<=(addedConstraints-baseConstraints); i++){
Sketcher::Constraint * constraint= mergesketch->Constraints.getValues()[i+baseConstraints];
if (constraint->First != Sketcher::GeoEnum::GeoUndef &&
constraint->First != Sketcher::GeoEnum::HAxis &&
constraint->First != Sketcher::GeoEnum::VAxis)
// not x, y axes or origin
constraint->First += baseGeometry;
if (constraint->Second != Sketcher::GeoEnum::GeoUndef &&
constraint->Second != Sketcher::GeoEnum::HAxis &&
constraint->Second != Sketcher::GeoEnum::VAxis)
// not x, y axes or origin
constraint->Second += baseGeometry;
if (constraint->Third != Sketcher::GeoEnum::GeoUndef &&
constraint->Third != Sketcher::GeoEnum::HAxis &&
constraint->Third != Sketcher::GeoEnum::VAxis)
// not x, y axes or origin
constraint->Third += baseGeometry;
}
baseGeometry=addedGeometries+1;
baseConstraints=addedConstraints+1;
}
// apply the placement of the first sketch in the list (#0002434)
doCommand(Doc,
"App.activeDocument().ActiveObject.Placement = App.activeDocument().%s.Placement",
selection.front().getFeatName());
doCommand(Doc, "App.activeDocument().recompute()");
}
bool CmdSketcherMergeSketches::isActive()
{
return Gui::Selection().countObjectsOfType(Sketcher::SketchObject::getClassTypeId()) > 1;
}
// Acknowledgement of idea and original python macro goes to SpritKopf:
// https://github.com/Spritkopf/freecad-macros/blob/master/clip-sketch/clip_sketch.FCMacro
// https://forum.freecadweb.org/viewtopic.php?p=231481#p231085
DEF_STD_CMD_A(CmdSketcherViewSection)
CmdSketcherViewSection::CmdSketcherViewSection()
: Command("Sketcher_ViewSection")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("View section");
sToolTipText = QT_TR_NOOP("When in edit mode, "
"switch between section view and full view.");
sWhatsThis = "Sketcher_ViewSection";
sStatusTip = sToolTipText;
sPixmap = "Sketcher_ViewSection";
sAccel = "Q, S";
eType = 0;
}
void CmdSketcherViewSection::activated(int iMsg)
{
Q_UNUSED(iMsg);
QString cmdStr = QLatin1String("ActiveSketch.ViewObject.TempoVis.sketchClipPlane(ActiveSketch, None, %1)\n");
Gui::Document *doc = getActiveGuiDocument();
bool revert = false;
if(doc) {
SketcherGui::ViewProviderSketch* vp = dynamic_cast<SketcherGui::ViewProviderSketch*>(doc->getInEdit());
if (vp) {
revert = vp->getViewOrientationFactor() < 0?true:false;
}
}
cmdStr = cmdStr.arg(revert?QLatin1String("True"):QLatin1String("False"));
doCommand(Doc, cmdStr.toLatin1());
}
bool CmdSketcherViewSection::isActive()
{
return isSketchInEdit(getActiveGuiDocument());
}
/* Grid tool */
class GridSpaceAction : public QWidgetAction
{
public:
GridSpaceAction(QObject* parent) : QWidgetAction(parent) {
}
void updateWidget() {
auto* sketchView = getView();
if(sketchView) {
auto updateCheckBox = [this](QCheckBox * checkbox, App::PropertyBool & property) {
auto checked = checkbox->checkState() == Qt::Checked;
auto propvalue = property.getValue();
if( propvalue != checked ) {
checkbox->blockSignals(true);
checkbox->setChecked(propvalue);
checkbox->blockSignals(false);
}
};
updateCheckBox(gridSnap, sketchView->GridSnap);
updateCheckBox(gridAutoSpacing, sketchView->GridAuto);
auto autospacing = gridAutoSpacing->checkState() == Qt::Checked;
gridSizeBox->setEnabled(!autospacing);
gridSizeBox->setValue(sketchView->GridSize.getValue());
}
}
protected:
QWidget* createWidget(QWidget* parent) override
{
gridSnap = new QCheckBox(QApplication::translate("GridSpaceAction", "Grid Snap"));
gridSnap->setToolTip(QApplication::translate("CmdSketcherCompGrid", "New points will snap to the nearest grid line.\nPoints must be set closer than a fifth of the grid spacing to a grid line to snap."));
gridSnap->setStatusTip(gridSnap->toolTip());
gridAutoSpacing = new QCheckBox(QApplication::translate("GridSpaceAction", "Grid Auto Spacing"));
gridAutoSpacing->setToolTip(QApplication::translate("CmdSketcherCompGrid", "Resize grid automatically depending on zoom."));
gridAutoSpacing->setStatusTip(gridAutoSpacing->toolTip());
auto* sizeLabel = new QLabel(QApplication::translate("GridSpaceAction", "Spacing"));
gridSizeBox = new Gui::QuantitySpinBox();
gridSizeBox->setProperty("unit", QVariant(QStringLiteral("mm")));
gridSizeBox->setObjectName(QStringLiteral("gridSize"));
gridSizeBox->setToolTip(QApplication::translate("GridSpaceAction", "Distance between two subsequent grid lines"));
gridSizeBox->setMaximum(99999999.0);
gridSizeBox->setMinimum(0.001);
QWidget* gridSizeW = new QWidget(parent);
auto* layout = new QGridLayout(gridSizeW);
layout->addWidget(gridSnap, 0, 0);
layout->addWidget(gridAutoSpacing, 1, 0);
layout->addWidget(sizeLabel, 2, 0);
layout->addWidget(gridSizeBox, 2, 1);
QObject::connect(gridSnap,&QCheckBox::stateChanged, [this](int state) {
auto* sketchView = getView();
if(sketchView) {
sketchView->GridSnap.setValue(state == Qt::Checked);
}
});
QObject::connect(gridAutoSpacing,&QCheckBox::stateChanged, [this](int state) {
auto* sketchView = getView();
if(sketchView) {
auto enable = (state == Qt::Checked);
sketchView->GridAuto.setValue(enable);
gridSizeBox->setEnabled(!enable);
}
});
QObject::connect(gridSizeBox, qOverload<double>(&Gui::QuantitySpinBox::valueChanged), [this](double val) {
auto* sketchView = getView();
if(sketchView) {
sketchView->GridSize.setValue(val);
}
});
return gridSizeW;
}
private:
ViewProviderSketch * getView() {
Gui::Document* doc = Gui::Application::Instance->activeDocument();
if(doc) {
return dynamic_cast<SketcherGui::ViewProviderSketch*>(doc->getInEdit());
}
return nullptr;
}
private:
QCheckBox * gridSnap;
QCheckBox * gridAutoSpacing;
Gui::QuantitySpinBox * gridSizeBox;
};
class CmdSketcherGrid : public Gui::Command
{
public:
CmdSketcherGrid();
virtual ~CmdSketcherGrid(){}
virtual const char* className() const
{ return "CmdSketcherGrid"; }
protected:
virtual void activated(int iMsg);
virtual bool isActive(void);
virtual Gui::Action * createAction(void);
private:
void updateIcon(bool value);
void updateInactiveHandlerIcon();
CmdSketcherGrid(const CmdSketcherGrid&) = delete;
CmdSketcherGrid(CmdSketcherGrid&&) = delete;
CmdSketcherGrid& operator= (const CmdSketcherGrid&) = delete;
CmdSketcherGrid& operator= (CmdSketcherGrid&&) = delete;
};
CmdSketcherGrid::CmdSketcherGrid()
: Command("Sketcher_Grid")
{
sAppModule = "Sketcher";
sGroup = "Sketcher";
sMenuText = QT_TR_NOOP("Activate Grid");
sToolTipText = QT_TR_NOOP("Activate grid and grid settings");
sWhatsThis = "Sketcher_Grid";
sStatusTip = sToolTipText;
eType = 0;
}
void CmdSketcherGrid::updateIcon(bool value)
{
static QIcon active = Gui::BitmapFactory().iconFromTheme("Sketcher_GridToggle");
static QIcon inactive = Gui::BitmapFactory().iconFromTheme("Sketcher_GridToggle_Deactivated");
auto * pcAction = qobject_cast<Gui::ActionGroup*>(getAction());
pcAction->setIcon(value ? active : inactive);
}
void CmdSketcherGrid::updateInactiveHandlerIcon()
{
auto * vp = getInactiveHandlerEditModeSketchViewProvider();
if(vp) {
auto value = vp->ShowGrid.getValue();
updateIcon(value);
}
}
void CmdSketcherGrid::activated(int iMsg)
{
Q_UNUSED(iMsg);
Gui::Document* doc = getActiveGuiDocument();
assert(doc);
auto* sketchView = dynamic_cast<SketcherGui::ViewProviderSketch*>(doc->getInEdit());
assert(sketchView);
auto value = sketchView->ShowGrid.getValue();
sketchView->ShowGrid.setValue(!value);
updateIcon(!value);
}
Gui::Action* CmdSketcherGrid::createAction()
{
auto * pcAction = new Gui::ActionGroup(this, Gui::getMainWindow());
pcAction->setDropDownMenu(true);
pcAction->setExclusive(false);
applyCommandData(this->className(), pcAction);
GridSpaceAction* gsa = new GridSpaceAction(pcAction);
pcAction->addAction(gsa);
_pcAction = pcAction;
QObject::connect(pcAction, &Gui::ActionGroup::aboutToShow, [gsa](QMenu * menu) {
Q_UNUSED(menu)
gsa->updateWidget();
});
languageChange();
// set the right pixmap
updateInactiveHandlerIcon();
return pcAction;
}
bool CmdSketcherGrid::isActive()
{
auto * vp = getInactiveHandlerEditModeSketchViewProvider();
if (vp) {
auto value = vp->ShowGrid.getValue();
updateIcon(value);
return true;
}
return false;
}
void CreateSketcherCommands()
{
Gui::CommandManager &rcCmdMgr = Gui::Application::Instance->commandManager();
rcCmdMgr.addCommand(new CmdSketcherNewSketch());
rcCmdMgr.addCommand(new CmdSketcherEditSketch());
rcCmdMgr.addCommand(new CmdSketcherLeaveSketch());
rcCmdMgr.addCommand(new CmdSketcherStopOperation());
rcCmdMgr.addCommand(new CmdSketcherReorientSketch());
rcCmdMgr.addCommand(new CmdSketcherMapSketch());
rcCmdMgr.addCommand(new CmdSketcherViewSketch());
rcCmdMgr.addCommand(new CmdSketcherValidateSketch());
rcCmdMgr.addCommand(new CmdSketcherMirrorSketch());
rcCmdMgr.addCommand(new CmdSketcherMergeSketches());
rcCmdMgr.addCommand(new CmdSketcherViewSection());
rcCmdMgr.addCommand(new CmdSketcherGrid());
}