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   myIsModified = false;
 140   QString anId = getDescription()->operationId();
 141   if (myIsEditing) {
 142     anId = anId.append(EditSuffix());
 143   }
 144   ModelAPI_Session::get()->startOperation(anId.toStdString());
 145
 146   if (!myIsEditing) {
 147     FeaturePtr aFeature = createFeature();
 148     // if the feature is not created, there is no sense to start the operation
 149     if (aFeature.get() == NULL) {
 150       // it is necessary to abor the operation in the session and emit the aborted signal
 151       // in order to update commands status in the workshop, to be exact the feature action
 152       // to be unchecked
 153       abort();
 154       return;
 155     }
 156   }
 157   /// Set current feature and remeber old current feature
 158   if (myIsEditing) {
 159     SessionPtr aMgr = ModelAPI_Session::get();
 160     DocumentPtr aDoc = aMgr->activeDocument();
 161     myCurrentFeature = aDoc->currentFeature(true);
 162     aDoc->setCurrentFeature(feature(), false);
 163   }
 164
 165   startOperation();
 166   emit started();
 167
 168 }
 169
 170 void ModuleBase_Operation::postpone()
 171 {
 172   postponeOperation();
 173   emit postponed();
 174 }
 175
 176 void ModuleBase_Operation::resume()
 177 {
 178   resumeOperation();
 179   emit resumed();
 180 }
 181
 182 void ModuleBase_Operation::abort()
 183 {
 184   // the viewer update should be blocked in order to avoid the features blinking before they are
 185   // hidden
 186   std::shared_ptr<Events_Message> aMsg = std::shared_ptr<Events_Message>(
 187       new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED)));
 188   Events_Loop::loop()->send(aMsg);
 189
 190   SessionPtr aMgr = ModelAPI_Session::get();
 191   if (myIsEditing) {
 192     DocumentPtr aDoc = aMgr->activeDocument();
 193     bool aIsOp = aMgr->isOperation();
 194     if (!aIsOp)
 195       aMgr->startOperation();
 196     aDoc->setCurrentFeature(myCurrentFeature, true);
 197     if (!aIsOp)
 198       aMgr->finishOperation();
 199     myCurrentFeature = FeaturePtr();
 200   }
 201   abortOperation();
 202
 203   stopOperation();
 204   // is is necessary to deactivate current widgets before the model operation is aborted
 205   // because abort removes the feature and activated filters should not check it
 206   propertyPanel()->cleanContent();
 207
 208   aMgr->abortOperation();
 209   emit stopped();
 210   // the viewer update should be unblocked in order to avoid the features blinking before they are
 211   // hidden
 212   aMsg = std::shared_ptr<Events_Message>(
 213                 new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED)));
 214
 215   Events_Loop::loop()->send(aMsg);
 216
 217   emit aborted();
 218 }
 219
 220 bool ModuleBase_Operation::commit()
 221 {
 222   if (canBeCommitted()) {
 223     SessionPtr aMgr = ModelAPI_Session::get();
 224     /// Set current feature and remeber old current feature
 225     if (myIsEditing) {
 226       DocumentPtr aDoc = aMgr->activeDocument();
 227       bool aIsOp = aMgr->isOperation();
 228       if (!aIsOp)
 229         aMgr->startOperation();
 230       aDoc->setCurrentFeature(myCurrentFeature, true);
 231       if (!aIsOp)
 232         aMgr->finishOperation();
 233       myCurrentFeature = FeaturePtr();
 234     }
 235     commitOperation();
 236     aMgr->finishOperation();
 237
 238     stopOperation();
 239     emit stopped();
 240     emit committed();
 241
 242     afterCommitOperation();
 243     return true;
 244   }
 245   return false;
 246 }
 247
 248 void ModuleBase_Operation::setRunning(bool theState)
 249 {
 250   emit triggered(theState);
 251 }
 252
 253 void ModuleBase_Operation::onValuesChanged()
 254 {
 255   myIsModified = true;
 256 }
 257
 258 void ModuleBase_Operation::commitOperation()
 259 {
 260   if(!myPropertyPanel) {
 261     return;
 262   }
 263 }
 264
 265 void ModuleBase_Operation::activateByPreselection()
 266 {
 267   if (myPreSelection.empty())
 268     return;
 269
 270   ModuleBase_ModelWidget* aFilledWgt = 0;
 271   if (myPropertyPanel) {
 272     const QList<ModuleBase_ModelWidget*>& aWidgets = myPropertyPanel->modelWidgets();
 273     if (!aWidgets.empty()) {
 274       ModuleBase_ModelWidget* aWgt = 0;
 275       QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
 276       bool isSet = false;
 277       // 1. apply the selection to controls
 278       for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
 279         aWgt = (*aWIt);
 280         if (!aWgt->canSetValue())
 281           continue;
 282         myPropertyPanel->setPreselectionWidget(aWgt);
 283         if (!aWgt->setSelection(myPreSelection, true)) {
 284           isSet = false;
 285           break;
 286         } else {
 287           isSet = true;
 288           aFilledWgt = aWgt;
 289         }
 290       }
 291       myPropertyPanel->setPreselectionWidget(NULL);
 292       // in order to redisplay object in the viewer, the update/redisplay signals should be flushed
 293       // it is better to perform it not in setSelection of each widget, but do it here,
 294       // after the preselection is processed
 295       ModuleBase_ModelWidget::updateObject(myFeature);
 296
 297       // 3. a signal should be emitted before the next widget activation
 298       // because, the activation of the next widget will give a focus to the widget. As a result
 299       // the value of the widget is initialized. And commit may happens until the value is entered.
 300       if (aFilledWgt)
 301         emit activatedByPreselection();
 302     }
 303     // 4. activate the next obligatory widget
 304     myPropertyPanel->activateNextWidget(aFilledWgt);
 305   }
 306
 307   clearPreselection();
 308 }
 309
 310 void ModuleBase_Operation::setParentFeature(CompositeFeaturePtr theParent)
 311 {
 312   myParentFeature = theParent;
 313 }
 314
 315 CompositeFeaturePtr ModuleBase_Operation::parentFeature() const
 316 {
 317   return myParentFeature;
 318 }
 319
 320 void ModuleBase_Operation::initSelection(ModuleBase_ISelection* theSelection,
 321                                          ModuleBase_IViewer* theViewer)
 322 {
 323   clearPreselection();
 324
 325   QList<ModuleBase_ViewerPrs> aPreSelected;
 326   // Check that the selected result are not results of operation feature
 327   FeaturePtr aFeature = feature();
 328   if (aFeature) {
 329     QList<ModuleBase_ViewerPrs> aSelected = theSelection->getSelected(ModuleBase_ISelection::AllControls);
 330
 331     std::list<ResultPtr> aResults = aFeature->results();
 332     QObjectPtrList aResList;
 333     std::list<ResultPtr>::const_iterator aIt;
 334     for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt)
 335       aResList.append(*aIt);
 336
 337     foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
 338       if ((!aResList.contains(aPrs.object())) && (aPrs.object() != aFeature))
 339         aPreSelected.append(aPrs);
 340     }
 341   } else
 342     aPreSelected = theSelection->getSelected(ModuleBase_ISelection::AllControls);
 343
 344   // convert the selection values to the values, which are set to the operation widgets
 345
 346   //Handle(V3d_View) aView = theViewer->activeView();
 347   //foreach (ModuleBase_ViewerPrs aPrs, aPreSelected) {
 348   //  ModuleBase_WidgetValueFeature* aValue = new ModuleBase_WidgetValueFeature();
 349   //  aValue->setObject(aPrs.object());
 350
 351   //  double aX, anY;
 352   //  if (getViewerPoint(aPrs, theViewer, aX, anY))
 353   //    aValue->setPoint(std::shared_ptr<GeomAPI_Pnt2d>(new GeomAPI_Pnt2d(aX, anY)));
 354   //  myPreSelection.append(aValue);
 355   //}
 356   myPreSelection = aPreSelected;
 357 }
 358
 359
 360 bool ModuleBase_Operation::getViewerPoint(ModuleBase_ViewerPrs thePrs,
 361                                                ModuleBase_IViewer* theViewer,
 362                                                double& theX, double& theY)
 363 {
 364   return false;
 365 }
 366
 367 void ModuleBase_Operation::clearPreselection()
 368 {
 369   myPreSelection.clear();
 370 }
 371
 372 void ModuleBase_Operation::setPropertyPanel(ModuleBase_IPropertyPanel* theProp)
 373 {
 374   myPropertyPanel = theProp;
 375   myPropertyPanel->setEditingMode(isEditOperation());
 376
 377   if (myPropertyPanel) {
 378     const QList<ModuleBase_ModelWidget*>& aWidgets = myPropertyPanel->modelWidgets();
 379     QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
 380     for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
 381       ModuleBase_ModelWidget* aWgt = (*aWIt);
 382       connect(aWgt, SIGNAL(valuesChanged()), this, SLOT(onValuesChanged()));
 383     }
 384   }
 385
 386   // Do not activate widgets by default if the current operation is editing operation
 387   // Because we don't know which widget is going to be edited.
 388   if (!isEditOperation()) {
 389     // 4. activate the first obligatory widget
 390     myPropertyPanel->activateNextWidget(NULL);
 391   }
 392 }
 393
 394 bool ModuleBase_Operation::isGranted(QString theId) const
 395 {
 396   return myNestedFeatures.contains(theId);
 397 }