src/XGUI/XGUI_WorkshopListener.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 #include "XGUI_WorkshopListener.h"
   4 #include "XGUI_Workshop.h"
   5 #include "XGUI_Displayer.h"
   6 #include "XGUI_OperationMgr.h"
   7 #include "XGUI_SalomeConnector.h"
   8 #include "XGUI_ActionsMgr.h"
   9 #include "XGUI_PropertyPanel.h"
  10 #include "XGUI_ModuleConnector.h"
  11 #include "XGUI_QtEvents.h"
  12
  13 #include <AppElements_Workbench.h>
  14 #include <AppElements_Command.h>
  15 #include <AppElements_MainMenu.h>
  16 #include <AppElements_MainWindow.h>
  17 #include <AppElements_MenuGroupPanel.h>
  18 #include <AppElements_Button.h>
  19
  20 #include <ModuleBase_IModule.h>
  21
  22 #include <ModelAPI_Object.h>
  23 #include <ModelAPI_Events.h>
  24 #include <ModelAPI_Session.h>
  25 #include <ModelAPI_Result.h>
  26 #include <ModelAPI_Feature.h>
  27 #include <ModelAPI_Data.h>
  28 #include <ModelAPI_ResultBody.h>
  29 #include <ModelAPI_ResultCompSolid.h>
  30 #include <ModelAPI_Tools.h>
  31
  32 #include <Events_Loop.h>
  33 #include <Events_Error.h>
  34 #include <Events_LongOp.h>
  35
  36 #include <ModuleBase_IWorkshop.h>
  37
  38 #include <ModuleBase_Operation.h>
  39 #include <ModuleBase_OperationDescription.h>
  40 #include <ModuleBase_Tools.h>
  41 #include <ModuleBase_IViewer.h>
  42 #include <ModuleBase_FilterFactory.h>
  43
  44 #include <Config_FeatureMessage.h>
  45 #include <Config_PointerMessage.h>
  46 #include <Config_SelectionFilterMessage.h>
  47
  48 #include <QApplication>
  49 #include <QMainWindow>
  50 #include <QThread>
  51 #include <QAction>
  52
  53 #ifdef _DEBUG
  54 #include <QDebug>
  55 #include <iostream>
  56 #endif
  57
  58 //#define DEBUG_FEATURE_CREATED
  59 //#define DEBUG_FEATURE_REDISPLAY
  60
  61 XGUI_WorkshopListener::XGUI_WorkshopListener(ModuleBase_IWorkshop* theWorkshop)
  62   : myWorkshop(theWorkshop),
  63     myUpdatePrefs(false)
  64 {
  65 }
  66
  67 //******************************************************
  68 XGUI_WorkshopListener::~XGUI_WorkshopListener(void)
  69 {
  70 }
  71
  72 //******************************************************
  73 void XGUI_WorkshopListener::initializeEventListening()
  74 {
  75   //Initialize event listening
  76   Events_Loop* aLoop = Events_Loop::loop();
  77   aLoop->registerListener(this, Events_Error::errorID());  //!< Listening application errors.
  78   aLoop->registerListener(this, Events_Loop::eventByName(Config_FeatureMessage::GUI_EVENT()));
  79   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OPERATION_LAUNCHED));
  80   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
  81   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_CREATED));
  82   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
  83   aLoop->registerListener(this, Events_LongOp::eventID());
  84   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_PLUGIN_LOADED));
  85   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_SELFILTER_LOADED));
  86
  87   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED));
  88   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED));
  89 }
  90
  91 //******************************************************
  92 void XGUI_WorkshopListener::processEvent(const std::shared_ptr<Events_Message>& theMessage)
  93 {
  94   if (QApplication::instance()->thread() != QThread::currentThread()) {
  95     #ifdef _DEBUG
  96     std::cout << "XGUI_Workshop::processEvent: " << "Working in another thread." << std::endl;
  97     #endif
  98     SessionPtr aMgr = ModelAPI_Session::get();
  99     PostponeMessageQtEvent* aPostponeEvent = new PostponeMessageQtEvent(theMessage);
 100     QApplication::postEvent(this, aPostponeEvent);
 101     return;
 102   }
 103
 104   //A message to start feature creation received.
 105   if (theMessage->eventID() == Events_Loop::loop()->eventByName(Config_FeatureMessage::GUI_EVENT())) {
 106     std::shared_ptr<Config_FeatureMessage> aFeatureMsg =
 107        std::dynamic_pointer_cast<Config_FeatureMessage>(theMessage);
 108     if (!aFeatureMsg->isInternal()) {
 109       addFeature(aFeatureMsg);
 110     }
 111   }
 112   // Process creation of Part
 113   else if (theMessage->eventID() == Events_Loop::loop()->eventByName(EVENT_OBJECT_CREATED)) {
 114     std::shared_ptr<ModelAPI_ObjectUpdatedMessage> aUpdMsg =
 115         std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
 116     onFeatureCreatedMsg(aUpdMsg);
 117     if (myUpdatePrefs) {
 118       XGUI_SalomeConnector* aSalomeConnector = workshop()->salomeConnector();
 119       if (aSalomeConnector)
 120         aSalomeConnector->createPreferences();
 121       myUpdatePrefs = false;
 122     }
 123   }
 124   else if (theMessage->eventID() == Events_Loop::loop()->eventByName(EVENT_PLUGIN_LOADED)) {
 125     myUpdatePrefs = true;
 126   }
 127   // Redisplay feature
 128   else if (theMessage->eventID() == Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY)) {
 129     std::shared_ptr<ModelAPI_ObjectUpdatedMessage> aUpdMsg =
 130         std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
 131     onFeatureRedisplayMsg(aUpdMsg);
 132   }
 133   //Update property panel on corresponding message. If there is no current operation (no
 134   //property panel), or received message has different feature to the current - do nothing.
 135   else if (theMessage->eventID() == Events_Loop::loop()->eventByName(EVENT_OBJECT_UPDATED)) {
 136     std::shared_ptr<ModelAPI_ObjectUpdatedMessage> anUpdateMsg =
 137         std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
 138     onFeatureUpdatedMsg(anUpdateMsg);
 139   } else if (theMessage->eventID() == Events_LongOp::eventID()) {
 140     if (Events_LongOp::isPerformed()) {
 141       QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
 142     } else {
 143       QApplication::restoreOverrideCursor();
 144     }
 145   }
 146   //An operation passed by message. Start it, process and commit.
 147   else if (theMessage->eventID() == Events_Loop::loop()->eventByName(EVENT_OPERATION_LAUNCHED)) {
 148     std::shared_ptr<Config_PointerMessage> aPartSetMsg =
 149         std::dynamic_pointer_cast<Config_PointerMessage>(theMessage);
 150     //myPropertyPanel->cleanContent();
 151     ModuleBase_Operation* anOperation = (ModuleBase_Operation*) aPartSetMsg->pointer();
 152     XGUI_OperationMgr* anOperationMgr = workshop()->operationMgr();
 153
 154     if (anOperationMgr->startOperation(anOperation)) {
 155       workshop()->propertyPanel()->updateContentWidget(anOperation->feature());
 156       if (!anOperation->getDescription()->hasXmlRepresentation()) {
 157         if (anOperation->commit())
 158           workshop()->updateCommandStatus();
 159       }
 160     }
 161   }
 162   else if (theMessage->eventID() == Events_Loop::eventByName(EVENT_SELFILTER_LOADED)) {
 163     std::shared_ptr<Config_SelectionFilterMessage> aMsg =
 164       std::dynamic_pointer_cast<Config_SelectionFilterMessage>(theMessage);
 165     if (aMsg) {
 166       ModuleBase_FilterFactory* aFactory = myWorkshop->selectionFilters();
 167       if (!aMsg->attributeId().empty()) {
 168         aFactory->assignFilter(aMsg->selectionFilterId(), aMsg->featureId(), aMsg->attributeId(),
 169                                aMsg->parameters());
 170       }
 171     }
 172   } else if (theMessage->eventID() == Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED)) {
 173     // the viewer's update context will not happens until viewer updated is emitted
 174       workshop()->displayer()->enableUpdateViewer(false);
 175   } else if (theMessage->eventID() == Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED)) {
 176     // the viewer's update context is unblocked, the viewer's update works
 177     XGUI_Displayer* aDisplayer = workshop()->displayer();
 178     aDisplayer->enableUpdateViewer(true);
 179     aDisplayer->updateViewer();
 180   } else {
 181     //Show error dialog if error message received.
 182     std::shared_ptr<Events_Error> anAppError = std::dynamic_pointer_cast<Events_Error>(theMessage);
 183     if (anAppError) {
 184       emit errorOccurred(QString::fromLatin1(anAppError->description()));
 185     }
 186     return;
 187   }
 188   if (!workshop()->isSalomeMode()) {
 189     SessionPtr aMgr = ModelAPI_Session::get();
 190     AppElements_MainWindow* aMainWindow = workshop()->mainWindow();
 191     if (aMgr->isModified() != aMainWindow->isModifiedState())
 192       aMainWindow->setModifiedState(aMgr->isModified());
 193   }
 194 }
 195
 196 //******************************************************
 197 void XGUI_WorkshopListener::onFeatureUpdatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg)
 198 {
 199   std::set<ObjectPtr> aFeatures = theMsg->objects();
 200   XGUI_OperationMgr* anOperationMgr = workshop()->operationMgr();
 201   if (anOperationMgr->hasOperation()) {
 202     FeaturePtr aCurrentFeature = anOperationMgr->currentOperation()->feature();
 203     std::set<ObjectPtr>::const_iterator aIt;
 204     for (aIt = aFeatures.begin(); aIt != aFeatures.end(); ++aIt) {
 205       ObjectPtr aNewFeature = (*aIt);
 206       if (aNewFeature == aCurrentFeature) {
 207         workshop()->propertyPanel()->updateContentWidget(aCurrentFeature);
 208         break;
 209       }
 210     }
 211   }
 212   anOperationMgr->onValidateOperation();
 213   //if (myObjectBrowser)
 214   //  myObjectBrowser->processEvent(theMsg);
 215 }
 216
 217 //******************************************************
 218 void XGUI_WorkshopListener::onFeatureRedisplayMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg)
 219 {
 220   std::set<ObjectPtr> aObjects = theMsg->objects();
 221   std::set<ObjectPtr>::const_iterator aIt;
 222
 223 #ifdef DEBUG_FEATURE_REDISPLAY
 224   QStringList anInfo;
 225   for (aIt = aObjects.begin(); aIt != aObjects.end(); ++aIt) {
 226     anInfo.append(ModuleBase_Tools::objectInfo((*aIt)));
 227   }
 228   QString anInfoStr = anInfo.join(", ");
 229   qDebug(QString("onFeatureRedisplayMsg: %1, %2").arg(aObjects.size()).arg(anInfoStr).toStdString().c_str());
 230 #endif
 231
 232   XGUI_Workshop* aWorkshop = workshop();
 233   XGUI_Displayer* aDisplayer = aWorkshop->displayer();
 234   for (aIt = aObjects.begin(); aIt != aObjects.end(); ++aIt) {
 235     ObjectPtr aObj = (*aIt);
 236
 237     // Hide the object if it is invalid or concealed one
 238     bool aHide = !aObj->data() || !aObj->data()->isValid() ||
 239       aObj->isDisabled() || (!aObj->isDisplayed());
 240     if (!aHide) { // check that this is not hidden result
 241       ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(aObj);
 242       aHide = aRes && aRes->isConcealed();
 243     }
 244     if (aHide) {
 245       aDisplayer->erase(aObj, false);
 246       #ifdef DEBUG_FEATURE_REDISPLAY
 247         // Redisplay the visible object or the object of the current operation
 248         bool isVisibleObject = aDisplayer->isVisible(aObj);
 249
 250         QString anObjInfo = ModuleBase_Tools::objectInfo((aObj));
 251         qDebug(QString("visible=%1 : erase  = %2").arg(isVisibleObject).arg(anObjInfo).toStdString().c_str());
 252       #endif
 253     }
 254     else {
 255       // Redisplay the visible object or the object of the current operation
 256       bool isVisibleObject = aDisplayer->isVisible(aObj);
 257       #ifdef DEBUG_FEATURE_REDISPLAY
 258         QString anObjInfo = ModuleBase_Tools::objectInfo((aObj));
 259         qDebug(QString("visible=%1 : display= %2").arg(isVisibleObject).arg(anObjInfo).toStdString().c_str());
 260         /*FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(aObj);
 261         if (aFeature.get()) {
 262           std::string aKind = aFeature->getKind();
 263           if (aKind == "SketchMultiRotation")
 264             bool aValue = true;
 265         }*/
 266       #endif
 267
 268       if (isVisibleObject)  { // redisplay visible object
 269         //displayObject(aObj);  // In order to update presentation
 270         // in order to avoid the check whether the object can be redisplayed, the exact method
 271         // of redisplay is called. This modification is made in order to have the line is updated
 272         // by creation of a horizontal constraint on the line by preselection
 273         if (ModelAPI_Tools::hasSubResults(std::dynamic_pointer_cast<ModelAPI_Result>(aObj))) {
 274           aDisplayer->erase(aObj, false);
 275         }
 276         else {
 277           aDisplayer->redisplay(aObj, false);
 278           // Deactivate object of current operation from selection
 279           aWorkshop->deactivateActiveObject(aObj, false);
 280         }
 281       } else { // display object if the current operation has it
 282         if (displayObject(aObj)) {
 283           // Deactivate object of current operation from selection
 284           aWorkshop->deactivateActiveObject(aObj, false);
 285         }
 286       }
 287     }
 288   }
 289   aDisplayer->updateViewer();
 290 }
 291 //******************************************************
 292 void XGUI_WorkshopListener::onFeatureCreatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg)
 293 {
 294   std::set<ObjectPtr> aObjects = theMsg->objects();
 295   std::set<ObjectPtr>::const_iterator aIt;
 296 #ifdef DEBUG_FEATURE_CREATED
 297   QStringList anInfo;
 298   for (aIt = aObjects.begin(); aIt != aObjects.end(); ++aIt) {
 299     anInfo.append(ModuleBase_Tools::objectInfo((*aIt)));
 300   }
 301   QString anInfoStr = anInfo.join(", ");
 302   qDebug(QString("onFeatureCreatedMsg: %1, %2").arg(aObjects.size()).arg(anInfoStr).toStdString().c_str());
 303 #endif
 304
 305   //bool aHasPart = false;
 306   bool isDisplayed = false;
 307   for (aIt = aObjects.begin(); aIt != aObjects.end(); ++aIt) {
 308     ObjectPtr anObject = *aIt;
 309     // the validity of the data should be checked here in order to avoid display of the objects,
 310     // which were created, then deleted, but flush for the creation event happens after that
 311     // we should not display disabled objects
 312     bool aHide = !anObject->data()->isValid() ||
 313                  anObject->isDisabled() ||
 314                  !anObject->isDisplayed();
 315     if (!aHide) {
 316       // setDisplayed has to be called in order to synchronize internal state of the object
 317       // with list of displayed objects
 318       if (displayObject(anObject)) {
 319         anObject->setDisplayed(true);
 320       } else
 321         anObject->setDisplayed(false);
 322     }
 323   }
 324   //if (myObjectBrowser)
 325   //  myObjectBrowser->processEvent(theMsg);
 326   if (isDisplayed)
 327     workshop()->displayer()->updateViewer();
 328   //if (aHasPart) { // TODO: Avoid activate last part on loading of document
 329   //  activateLastPart();
 330   //}
 331 }
 332
 333 bool XGUI_WorkshopListener::event(QEvent * theEvent)
 334 {
 335   PostponeMessageQtEvent* aPostponedEv = dynamic_cast<PostponeMessageQtEvent*>(theEvent);
 336   if (aPostponedEv) {
 337     std::shared_ptr<Events_Message> aEventPtr = aPostponedEv->postponedMessage();
 338     processEvent(aEventPtr);
 339     return true;
 340   }
 341   return false;
 342 }
 343
 344 void XGUI_WorkshopListener::addFeature(const std::shared_ptr<Config_FeatureMessage>& theMessage)
 345 {
 346   if (!theMessage) {
 347 #ifdef _DEBUG
 348     qDebug() << "XGUI_WorkshopListener::addFeature: NULL message.";
 349 #endif
 350     return;
 351   }
 352   ActionInfo aFeatureInfo;
 353   aFeatureInfo.initFrom(theMessage);
 354
 355   XGUI_Workshop* aWorkshop = workshop();
 356
 357   QString aWchName = QString::fromStdString(theMessage->workbenchId());
 358   QStringList aNestedFeatures =
 359       QString::fromStdString(theMessage->nestedFeatures()).split(" ", QString::SkipEmptyParts);
 360   QString aDocKind = QString::fromStdString(theMessage->documentKind());
 361   QList<QAction*> aNestedActList;
 362   bool isColumnButton = !aNestedFeatures.isEmpty();
 363   if (isColumnButton) {
 364     QString aNestedActions = QString::fromStdString(theMessage->actionsWhenNested());
 365     XGUI_OperationMgr* anOperationMgr = aWorkshop->operationMgr();
 366     XGUI_ActionsMgr* anActionsMgr = aWorkshop->actionsMgr();
 367     if (aNestedActions.contains("accept")) {
 368       QAction* anAction = anActionsMgr->operationStateAction(XGUI_ActionsMgr::AcceptAll, NULL);
 369       connect(anAction, SIGNAL(triggered()), anOperationMgr, SLOT(commitAllOperations()));
 370       aNestedActList << anAction;
 371     }
 372     if (aNestedActions.contains("abort")) {
 373       QAction* anAction = anActionsMgr->operationStateAction(XGUI_ActionsMgr::AbortAll, NULL);
 374       connect(anAction, SIGNAL(triggered()), anOperationMgr, SLOT(abortAllOperations()));
 375       aNestedActList << anAction;
 376     }
 377   }
 378
 379   if (aWorkshop->isSalomeMode()) {
 380     XGUI_SalomeConnector* aSalomeConnector = aWorkshop->salomeConnector();
 381     QAction* aAction;
 382     if (isColumnButton) {
 383       aAction = aSalomeConnector->addNestedFeature(aWchName, aFeatureInfo, aNestedActList);
 384     } else {
 385       //Issue #650: in the SALOME mode the tooltip should be same as text
 386       aFeatureInfo.toolTip = aFeatureInfo.text;
 387       aAction = aSalomeConnector->addFeature(aWchName, aFeatureInfo);
 388     }
 389     aSalomeConnector->setNestedActions(aFeatureInfo.id, aNestedFeatures);
 390     aSalomeConnector->setDocumentKind(aFeatureInfo.id, aDocKind);
 391
 392     aWorkshop->actionsMgr()->addCommand(aAction);
 393     aWorkshop->module()->actionCreated(aAction);
 394   } else {
 395     //Find or create Workbench
 396     AppElements_MainMenu* aMenuBar = aWorkshop->mainWindow()->menuObject();
 397     AppElements_Workbench* aPage = aMenuBar->findWorkbench(aWchName);
 398     if (!aPage) {
 399       aPage = aWorkshop->addWorkbench(aWchName);
 400     }
 401     //Find or create Group
 402     QString aGroupName = QString::fromStdString(theMessage->groupId());
 403     AppElements_MenuGroupPanel* aGroup = aPage->findGroup(aGroupName);
 404     if (!aGroup) {
 405       aGroup = aPage->addGroup(aGroupName);
 406     }
 407     // Check if hotkey sequence is already defined:
 408     XGUI_ActionsMgr* anActionsMgr = aWorkshop->actionsMgr();
 409     QKeySequence aHotKey = anActionsMgr->registerShortcut(aFeatureInfo.shortcut);
 410     if(aHotKey != aFeatureInfo.shortcut) {
 411       aFeatureInfo.shortcut = aHotKey;
 412     }
 413     // Create feature...
 414     AppElements_Command* aCommand = aGroup->addFeature(aFeatureInfo,
 415                                                        aDocKind,
 416                                                        aNestedFeatures);
 417     // Enrich created button with accept/abort buttons if necessary
 418     AppElements_Button* aButton = aCommand->button();
 419     if (aButton->isColumnButton()) {
 420       aButton->setAdditionalButtons(aNestedActList);
 421     }
 422     aWorkshop->actionsMgr()->addCommand(aCommand);
 423     aWorkshop->module()->actionCreated(aCommand);
 424   }
 425 }
 426
 427
 428 //**************************************************************
 429 bool XGUI_WorkshopListener::displayObject(ObjectPtr theObj)
 430 {
 431   XGUI_Workshop* aWorkshop = workshop();
 432   if (ModelAPI_Tools::hasSubResults(std::dynamic_pointer_cast<ModelAPI_Result>(theObj)) ||
 433       !aWorkshop->module()->canDisplayObject(theObj))
 434     return false;
 435
 436   XGUI_Displayer* aDisplayer = aWorkshop->displayer();
 437   ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theObj);
 438   if (aBody.get() != NULL) {
 439     int aNb = aDisplayer->objectsCount();
 440     aDisplayer->display(theObj, false);
 441     if (aNb == 0)
 442       myWorkshop->viewer()->fitAll();
 443   } else
 444     aDisplayer->display(theObj, false);
 445
 446   return true;
 447 }
 448
 449 XGUI_Workshop* XGUI_WorkshopListener::workshop() const
 450 {
 451   XGUI_ModuleConnector* aConnector = dynamic_cast<XGUI_ModuleConnector*>(myWorkshop);
 452   return aConnector->workshop();
 453 }