src/ModuleBase/ModuleBase_IModule.cpp

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