src/ModuleBase/ModuleBase_IModule.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 #include "ModelAPI_IReentrant.h"
   4 #include "ModelAPI_EventReentrantMessage.h"
   5
   6 #include "ModuleBase_IModule.h"
   7 #include "ModuleBase_IViewer.h"
   8 #include "ModuleBase_ViewerPrs.h"
   9 #include "ModuleBase_Operation.h"
  10 #include "ModuleBase_IPropertyPanel.h"
  11 #include "ModuleBase_ISelection.h"
  12 #include "ModuleBase_OperationDescription.h"
  13 #include "ModuleBase_OperationFeature.h"
  14 #include "ModuleBase_ModelWidget.h"
  15 #include "ModuleBase_WidgetFactory.h"
  16 #include "ModuleBase_PageWidget.h"
  17 #include "ModuleBase_Dialog.h"
  18 #include "ModuleBase_IErrorMgr.h"
  19
  20 #include <Events_Loop.h>
  21 #include <Events_Message.h>
  22
  23 #include <ModelAPI_Events.h>
  24 #include <ModelAPI_CompositeFeature.h>
  25 #include <ModelAPI_Session.h>
  26 #include "ModelAPI_Tools.h"
  27
  28 #include <Config_PointerMessage.h>
  29 #include <Config_WidgetReader.h>
  30 #include <Config_ModuleReader.h>
  31
  32 #include <QAction>
  33 #include <QMainWindow>
  34 #include <QDialog>
  35 #include <QLayout>
  36 #include <QDialogButtonBox>
  37 #include <QPushButton>
  38
  39 ModuleBase_IModule::ModuleBase_IModule(ModuleBase_IWorkshop* theParent)
  40   : QObject(theParent), myWorkshop(theParent)
  41 {
  42   connect(myWorkshop, SIGNAL(selectionChanged()), this, SLOT(onSelectionChanged()));
  43
  44
  45   //connect(myWorkshop->viewer(), SIGNAL(mousePress(QMouseEvent*)), this,
  46   //        SLOT(onMousePressed(QMouseEvent*)));
  47   //connect(myWorkshop->viewer(), SIGNAL(mouseRelease(QMouseEvent*)), this,
  48   //        SLOT(onMouseReleased(QMouseEvent*)));
  49   //connect(myWorkshop->viewer(), SIGNAL(mouseMove(QMouseEvent*)), this,
  50   //        SLOT(onMouseMoved(QMouseEvent*)));
  51   //connect(myWorkshop->viewer(), SIGNAL(keyRelease(QKeyEvent*)), this,
  52   //        SLOT(onKeyRelease(QKeyEvent*)));
  53   //connect(myWorkshop->viewer(), SIGNAL(mouseDoubleClick(QMouseEvent*)), this,
  54   //        SLOT(onMouseDoubleClick(QMouseEvent*)));
  55 }
  56
  57 void ModuleBase_IModule::launchModal(const QString& theCmdId)
  58 {
  59   bool isCommitted;
  60   if (!myWorkshop->canStartOperation(theCmdId, isCommitted))
  61     return;
  62
  63   std::string aXmlCfg, aDescription;
  64   getXMLRepresentation(theCmdId.toStdString(), aXmlCfg, aDescription);
  65
  66   SessionPtr aMgr = ModelAPI_Session::get();
  67   aMgr->startOperation(theCmdId.toStdString());
  68
  69   ModuleBase_Dialog aDlg(myWorkshop, theCmdId, aXmlCfg);
  70   if (aDlg.exec() == QDialog::Accepted)
  71     aMgr->finishOperation();
  72   else
  73     aMgr->abortOperation();
  74   myWorkshop->updateCommandStatus();
  75 }
  76
  77
  78 void ModuleBase_IModule::launchOperation(const QString& theCmdId,
  79                                          const bool& isStartAfterCommitOnly)
  80 {
  81   /// selection should be obtained from workshop before ask if the operation can be started as
  82   /// the canStartOperation method performs commit/abort of previous operation.
  83   /// Sometimes commit/abort may cause selection clear(Sketch operation) as a result
  84   /// it will be lost and is not used for preselection.
  85   ModuleBase_ISelection* aSelection = myWorkshop->selection();
  86   QList<ModuleBase_ViewerPrsPtr> aPreSelected =
  87     aSelection->getSelected(ModuleBase_ISelection::AllControls);
  88
  89   ModuleBase_OperationFeature* aCurOperation = dynamic_cast<ModuleBase_OperationFeature*>
  90                                                          (myWorkshop->currentOperation());
  91   QString aCurOperationKind = aCurOperation ? aCurOperation->getDescription()->operationId() : "";
  92
  93   bool isCommitted;
  94   if (!myWorkshop->canStartOperation(theCmdId, isCommitted))
  95     return;
  96
  97   /// reentrant operation(Sketch Line) should not be started if operation is aborted
  98   if (isStartAfterCommitOnly && !isCommitted)
  99     return;
 100
 101   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
 102                                              (createOperation(theCmdId.toStdString()));
 103   if (aFOperation) {
 104     std::shared_ptr<Events_Message> aMessage = reentrantMessage();
 105     if (aMessage.get()) {
 106       setReentrantPreSelection(aMessage);
 107     }
 108     else if (canUsePreselection(aCurOperationKind, theCmdId)) {
 109       // restore of previous opeation is absent or new launched operation has the same kind
 110       aFOperation->initSelection(aPreSelected);
 111     }
 112     workshop()->processLaunchOperation(aFOperation);
 113
 114     if (aFOperation) {
 115       FeaturePtr aFeature = aFOperation->feature();
 116       ModelReentrantPtr aReentrantFeature =
 117                                       std::dynamic_pointer_cast<ModelAPI_IReentrant>(aFeature);
 118       if (aReentrantFeature.get()) {
 119         if (aMessage.get()) {
 120           ModuleBase_IPropertyPanel* aPanel = workshop()->propertyPanel();
 121           std::string aPrevAttribute = aReentrantFeature->processEvent(aMessage);
 122           if (!aPrevAttribute.empty()) {
 123             workshop()->errorMgr()->updateActions(aFeature);
 124             ModuleBase_ModelWidget* aPrevWidget = aPanel->modelWidget(aPrevAttribute);
 125             aPanel->activateNextWidget(aPrevWidget);
 126           }
 127         }
 128       }
 129     }
 130   }
 131 }
 132
 133 Handle(AIS_InteractiveObject) ModuleBase_IModule::createPresentation(const ResultPtr& theResult)
 134 {
 135   return Handle(AIS_InteractiveObject)();
 136 }
 137
 138 bool ModuleBase_IModule::canBeShaded(Handle(AIS_InteractiveObject) theAIS) const
 139 {
 140   return true;
 141 }
 142
 143 QString ModuleBase_IModule::getFeatureError(const FeaturePtr& theFeature)
 144 {
 145   // Error already translated.
 146   std::string aMsg = ModelAPI_Tools::getFeatureError(theFeature);
 147   return QString::fromUtf8(aMsg.c_str());
 148 }
 149
 150 void ModuleBase_IModule::grantedOperationIds(ModuleBase_Operation* theOperation,
 151                                              QStringList& theIds) const
 152 {
 153 }
 154
 155 ModuleBase_Operation* ModuleBase_IModule::getNewOperation(const std::string& theFeatureId)
 156 {
 157   return new ModuleBase_OperationFeature(theFeatureId.c_str(), this);
 158 }
 159
 160 bool ModuleBase_IModule::customizeObject(ObjectPtr theObject,
 161                               const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
 162                               const bool theUpdateViewer)
 163 {
 164   return false;
 165 }
 166
 167 ModuleBase_Operation* ModuleBase_IModule::createOperation(const std::string& theFeatureId)
 168 {
 169   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
 170                                                           (getNewOperation(theFeatureId));
 171   // If the operation is launched as sub-operation of another then we have to initialize
 172   // parent feature
 173   ModuleBase_OperationFeature* aCurOperation = dynamic_cast<ModuleBase_OperationFeature*>
 174                                                          (myWorkshop->currentOperation());
 175   if (aCurOperation) {
 176     FeaturePtr aFeature = aCurOperation->feature();
 177     CompositeFeaturePtr aCompFeature =
 178         std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
 179     if (aCompFeature) {
 180       aFOperation->setParentFeature(aCompFeature);
 181     }
 182   }
 183
 184   std::string aXmlCfg, aDescription;
 185   getXMLRepresentation(theFeatureId, aXmlCfg, aDescription);
 186   aFOperation->getDescription()->setDescription(QString::fromStdString(aDescription));
 187   aFOperation->getDescription()->setXmlRepresentation(QString::fromStdString(aXmlCfg));
 188
 189   return aFOperation;
 190 }
 191
 192 void ModuleBase_IModule::createFeatures()
 193 {
 194   registerValidators();
 195   registerProperties();
 196
 197   Config_ModuleReader aXMLReader = Config_ModuleReader();
 198   aXMLReader.readAll();
 199   myFeaturesInFiles = aXMLReader.featuresInFiles();
 200 }
 201
 202
 203 void ModuleBase_IModule::actionCreated(QAction* theFeature)
 204 {
 205   connect(theFeature, SIGNAL(triggered(bool)), this, SLOT(onFeatureTriggered()));
 206 }
 207
 208 bool ModuleBase_IModule::canEraseObject(const ObjectPtr& theObject) const
 209 {
 210   return true;
 211 }
 212
 213 bool ModuleBase_IModule::canDisplayObject(const ObjectPtr& theObject) const
 214 {
 215   return true;
 216 }
 217
 218 bool ModuleBase_IModule::canUsePreselection(const QString& thePreviousOperationKind,
 219                                             const QString& theStartedOperationKind)
 220 {
 221   // no previous operation
 222   if (thePreviousOperationKind.isEmpty())
 223     return true;
 224   // edit operation
 225   if (thePreviousOperationKind.endsWith(ModuleBase_OperationFeature::EditSuffix()))
 226     return true;
 227
 228   // reentrant operation
 229   if (thePreviousOperationKind == theStartedOperationKind)
 230     return true;
 231
 232   return false;
 233 }
 234
 235 bool ModuleBase_IModule::canUndo() const
 236 {
 237   SessionPtr aMgr = ModelAPI_Session::get();
 238   return aMgr->hasModuleDocument() && aMgr->canUndo() && !aMgr->isOperation();
 239 }
 240
 241 bool ModuleBase_IModule::canRedo() const
 242 {
 243   SessionPtr aMgr = ModelAPI_Session::get();
 244   return aMgr->hasModuleDocument() && aMgr->canRedo() && !aMgr->isOperation();
 245 }
 246
 247 void ModuleBase_IModule::onFeatureTriggered()
 248 {
 249   QAction* aCmd = dynamic_cast<QAction*>(sender());
 250   //Do nothing on uncheck
 251   if (aCmd->isCheckable() && !aCmd->isChecked()) {
 252     ModuleBase_Operation* anOperation = myWorkshop->findStartedOperation(aCmd->data().toString());
 253     if (myWorkshop->canStopOperation(anOperation)) {
 254       bool isCommitted;
 255       myWorkshop->stopOperation(anOperation, isCommitted);
 256     }
 257     else {
 258       aCmd->setChecked(true);
 259     }
 260   }
 261   else {
 262     QString aCmdId = aCmd->data().toString();
 263     std::shared_ptr<Config_FeatureMessage> aInfo = myWorkshop->featureInfo(aCmdId);
 264     if (aInfo.get() && aInfo->isModal()) {
 265       launchModal(aCmdId);
 266     } else {
 267       launchOperation(aCmdId, false);
 268       emit operationLaunched();
 269     }
 270   }
 271 }
 272
 273 void ModuleBase_IModule::editFeature(FeaturePtr theFeature)
 274 {
 275   std::string aFeatureId = theFeature->getKind();
 276   bool isCommitted;
 277   if (!myWorkshop->canStartOperation(aFeatureId.c_str(), isCommitted))
 278     return;
 279
 280   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
 281                                                          (createOperation(aFeatureId));
 282   if (aFOperation) {
 283     aFOperation->setFeature(theFeature);
 284     workshop()->processLaunchOperation(aFOperation);
 285   }
 286 }
 287
 288 bool ModuleBase_IModule::canActivateSelection(const ObjectPtr& theObject) const
 289 {
 290   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
 291                                                      (myWorkshop->currentOperation());
 292   return !aFOperation || !aFOperation->hasObject(theObject);
 293 }
 294
 295 void ModuleBase_IModule::operationResumed(ModuleBase_Operation* theOperation)
 296 {
 297   emit resumed(theOperation);
 298 }
 299
 300 void ModuleBase_IModule::getXMLRepresentation(const std::string& theFeatureId,
 301                                               std::string& theXmlCfg, std::string& theDescription)
 302 {
 303   std::string aPluginFileName = myFeaturesInFiles[theFeatureId];
 304   Config_WidgetReader aWdgReader = Config_WidgetReader(aPluginFileName);
 305   aWdgReader.readAll();
 306
 307   theXmlCfg = aWdgReader.featureWidgetCfg(theFeatureId);
 308   theDescription = aWdgReader.featureDescription(theFeatureId);
 309 }