src/ModuleBase/ModuleBase_Operation.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * ModuleBase_Operation.cpp
   5  *
   6  *  Created on: Apr 2, 2014
   7  *      Author: sbh
   8  */
   9
  10 #include "ModuleBase_Operation.h"
  11
  12 #include "ModuleBase_OperationDescription.h"
  13 #include "ModuleBase_ModelWidget.h"
  14 #include "ModuleBase_ViewerPrs.h"
  15 #include "ModuleBase_IPropertyPanel.h"
  16 #include "ModuleBase_ISelection.h"
  17 #include "ModuleBase_IViewer.h"
  18
  19 #include <ModelAPI_AttributeDouble.h>
  20 #include <ModelAPI_Document.h>
  21 #include <ModelAPI_Feature.h>
  22 #include <ModelAPI_Data.h>
  23 #include <ModelAPI_Document.h>
  24 #include <ModelAPI_Events.h>
  25 #include <ModelAPI_Result.h>
  26 #include <ModelAPI_Object.h>
  27 #include <ModelAPI_Validator.h>
  28 #include <ModelAPI_Session.h>
  29
  30 #include <GeomAPI_Pnt2d.h>
  31
  32 #include <Events_Loop.h>
  33
  34 #include <QTimer>
  35
  36 #ifdef _DEBUG
  37 #include <QDebug>
  38 #endif
  39
  40 ModuleBase_Operation::ModuleBase_Operation(const QString& theId, QObject* theParent)
  41     : QObject(theParent),
  42       myIsEditing(false),
  43       myIsModified(false),
  44       myPropertyPanel(NULL)
  45 {
  46   myDescription = new ModuleBase_OperationDescription(theId);
  47 }
  48
  49 ModuleBase_Operation::~ModuleBase_Operation()
  50 {
  51   delete myDescription;
  52   clearPreselection();
  53 }
  54
  55 QString ModuleBase_Operation::id() const
  56 {
  57   return getDescription()->operationId();
  58 }
  59
  60 FeaturePtr ModuleBase_Operation::feature() const
  61 {
  62   return myFeature;
  63 }
  64
  65 bool ModuleBase_Operation::isValid() const
  66 {
  67   if (!myFeature || !myFeature->data()->isValid())
  68     return true; // rename operation
  69   if (myFeature->isAction())
  70     return true;
  71   //Get validators for the Id
  72   SessionPtr aMgr = ModelAPI_Session::get();
  73   ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
  74   bool aValid = aFactory->validate(myFeature);
  75
  76   // the feature exec state should be checked in order to do not apply features, which result can not
  77   // be built. E.g. extrusion on sketch, where the "to" is a perpendicular plane to the sketch
  78   bool isDone = ( myFeature->data()->execState() == ModelAPI_StateDone
  79                || myFeature->data()->execState() == ModelAPI_StateMustBeUpdated );
  80
  81   return aValid && isDone;
  82 }
  83
  84
  85 bool ModuleBase_Operation::canBeCommitted() const
  86 {
  87   return isValid();
  88 }
  89
  90 FeaturePtr ModuleBase_Operation::createFeature(const bool theFlushMessage)
  91 {
  92   if (myParentFeature.get()) {
  93     myFeature = myParentFeature->addFeature(getDescription()->operationId().toStdString());
  94   } else {
  95     std::shared_ptr<ModelAPI_Document> aDoc = ModelAPI_Session::get()->activeDocument();
  96     myFeature = aDoc->addFeature(getDescription()->operationId().toStdString());
  97   }
  98   if (myFeature) {  // TODO: generate an error if feature was not created
  99     myIsModified = true;
 100     // Model update should call "execute" of a feature.
 101     //myFeature->execute();
 102     // Init default values
 103     /*QList<ModuleBase_ModelWidget*> aWidgets = getDescription()->modelWidgets();
 104      QList<ModuleBase_ModelWidget*>::const_iterator anIt = aWidgets.begin(), aLast = aWidgets.end();
 105      for (; anIt != aLast; anIt++) {
 106      (*anIt)->storeValue(aFeature);
 107      }*/
 108   }
 109
 110   if (theFlushMessage)
 111     Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
 112   return myFeature;
 113 }
 114
 115 void ModuleBase_Operation::setFeature(FeaturePtr theFeature)
 116 {
 117   myFeature = theFeature;
 118   myIsEditing = true;
 119 }
 120
 121 bool ModuleBase_Operation::hasObject(ObjectPtr theObj) const
 122 {
 123   FeaturePtr aFeature = feature();
 124   if (aFeature) {
 125     if (aFeature == theObj)
 126       return true;
 127     std::list<ResultPtr> aResults = aFeature->results();
 128     std::list<ResultPtr>::const_iterator aIt;
 129     for (aIt = aResults.cbegin(); aIt != aResults.cend(); ++aIt) {
 130       if (theObj == (*aIt))
 131         return true;
 132     }
 133   }
 134   return false;
 135 }
 136
 137 void ModuleBase_Operation::start()
 138 {
 139   QString anId = getDescription()->operationId();
 140   if (myIsEditing) {
 141     anId = anId.append(EditSuffix());
 142   }
 143   ModelAPI_Session::get()->startOperation(anId.toStdString());
 144
 145   if (!myIsEditing) {
 146     FeaturePtr aFeature = createFeature();
 147     // if the feature is not created, there is no sense to start the operation
 148     if (aFeature.get() == NULL) {
 149       // it is necessary to abor the operation in the session and emit the aborted signal
 150       // in order to update commands status in the workshop, to be exact the feature action
 151       // to be unchecked
 152       abort();
 153       return;
 154     }
 155   }
 156   /// Set current feature and remeber old current feature
 157   if (myIsEditing) {
 158     SessionPtr aMgr = ModelAPI_Session::get();
 159     DocumentPtr aDoc = aMgr->activeDocument();
 160     myCurrentFeature = aDoc->currentFeature(true);
 161     aDoc->setCurrentFeature(feature(), false);
 162   }
 163
 164   startOperation();
 165   emit started();
 166
 167 }
 168
 169 void ModuleBase_Operation::postpone()
 170 {
 171   postponeOperation();
 172   emit postponed();
 173 }
 174
 175 void ModuleBase_Operation::resume()
 176 {
 177   resumeOperation();
 178   emit resumed();
 179 }
 180
 181 void ModuleBase_Operation::abort()
 182 {
 183   // the viewer update should be blocked in order to avoid the features blinking before they are
 184   // hidden
 185   std::shared_ptr<Events_Message> aMsg = std::shared_ptr<Events_Message>(
 186       new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED)));
 187   Events_Loop::loop()->send(aMsg);
 188
 189   SessionPtr aMgr = ModelAPI_Session::get();
 190   if (myIsEditing) {
 191     DocumentPtr aDoc = aMgr->activeDocument();
 192     bool aIsOp = aMgr->isOperation();
 193     if (!aIsOp)
 194       aMgr->startOperation();
 195     aDoc->setCurrentFeature(myCurrentFeature, true);
 196     if (!aIsOp)
 197       aMgr->finishOperation();
 198     myCurrentFeature = FeaturePtr();
 199   }
 200   abortOperation();
 201
 202   stopOperation();
 203   // is is necessary to deactivate current widgets before the model operation is aborted
 204   // because abort removes the feature and activated filters should not check it
 205   propertyPanel()->cleanContent();
 206
 207   aMgr->abortOperation();
 208   emit stopped();
 209   // the viewer update should be unblocked in order to avoid the features blinking before they are
 210   // hidden
 211   aMsg = std::shared_ptr<Events_Message>(
 212                 new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED)));
 213
 214   Events_Loop::loop()->send(aMsg);
 215
 216   emit aborted();
 217 }
 218
 219 bool ModuleBase_Operation::commit()
 220 {
 221   if (canBeCommitted()) {
 222     SessionPtr aMgr = ModelAPI_Session::get();
 223     /// Set current feature and remeber old current feature
 224     if (myIsEditing) {
 225       DocumentPtr aDoc = aMgr->activeDocument();
 226       bool aIsOp = aMgr->isOperation();
 227       if (!aIsOp)
 228         aMgr->startOperation();
 229       aDoc->setCurrentFeature(myCurrentFeature, true);
 230       if (!aIsOp)
 231         aMgr->finishOperation();
 232       myCurrentFeature = FeaturePtr();
 233     }
 234     commitOperation();
 235     // check whether there are modifications performed during the current operation
 236     // in the model
 237     // in case if there are no modifications, do not increase the undo/redo stack
 238     if (aMgr->isModified())
 239       aMgr->finishOperation();
 240     else
 241       aMgr->abortOperation();
 242
 243     stopOperation();
 244     emit stopped();
 245     emit committed();
 246
 247     afterCommitOperation();
 248     return true;
 249   }
 250   return false;
 251 }
 252
 253 void ModuleBase_Operation::setRunning(bool theState)
 254 {
 255   emit triggered(theState);
 256 }
 257
 258 //TODO: nds stabilization hotfix
 259 void ModuleBase_Operation::commitOperation()
 260 {
 261   if(!myPropertyPanel) {
 262     return;
 263   }
 264   ModuleBase_ModelWidget* aWidget = myPropertyPanel->activeWidget();
 265   if (aWidget)
 266     aWidget->disconnectSignals();
 267 }
 268
 269 void ModuleBase_Operation::activateByPreselection()
 270 {
 271   if (!myPropertyPanel || myPreSelection.empty()) {
 272     myPropertyPanel->activateNextWidget(NULL);
 273     return;
 274   }
 275   const QList<ModuleBase_ModelWidget*>& aWidgets = myPropertyPanel->modelWidgets();
 276   if (aWidgets.empty()) {
 277     myPropertyPanel->activateNextWidget(NULL);
 278     return;
 279   }
 280
 281   ModuleBase_ModelWidget* aWgt, *aFilledWgt = 0;
 282   QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
 283   bool isSet = false;
 284   // 1. apply the selection to controls
 285   int aCurrentPosition = 0;
 286   for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
 287     aWgt = (*aWIt);
 288     if (!aWgt->canSetValue())
 289       continue;
 290
 291     if (!aWgt->setSelection(myPreSelection, aCurrentPosition/*aValue*/)) {
 292       isSet = false;
 293       break;
 294     } else {
 295       isSet = true;
 296       aFilledWgt = aWgt;
 297     }
 298   }
 299   // 2. ignore not obligatory widgets
 300   /*for (; aWIt != aWidgets.constEnd(); ++aWIt) {
 301     aWgt = (*aWIt);
 302     if (aWgt && aWgt->isObligatory())
 303       continue;
 304     aFilledWgt = aWgt;
 305   }*/
 306
 307   // 3. a signal should be emitted before the next widget activation
 308   // because, the activation of the next widget will give a focus to the widget. As a result
 309   // the value of the widget is initialized. And commit may happens until the value is entered.
 310   if (aFilledWgt)
 311     emit activatedByPreselection();
 312
 313   // 4. activate the next obligatory widget
 314   myPropertyPanel->activateNextWidget(aFilledWgt);
 315 }
 316
 317 void ModuleBase_Operation::setParentFeature(CompositeFeaturePtr theParent)
 318 {
 319   myParentFeature = theParent;
 320 }
 321
 322 CompositeFeaturePtr ModuleBase_Operation::parentFeature() const
 323 {
 324   return myParentFeature;
 325 }
 326
 327 void ModuleBase_Operation::initSelection(ModuleBase_ISelection* theSelection,
 328                                          ModuleBase_IViewer* theViewer)
 329 {
 330   clearPreselection();
 331
 332   QList<ModuleBase_ViewerPrs> aPreSelected;
 333   // Check that the selected result are not results of operation feature
 334   FeaturePtr aFeature = feature();
 335   if (aFeature) {
 336     QList<ModuleBase_ViewerPrs> aSelected = theSelection->getSelected();
 337
 338     std::list<ResultPtr> aResults = aFeature->results();
 339     QObjectPtrList aResList;
 340     std::list<ResultPtr>::const_iterator aIt;
 341     for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt)
 342       aResList.append(*aIt);
 343
 344     foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
 345       if ((!aResList.contains(aPrs.object())) && (aPrs.object() != aFeature))
 346         aPreSelected.append(aPrs);
 347     }
 348   } else
 349     aPreSelected = theSelection->getSelected();
 350
 351   // convert the selection values to the values, which are set to the operation widgets
 352
 353   //Handle(V3d_View) aView = theViewer->activeView();
 354   //foreach (ModuleBase_ViewerPrs aPrs, aPreSelected) {
 355   //  ModuleBase_WidgetValueFeature* aValue = new ModuleBase_WidgetValueFeature();
 356   //  aValue->setObject(aPrs.object());
 357
 358   //  double aX, anY;
 359   //  if (getViewerPoint(aPrs, theViewer, aX, anY))
 360   //    aValue->setPoint(std::shared_ptr<GeomAPI_Pnt2d>(new GeomAPI_Pnt2d(aX, anY)));
 361   //  myPreSelection.append(aValue);
 362   //}
 363   myPreSelection = aPreSelected;
 364 }
 365
 366
 367 bool ModuleBase_Operation::getViewerPoint(ModuleBase_ViewerPrs thePrs,
 368                                                ModuleBase_IViewer* theViewer,
 369                                                double& theX, double& theY)
 370 {
 371   return false;
 372 }
 373
 374 void ModuleBase_Operation::clearPreselection()
 375 {
 376   myPreSelection.clear();
 377 }
 378
 379 void ModuleBase_Operation::setPropertyPanel(ModuleBase_IPropertyPanel* theProp)
 380 {
 381   myPropertyPanel = theProp;
 382   myPropertyPanel->setEditingMode(isEditOperation());
 383
 384   // Do not activate widgets by default if the current operation is editing operation
 385   // Because we don't know which widget is going to be edited.
 386   if (!isEditOperation())
 387     activateByPreselection();
 388 }
 389
 390 bool ModuleBase_Operation::isGranted(QString theId) const
 391 {
 392   return myNestedFeatures.contains(theId);
 393 }