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   if (!myWorkshop->canStartOperation(theCmdId))
  75     return;
  76
  77   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
  78                                              (createOperation(theCmdId.toStdString()));
  79   if (aFOperation) {
  80     ModuleBase_ISelection* aSelection = myWorkshop->selection();
  81     // Initialise operation with preliminary selection
  82     aFOperation->initSelection(aSelection, myWorkshop->viewer());
  83     sendOperation(aFOperation);
  84   }
  85 }
  86
  87
  88 void ModuleBase_IModule::sendOperation(ModuleBase_Operation* theOperation)
  89 {
  90   static Events_ID aModuleEvent = Events_Loop::eventByName(EVENT_OPERATION_LAUNCHED);
  91   std::shared_ptr<Config_PointerMessage> aMessage =
  92       std::shared_ptr<Config_PointerMessage>(new Config_PointerMessage(aModuleEvent, this));
  93   aMessage->setPointer(theOperation);
  94   Events_Loop::loop()->send(aMessage);
  95 }
  96
  97 Handle(AIS_InteractiveObject) ModuleBase_IModule::createPresentation(const ResultPtr& theResult)
  98 {
  99   return Handle(AIS_InteractiveObject)();
 100 }
 101
 102 bool ModuleBase_IModule::canBeShaded(Handle(AIS_InteractiveObject) theAIS) const
 103 {
 104   return true;
 105 }
 106
 107 QString ModuleBase_IModule::getFeatureError(const FeaturePtr& theFeature)
 108 {
 109   std::string aMsg = ModelAPI_Tools::getFeatureError(theFeature);
 110   ModuleBase_Tools::translate(theFeature->getKind(), aMsg);
 111
 112   return aMsg.c_str();
 113 }
 114
 115 void ModuleBase_IModule::grantedOperationIds(ModuleBase_Operation* theOperation,
 116                                              QStringList& theIds) const
 117 {
 118 }
 119
 120 ModuleBase_Operation* ModuleBase_IModule::getNewOperation(const std::string& theFeatureId)
 121 {
 122   return new ModuleBase_OperationFeature(theFeatureId.c_str(), this);
 123 }
 124
 125 bool ModuleBase_IModule::customizeObject(ObjectPtr theObject,
 126                                          const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
 127                                          const bool theUpdateViewer)
 128 {
 129   return false;
 130 }
 131
 132 ModuleBase_Operation* ModuleBase_IModule::createOperation(const std::string& theFeatureId)
 133 {
 134   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
 135                                                           (getNewOperation(theFeatureId));
 136   // If the operation is launched as sub-operation of another then we have to initialize
 137   // parent feature
 138   ModuleBase_OperationFeature* aCurOperation = dynamic_cast<ModuleBase_OperationFeature*>
 139                                                          (myWorkshop->currentOperation());
 140   if (aCurOperation) {
 141     FeaturePtr aFeature = aCurOperation->feature();
 142     CompositeFeaturePtr aCompFeature =
 143         std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
 144     if (aCompFeature) {
 145       aFOperation->setParentFeature(aCompFeature);
 146     }
 147   }
 148
 149   std::string aXmlCfg, aDescription;
 150   getXMLRepresentation(theFeatureId, aXmlCfg, aDescription);
 151   aFOperation->getDescription()->setDescription(QString::fromStdString(aDescription));
 152   aFOperation->getDescription()->setXmlRepresentation(QString::fromStdString(aXmlCfg));
 153
 154   return aFOperation;
 155 }
 156
 157 void ModuleBase_IModule::createFeatures()
 158 {
 159   registerValidators();
 160   registerFilters();
 161   registerProperties();
 162
 163   Config_ModuleReader aXMLReader = Config_ModuleReader();
 164   aXMLReader.readAll();
 165   myFeaturesInFiles = aXMLReader.featuresInFiles();
 166 }
 167
 168
 169 void ModuleBase_IModule::actionCreated(QAction* theFeature)
 170 {
 171   theFeature->setStatusTip(theFeature->text());
 172   connect(theFeature, SIGNAL(triggered(bool)), this, SLOT(onFeatureTriggered()));
 173 }
 174
 175 bool ModuleBase_IModule::canEraseObject(const ObjectPtr& theObject) const
 176 {
 177   return true;
 178 }
 179
 180 bool ModuleBase_IModule::canDisplayObject(const ObjectPtr& theObject) const
 181 {
 182   return true;
 183 }
 184
 185 bool ModuleBase_IModule::canUndo() const
 186 {
 187   SessionPtr aMgr = ModelAPI_Session::get();
 188   return aMgr->hasModuleDocument() && aMgr->canUndo() && !aMgr->isOperation();
 189 }
 190
 191 bool ModuleBase_IModule::canRedo() const
 192 {
 193   SessionPtr aMgr = ModelAPI_Session::get();
 194   return aMgr->hasModuleDocument() && aMgr->canRedo() && !aMgr->isOperation();
 195 }
 196
 197 void ModuleBase_IModule::onFeatureTriggered()
 198 {
 199   QAction* aCmd = dynamic_cast<QAction*>(sender());
 200   //Do nothing on uncheck
 201   if (aCmd->isCheckable() && !aCmd->isChecked()) {
 202     ModuleBase_Operation* anOperation = myWorkshop->findStartedOperation(aCmd->data().toString());
 203     if (myWorkshop->canStopOperation(anOperation))
 204       myWorkshop->abortOperation(anOperation);
 205     else {
 206       aCmd->setChecked(true);
 207     }
 208   }
 209   else {
 210     QString aCmdId = aCmd->data().toString();
 211     std::shared_ptr<Config_FeatureMessage> aInfo = myWorkshop->featureInfo(aCmdId);
 212     if (aInfo.get() && aInfo->isModal()) {
 213       launchModal(aCmdId);
 214     } else {
 215       launchOperation(aCmdId);
 216       emit operationLaunched();
 217     }
 218   }
 219 }
 220
 221 void ModuleBase_IModule::editFeature(FeaturePtr theFeature)
 222 {
 223   std::string aFeatureId = theFeature->getKind();
 224   if (!myWorkshop->canStartOperation(aFeatureId.c_str()))
 225     return;
 226
 227   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
 228                                                          (createOperation(aFeatureId));
 229   if (aFOperation) {
 230     aFOperation->setFeature(theFeature);
 231     sendOperation(aFOperation);
 232   }
 233 }
 234
 235 bool ModuleBase_IModule::canActivateSelection(const ObjectPtr& theObject) const
 236 {
 237   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
 238                                                      (myWorkshop->currentOperation());
 239   return !aFOperation || !aFOperation->hasObject(theObject);
 240 }
 241
 242 void ModuleBase_IModule::operationResumed(ModuleBase_Operation* theOperation)
 243 {
 244   emit resumed(theOperation);
 245 }
 246
 247 void ModuleBase_IModule::getXMLRepresentation(const std::string& theFeatureId,
 248                                               std::string& theXmlCfg, std::string& theDescription)
 249 {
 250   std::string aPluginFileName = myFeaturesInFiles[theFeatureId];
 251   Config_WidgetReader aWdgReader = Config_WidgetReader(aPluginFileName);
 252   aWdgReader.readAll();
 253
 254   theXmlCfg = aWdgReader.featureWidgetCfg(theFeatureId);
 255   theDescription = aWdgReader.featureDescription(theFeatureId);
 256 }