1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: XGUI_OperationMgr.cpp
4 // Created: 20 Apr 2014
5 // Author: Natalia ERMOLAEVA
7 #include "XGUI_OperationMgr.h"
8 #include "XGUI_ModuleConnector.h"
9 #include "XGUI_Workshop.h"
10 #include "XGUI_ErrorMgr.h"
11 #include "XGUI_Tools.h"
12 #include "XGUI_ObjectsBrowser.h"
13 #include "XGUI_ContextMenuMgr.h"
15 #include <ModuleBase_IPropertyPanel.h>
16 #include <ModuleBase_ModelWidget.h>
17 #include "ModuleBase_Operation.h"
18 #include "ModuleBase_IWorkshop.h"
19 #include "ModuleBase_IModule.h"
20 #include <ModuleBase_IViewer.h>
21 #include "ModuleBase_OperationDescription.h"
22 #include "ModuleBase_OperationFeature.h"
23 #include "ModuleBase_Tools.h"
25 #include "ModelAPI_CompositeFeature.h"
26 #include "ModelAPI_Session.h"
28 #include <XGUI_PropertyPanel.h>
29 #include <QToolButton>
31 #include <QMessageBox>
32 #include <QApplication>
35 //#define DEBUG_CURRENT_FEATURE
37 /// Processes "Delete" key event of application. This key is used by several application actions.
38 /// There is a logical order of the actions processing. So the key can not be set for actions
39 /// as a shortcut. The class listens the key event and call operation manager processor.
40 class XGUI_ShortCutListener : public QObject
44 /// \param theParent the parent to be deleted when the parent is deleted
45 /// \param theOperationMgr the class to perform deletion
46 XGUI_ShortCutListener(QObject* theParent, XGUI_OperationMgr* theOperationMgr)
47 : QObject(theParent), myOperationMgr(theOperationMgr)
49 qApp->installEventFilter(this);
51 ~XGUI_ShortCutListener() {}
53 /// Switch on short cut listener
54 void setActive(const bool theIsActive) { myIsActive = theIsActive; }
56 /// Redefinition of virtual function to process Delete key release
57 virtual bool eventFilter(QObject *theObject, QEvent *theEvent)
59 bool isAccepted = false;
60 if (myIsActive && theEvent->type() == QEvent::KeyRelease) {
61 QKeyEvent* aKeyEvent = dynamic_cast<QKeyEvent*>(theEvent);
63 switch (aKeyEvent->key()) {
64 case Qt::Key_Delete: {
65 isAccepted = myOperationMgr->onProcessDelete(theObject);
71 isAccepted = QObject::eventFilter(theObject, theEvent);
76 XGUI_OperationMgr* myOperationMgr; /// processor for key event
77 bool myIsActive; /// boolean state whether the event filter perform own signal processing
80 XGUI_OperationMgr::XGUI_OperationMgr(QObject* theParent,
81 ModuleBase_IWorkshop* theWorkshop)
82 : QObject(theParent), myWorkshop(theWorkshop)
84 /// we need to install filter to the application in order to react to 'Delete' key button
85 /// this key can not be a short cut for a corresponded action because we need to set
86 /// the actions priority
87 myShortCutListener = new XGUI_ShortCutListener(theParent, this);
90 XGUI_OperationMgr::~XGUI_OperationMgr()
94 void XGUI_OperationMgr::activate()
96 myShortCutListener->setActive(true);
99 void XGUI_OperationMgr::deactivate()
101 myShortCutListener->setActive(false);
104 ModuleBase_Operation* XGUI_OperationMgr::currentOperation() const
106 return myOperations.count() > 0 ? myOperations.last() : 0;
109 bool XGUI_OperationMgr::isCurrentOperation(ModuleBase_Operation* theOperation)
113 return currentOperation() == theOperation;
116 bool XGUI_OperationMgr::hasOperation() const
118 return !myOperations.isEmpty() && (myOperations.last() != NULL);
121 bool XGUI_OperationMgr::hasOperation(const QString& theId) const
123 foreach(ModuleBase_Operation* aOp, myOperations) {
124 if (aOp->id() == theId)
130 ModuleBase_Operation* XGUI_OperationMgr::findOperation(const QString& theId) const
132 foreach(ModuleBase_Operation* aOp, myOperations) {
133 if (aOp->id() == theId)
140 int XGUI_OperationMgr::operationsCount() const
142 return myOperations.count();
145 QStringList XGUI_OperationMgr::operationList() const
148 foreach(ModuleBase_Operation* eachOperation, myOperations) {
149 ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>(eachOperation);
151 FeaturePtr aFeature = aFOperation->feature();
153 result << QString::fromStdString(aFeature->getKind());
160 ModuleBase_Operation* XGUI_OperationMgr::previousOperation(ModuleBase_Operation* theOperation) const
162 int idx = myOperations.lastIndexOf(theOperation);
163 if(idx == -1 || idx == 0) {
166 return myOperations.at(idx - 1);
169 bool XGUI_OperationMgr::eventFilter(QObject *theObject, QEvent *theEvent)
171 bool isAccepted = false;
172 if (theEvent->type() == QEvent::KeyRelease) {
173 QKeyEvent* aKeyEvent = dynamic_cast<QKeyEvent*>(theEvent);
175 isAccepted = onKeyReleased(theObject, aKeyEvent);
178 isAccepted = QObject::eventFilter(theObject, theEvent);
183 bool XGUI_OperationMgr::startOperation(ModuleBase_Operation* theOperation)
186 currentOperation()->postpone();
187 myOperations.append(theOperation);
189 connect(theOperation, SIGNAL(beforeStarted()), SLOT(onBeforeOperationStarted()));
190 connect(theOperation, SIGNAL(beforeAborted()), SLOT(onBeforeOperationAborted()));
191 connect(theOperation, SIGNAL(beforeCommitted()), SLOT(onBeforeOperationCommitted()));
193 connect(theOperation, SIGNAL(started()), SLOT(onOperationStarted()));
194 connect(theOperation, SIGNAL(aborted()), SLOT(onOperationAborted()));
195 connect(theOperation, SIGNAL(committed()), SLOT(onOperationCommitted()));
197 connect(theOperation, SIGNAL(stopped()), SLOT(onOperationStopped()));
198 connect(theOperation, SIGNAL(resumed()), SLOT(onOperationResumed()));
200 bool isStarted = theOperation->start();
202 onValidateOperation();
206 bool XGUI_OperationMgr::abortAllOperations()
212 if (operationsCount() == 1) {
213 ModuleBase_Operation* aCurrentOperation = currentOperation();
214 if (canStopOperation(aCurrentOperation)) {
215 abortOperation(aCurrentOperation);
221 aResult = QMessageBox::question(qApp->activeWindow(),
222 tr("Abort operation"),
223 tr("All active operations will be aborted."),
224 QMessageBox::Ok | QMessageBox::Cancel,
225 QMessageBox::Cancel) == QMessageBox::Ok;
226 while(aResult && hasOperation()) {
227 abortOperation(currentOperation());
233 bool XGUI_OperationMgr::commitAllOperations()
235 bool isCompositeCommitted = false, anOperationProcessed = false;
236 while (hasOperation()) {
237 ModuleBase_Operation* anOperation = currentOperation();
238 if (XGUI_Tools::workshop(myWorkshop)->errorMgr()->isApplyEnabled()) {
239 anOperationProcessed = onCommitOperation();
241 abortOperation(anOperation);
242 anOperationProcessed = true;
244 ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
247 FeaturePtr aFeature = aFOperation->feature();
248 CompositeFeaturePtr aComposite =
249 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
250 isCompositeCommitted = aComposite.get();
251 if (isCompositeCommitted)
254 // not processed[committed] operation might be used in composite feature,
255 // so the while will be stopped by the previous check.
256 // this code is not necessary, but logically should be done when the processing will not
257 // be done for not composite feature by some reasons
258 if (!anOperationProcessed)
264 void XGUI_OperationMgr::onValidateOperation()
268 ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
269 (currentOperation());
270 if(aFOperation && aFOperation->feature().get())
271 XGUI_Tools::workshop(myWorkshop)->errorMgr()->updateActions(aFOperation->feature());
274 void XGUI_OperationMgr::updateApplyOfOperations(ModuleBase_Operation* theOperation)
276 XGUI_ErrorMgr* anErrorMgr = XGUI_Tools::workshop(myWorkshop)->errorMgr();
278 ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>(theOperation);
280 anErrorMgr->updateAcceptAllAction(aFOperation->feature());
283 foreach(ModuleBase_Operation* anOperation, myOperations) {
285 updateApplyOfOperations(anOperation);
288 // Apply button of the current operation should also be updated
289 onValidateOperation();
292 bool XGUI_OperationMgr::canStopOperation(ModuleBase_Operation* theOperation)
294 //in case of nested (sketch) operation no confirmation needed
295 if (isGrantedOperation(theOperation->id()))
297 if (theOperation && theOperation->isModified()) {
298 QString aMessage = tr("%1 operation will be aborted.").arg(theOperation->id());
299 int anAnswer = QMessageBox::question(qApp->activeWindow(),
300 tr("Abort operation"),
302 QMessageBox::Ok | QMessageBox::Cancel,
303 QMessageBox::Cancel);
304 return anAnswer == QMessageBox::Ok;
309 bool XGUI_OperationMgr::commitOperation()
311 //if (hasOperation() && currentOperation()->isValid()) {
312 // onCommitOperation();
316 return onCommitOperation();
319 void XGUI_OperationMgr::resumeOperation(ModuleBase_Operation* theOperation)
321 theOperation->resume();
324 bool XGUI_OperationMgr::isGrantedOperation(const QString& theId)
326 bool isGranted = false;
328 QListIterator<ModuleBase_Operation*> anIt(myOperations);
330 ModuleBase_Operation* aPreviousOperation = 0;
331 while (anIt.hasPrevious() && !isGranted) {
332 ModuleBase_Operation* anOp = anIt.previous();
334 isGranted = anOp->isGranted(theId);
339 void XGUI_OperationMgr::setCurrentFeature(const FeaturePtr& theFeature)
341 SessionPtr aMgr = ModelAPI_Session::get();
342 DocumentPtr aDoc = aMgr->activeDocument();
343 bool aIsOp = aMgr->isOperation();
345 aMgr->startOperation(QString("Set current feature: %1").arg(theFeature->getKind().c_str()).toStdString());
346 aDoc->setCurrentFeature(theFeature, false);
348 aMgr->finishOperation();
351 bool XGUI_OperationMgr::canStartOperation(const QString& theId)
353 bool aCanStart = true;
354 ModuleBase_Operation* aCurrentOp = currentOperation();
356 bool aGranted = aCurrentOp->isGranted(theId);
357 // the started operation is granted for the current one,
358 // e.g. current - Sketch, started - Line
363 if (!isGrantedOperation(theId)) {
364 // the operation is not granted in the current list of operations
365 // e.g. Edit Parameter when Sketch, Line in Sketch is active.
366 aCanStart = abortAllOperations();
368 else if (canStopOperation(aCurrentOp)) {
369 // the started operation is granted in the parrent operation,
370 // e.g. current - Line in Sketch, started Circle
371 if (XGUI_Tools::workshop(myWorkshop)->errorMgr()->isApplyEnabled() && aCurrentOp->isModified())
372 aCurrentOp->commit();
374 abortOperation(aCurrentOp);
383 void XGUI_OperationMgr::abortOperation(ModuleBase_Operation* theOperation)
385 ModuleBase_Operation* aCurrentOperation = currentOperation();
386 if (theOperation == aCurrentOperation)
387 theOperation->abort();
389 // it is possible to trigger upper operation(e.g. sketch, current is sketch line)
390 // all operation from the current to triggered should also be aborted
391 // operations over the parameter one are not aborted(e.g. extrusion cut, sketch abort)
392 while(hasOperation()) {
393 ModuleBase_Operation* aCurrentOperation = currentOperation();
394 aCurrentOperation->abort();
395 if(theOperation == aCurrentOperation)
401 bool XGUI_OperationMgr::onCommitOperation()
403 bool isCommitted = false;
404 ModuleBase_Operation* anOperation = currentOperation();
405 if (anOperation && myWorkshop->module()->canCommitOperation())
406 isCommitted = anOperation->commit();
410 void XGUI_OperationMgr::onAbortOperation()
412 ModuleBase_Operation* aCurrentOperation = currentOperation();
413 if (aCurrentOperation && canStopOperation(aCurrentOperation)) {
414 abortOperation(aCurrentOperation);
418 void XGUI_OperationMgr::onBeforeOperationStarted()
420 ModuleBase_Operation* aCurrentOperation = dynamic_cast<ModuleBase_Operation*>(sender());
421 if (!aCurrentOperation)
424 /// Set current feature and remeber old current feature
425 ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>(aCurrentOperation);
427 SessionPtr aMgr = ModelAPI_Session::get();
428 DocumentPtr aDoc = aMgr->activeDocument();
429 // the parameter of current feature should be false, we should use all feature, not only visible
430 // in order to correctly save the previous feature of the nested operation, where the
431 // features can be not visible in the tree. The problem case is Edit sketch entitity(line)
432 // in the Sketch, created in ExtrusionCut operation. The entity disappears by commit.
433 // When sketch entity operation started, the sketch should be cashed here as the current.
434 // Otherwise(the flag is true), the ExtrusionCut is cashed, when commit happens, the sketch
435 // is disabled, sketch entity is disabled as extrusion cut is created earliest then sketch.
436 // As a result the sketch disappears from the viewer. However after commit it is displayed back.
437 aFOperation->setPreviousCurrentFeature(aDoc->currentFeature(false));
439 #ifdef DEBUG_CURRENT_FEATURE
440 FeaturePtr aFeature = aFOperation->feature();
441 QString aKind = aFeature ? aFeature->getKind().c_str() : "";
442 qDebug(QString("onBeforeOperationStarted(), edit operation = %1, feature = %2")
443 .arg(aFOperation->isEditOperation())
444 .arg(ModuleBase_Tools::objectInfo(aFeature)).toStdString().c_str());
446 qDebug(QString("\tdocument->currentFeature(false) = %1").arg(
447 ModuleBase_Tools::objectInfo(ModelAPI_Session::get()->activeDocument()->currentFeature(false))).toStdString().c_str());
450 if (aFOperation->isEditOperation()) {// it should be performed by the feature edit only
451 // in create operation, the current feature is changed by addFeature()
452 aDoc->setCurrentFeature(aFOperation->feature(), false);
453 // this is the only place where flushes must be called after setCurrentFeature for the current
454 // moment: after this the opertion is not finished, so, the ObjectBrowser state may be corrupted
456 static Events_Loop* aLoop = Events_Loop::loop();
457 static Events_ID aCreateEvent = aLoop->eventByName(EVENT_OBJECT_CREATED);
458 aLoop->flush(aCreateEvent);
459 static Events_ID aDeleteEvent = aLoop->eventByName(EVENT_OBJECT_DELETED);
460 aLoop->flush(aDeleteEvent);
463 #ifdef DEBUG_CURRENT_FEATURE
464 qDebug("\tdocument->setCurrentFeature");
465 qDebug(QString("\tdocument->currentFeature(false) = %1").arg(
466 ModuleBase_Tools::objectInfo(ModelAPI_Session::get()->activeDocument()->currentFeature(false))).toStdString().c_str());
468 ModuleBase_IModule* aModule = myWorkshop->module();
470 aModule->beforeOperationStarted(aFOperation);
474 void XGUI_OperationMgr::onOperationStarted()
476 ModuleBase_Operation* aSenderOperation = dynamic_cast<ModuleBase_Operation*>(sender());
477 updateApplyOfOperations(aSenderOperation);
478 emit operationStarted(aSenderOperation);
481 void XGUI_OperationMgr::onBeforeOperationAborted()
483 onBeforeOperationCommitted();
486 void XGUI_OperationMgr::onOperationAborted()
488 ModuleBase_Operation* aSenderOperation = dynamic_cast<ModuleBase_Operation*>(sender());
489 emit operationAborted(aSenderOperation);
492 void XGUI_OperationMgr::onBeforeOperationCommitted()
494 ModuleBase_Operation* aCurrentOperation = dynamic_cast<ModuleBase_Operation*>(sender());
495 if (!aCurrentOperation)
498 /// Restore the previous current feature
499 ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>(aCurrentOperation);
501 #ifdef DEBUG_CURRENT_FEATURE
502 QString aKind = aFOperation->feature()->getKind().c_str();
503 qDebug(QString("onBeforeOperationCommitted(), edit operation = %1, feature = %2")
504 .arg(aFOperation->isEditOperation())
505 .arg(ModuleBase_Tools::objectInfo(aFOperation->feature())).toStdString().c_str());
507 qDebug(QString("\tdocument->currentFeature(false) = %1").arg(
508 ModuleBase_Tools::objectInfo(ModelAPI_Session::get()->activeDocument()->currentFeature(false))).toStdString().c_str());
511 if (aFOperation->isEditOperation()) {
512 /// Restore the previous current feature
513 setCurrentFeature(aFOperation->previousCurrentFeature());
515 else { // create operation
516 // the Top created feature should stays the current. In nested operations, like Line in the Sketch or
517 // Sketch in ExtrusionCut, a previous feature should be restored on commit. It is performed here
518 // in order to perform it in the current transaction without opening a new one.
519 if (myOperations.front() != aFOperation)
520 setCurrentFeature(aFOperation->previousCurrentFeature());
522 #ifdef DEBUG_CURRENT_FEATURE
523 qDebug("\tdocument->setCurrentFeature");
524 qDebug(QString("\tdocument->currentFeature(false) = %1").arg(
525 ModuleBase_Tools::objectInfo(ModelAPI_Session::get()->activeDocument()->currentFeature(false))).toStdString().c_str());
527 ModuleBase_IModule* aModule = myWorkshop->module();
529 aModule->beforeOperationStopped(aFOperation);
533 void XGUI_OperationMgr::onOperationCommitted()
535 // apply state for all features from the stack of operations should be updated
536 updateApplyOfOperations();
538 ModuleBase_Operation* aSenderOperation = dynamic_cast<ModuleBase_Operation*>(sender());
539 emit operationCommitted(aSenderOperation);
542 void XGUI_OperationMgr::onOperationResumed()
544 ModuleBase_Operation* aSenderOperation = dynamic_cast<ModuleBase_Operation*>(sender());
545 emit operationResumed(aSenderOperation);
548 void XGUI_OperationMgr::onOperationStopped()
550 ModuleBase_Operation* aSenderOperation = dynamic_cast<ModuleBase_Operation*>(sender());
551 ModuleBase_Operation* aCurrentOperation = currentOperation();
552 if (!aSenderOperation || !aCurrentOperation || aSenderOperation != aCurrentOperation)
555 myOperations.removeAll(aCurrentOperation);
556 aCurrentOperation->deleteLater();
558 emit operationStopped(aCurrentOperation);
560 // get last operation which can be resumed
561 ModuleBase_Operation* aResultOp = 0;
562 QListIterator<ModuleBase_Operation*> anIt(myOperations);
564 while (anIt.hasPrevious()) {
565 ModuleBase_Operation* anOp = anIt.previous();
572 bool isModified = aCurrentOperation->isModified();
573 aResultOp->setIsModified(aResultOp->isModified() || isModified);
574 resumeOperation(aResultOp);
575 onValidateOperation();
579 bool XGUI_OperationMgr::onKeyReleased(QObject *theObject, QKeyEvent* theEvent)
581 // Let the manager decide what to do with the given key combination.
582 ModuleBase_Operation* anOperation = currentOperation();
583 bool isAccepted = false;
584 switch (theEvent->key()) {
586 case Qt::Key_Enter: {
587 isAccepted = onProcessEnter(theObject);
592 bool noModifiers = (theEvent->modifiers() == Qt::NoModifier);
594 ModuleBase_IViewer* aViewer = myWorkshop->viewer();
595 Handle(AIS_InteractiveContext) aContext = aViewer->AISContext();
596 if (!aContext.IsNull()) {
597 Handle(V3d_View) aView = aViewer->activeView();
598 if ((theEvent->key() == Qt::Key_N))
599 aContext->HilightNextDetected(aView);
600 else if ((theEvent->key() == Qt::Key_P))
601 aContext->HilightPreviousDetected(aView);
612 // anOperation->keyReleased(theEvent->key());
617 bool XGUI_OperationMgr::onProcessEnter(QObject* theObject)
619 bool isAccepted = false;
620 ModuleBase_Operation* aOperation = currentOperation();
621 // to avoid enter processing when operation has not been started yet
624 ModuleBase_IPropertyPanel* aPanel = aOperation->propertyPanel();
625 // only property panel enter is processed in order to do not process enter in application dialogs
626 bool isPPChild = isChildObject(theObject, aPanel);
630 ModuleBase_ModelWidget* anActiveWgt = aPanel->activeWidget();
631 bool isAborted = false;
633 QWidget* aFocusWidget = aPanel->focusWidget();
634 QToolButton* aCancelBtn = dynamic_cast<XGUI_PropertyPanel*>(aPanel)->findButton(PROP_PANEL_CANCEL);
635 if (aFocusWidget && aCancelBtn && aFocusWidget == aCancelBtn) {
636 abortOperation(aOperation);
642 isAccepted = anActiveWgt && anActiveWgt->processEnter();
644 isAccepted = myWorkshop->module()->processEnter(anActiveWgt ? anActiveWgt->attributeID() : "");
646 /// functionality is similar to Apply click
647 ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>(currentOperation());
648 if (!aFOperation || myWorkshop->module()->getFeatureError(aFOperation->feature()).isEmpty()) {
649 // key released is emitted to apply the current value to the model if it was modified in PP
650 emit keyEnterReleased();
662 bool XGUI_OperationMgr::onProcessDelete(QObject* theObject)
664 bool isAccepted = false;
665 ModuleBase_Operation* aOperation = currentOperation();
666 ModuleBase_ModelWidget* anActiveWgt = 0;
667 // firstly the widget should process Delete action
668 ModuleBase_IPropertyPanel* aPanel;
669 bool isPPChildObject = false;
671 aPanel = aOperation->propertyPanel();
673 isPPChildObject = isChildObject(theObject, aPanel);
674 // process delete in active widget only if delete sender is child of property panel
675 // it is necessary for the case when OB is shown, user perform selection and click Delete
676 if (isPPChildObject) {
677 anActiveWgt = aPanel->activeWidget();
679 isAccepted = anActiveWgt->processDelete();
685 // after widget, object browser and viewer should process delete
686 /// other widgets such as line edit controls should not lead to
687 /// processing delete by workshop
688 XGUI_ObjectsBrowser* aBrowser = XGUI_Tools::workshop(myWorkshop)->objectBrowser();
689 QWidget* aViewPort = myWorkshop->viewer()->activeViewPort();
690 bool isToDeleteObject = false;
691 XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myWorkshop);
692 XGUI_ContextMenuMgr* aContextMenuMgr = aWorkshop->contextMenuMgr();
693 if (theObject == aBrowser->treeView()) {
694 aContextMenuMgr->updateObjectBrowserMenu();
695 isToDeleteObject = aContextMenuMgr->action("DELETE_CMD")->isEnabled();
697 else if (isChildObject(theObject, aViewPort)) {
698 aContextMenuMgr->updateViewerMenu();
699 isToDeleteObject = aContextMenuMgr->action("DELETE_CMD")->isEnabled();
701 else if (isPPChildObject) {
702 // property panel child object is processed to process delete performed on Apply button of PP
703 isToDeleteObject = true;
705 if (isToDeleteObject) {
706 aWorkshop->deleteObjects();
714 bool XGUI_OperationMgr::isChildObject(const QObject* theObject, const QObject* theParent)
716 bool isPPChild = false;
717 if (theParent && theObject) {
718 QObject* aParent = (QObject*)theObject;
720 isPPChild = aParent == theParent;
723 aParent = aParent->parent();