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)
  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   return aFactory->validate(myFeature);
  75 }
  76
  77
  78 bool ModuleBase_Operation::canBeCommitted() const
  79 {
  80   return isValid();
  81 }
  82
  83 FeaturePtr ModuleBase_Operation::createFeature(const bool theFlushMessage)
  84 {
  85   if (myParentFeature.get()) {
  86     myFeature = myParentFeature->addFeature(getDescription()->operationId().toStdString());
  87   } else {
  88     std::shared_ptr<ModelAPI_Document> aDoc = ModelAPI_Session::get()->activeDocument();
  89     myFeature = aDoc->addFeature(getDescription()->operationId().toStdString());
  90   }
  91   if (myFeature) {  // TODO: generate an error if feature was not created
  92     myIsModified = true;
  93     // Model update should call "execute" of a feature.
  94     //myFeature->execute();
  95     // Init default values
  96     /*QList<ModuleBase_ModelWidget*> aWidgets = getDescription()->modelWidgets();
  97      QList<ModuleBase_ModelWidget*>::const_iterator anIt = aWidgets.begin(), aLast = aWidgets.end();
  98      for (; anIt != aLast; anIt++) {
  99      (*anIt)->storeValue(aFeature);
 100      }*/
 101   }
 102
 103   if (theFlushMessage)
 104     Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
 105   return myFeature;
 106 }
 107
 108 void ModuleBase_Operation::setFeature(FeaturePtr theFeature)
 109 {
 110   myFeature = theFeature;
 111   myIsEditing = true;
 112 }
 113
 114 bool ModuleBase_Operation::hasObject(ObjectPtr theObj) const
 115 {
 116   FeaturePtr aFeature = feature();
 117   if (aFeature) {
 118     if (aFeature == theObj)
 119       return true;
 120     std::list<ResultPtr> aResults = aFeature->results();
 121     std::list<ResultPtr>::const_iterator aIt;
 122     for (aIt = aResults.cbegin(); aIt != aResults.cend(); ++aIt) {
 123       if (theObj == (*aIt))
 124         return true;
 125     }
 126   }
 127   return false;
 128 }
 129
 130 void ModuleBase_Operation::start()
 131 {
 132   QString anId = getDescription()->operationId();
 133   if (myIsEditing) {
 134       anId = anId.append(EditSuffix());
 135   }
 136   ModelAPI_Session::get()->startOperation(anId.toStdString());
 137
 138   if (!myIsEditing) {
 139     FeaturePtr aFeature = createFeature();
 140     // if the feature is not created, there is no sense to start the operation
 141     if (aFeature.get() == NULL) {
 142       // it is necessary to abor the operation in the session and emit the aborted signal
 143       // in order to update commands status in the workshop, to be exact the feature action
 144       // to be unchecked
 145       abort();
 146       return;
 147     }
 148   }
 149
 150   startOperation();
 151   emit started();
 152
 153 }
 154
 155 void ModuleBase_Operation::postpone()
 156 {
 157   postponeOperation();
 158   emit postponed();
 159 }
 160
 161 void ModuleBase_Operation::resume()
 162 {
 163   resumeOperation();
 164   emit resumed();
 165 }
 166
 167 void ModuleBase_Operation::abort()
 168 {
 169   abortOperation();
 170   emit aborted();
 171
 172   stopOperation();
 173
 174   ModelAPI_Session::get()->abortOperation();
 175   emit stopped();
 176 }
 177
 178 bool ModuleBase_Operation::commit()
 179 {
 180   if (canBeCommitted()) {
 181     commitOperation();
 182     // check whether there are modifications performed during the current operation
 183     // in the model
 184     // in case if there are no modifications, do not increase the undo/redo stack
 185     if (ModelAPI_Session::get()->isModified())
 186       ModelAPI_Session::get()->finishOperation();
 187     else
 188       ModelAPI_Session::get()->abortOperation();
 189
 190     stopOperation();
 191     emit stopped();
 192     emit committed();
 193
 194     afterCommitOperation();
 195     return true;
 196   }
 197   return false;
 198 }
 199
 200 void ModuleBase_Operation::setRunning(bool theState)
 201 {
 202   if (!theState) {
 203     abort();
 204   }
 205 }
 206
 207 void ModuleBase_Operation::activateByPreselection()
 208 {
 209   if (!myPropertyPanel || myPreSelection.empty()) {
 210     myPropertyPanel->activateNextWidget(NULL);
 211     return;
 212   }
 213   const QList<ModuleBase_ModelWidget*>& aWidgets = myPropertyPanel->modelWidgets();
 214   if (aWidgets.empty()) {
 215     myPropertyPanel->activateNextWidget(NULL);
 216     return;
 217   }
 218
 219   ModuleBase_ModelWidget* aWgt, *aFilledWgt = 0;
 220   QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
 221   QList<ModuleBase_ViewerPrs>::const_iterator aPIt;
 222   bool isSet = false;
 223   // 1. apply the selection to controls
 224   for (aWIt = aWidgets.constBegin(), aPIt = myPreSelection.constBegin();
 225        (aWIt != aWidgets.constEnd()) && (aPIt != myPreSelection.constEnd());
 226        ++aWIt) {
 227     aWgt = (*aWIt);
 228     ModuleBase_ViewerPrs aValue = (*aPIt);
 229     if (!aWgt->canSetValue())
 230       continue;
 231
 232     ++aPIt;
 233     if (!aWgt->setSelection(aValue)) {
 234       isSet = false;
 235       break;
 236     } else {
 237       isSet = true;
 238       aFilledWgt = aWgt;
 239     }
 240   }
 241   // 2. ignore not obligatory widgets
 242   for (; aWIt != aWidgets.constEnd(); ++aWIt) {
 243     aWgt = (*aWIt);
 244     if (aWgt && aWgt->isObligatory())
 245       continue;
 246     aFilledWgt = aWgt;
 247   }
 248
 249   // 3. activate the next obligatory widget
 250   myPropertyPanel->activateNextWidget(aFilledWgt);
 251   if (aFilledWgt)
 252     emit activatedByPreselection();
 253
 254 }
 255
 256 void ModuleBase_Operation::setParentFeature(CompositeFeaturePtr theParent)
 257 {
 258   myParentFeature = theParent;
 259 }
 260
 261 CompositeFeaturePtr ModuleBase_Operation::parentFeature() const
 262 {
 263   return myParentFeature;
 264 }
 265
 266 void ModuleBase_Operation::initSelection(ModuleBase_ISelection* theSelection,
 267                                          ModuleBase_IViewer* theViewer)
 268 {
 269   clearPreselection();
 270
 271   QList<ModuleBase_ViewerPrs> aPreSelected;
 272   // Check that the selected result are not results of operation feature
 273   FeaturePtr aFeature = feature();
 274   if (aFeature) {
 275     QList<ModuleBase_ViewerPrs> aSelected = theSelection->getSelected();
 276
 277     std::list<ResultPtr> aResults = aFeature->results();
 278     QObjectPtrList aResList;
 279     std::list<ResultPtr>::const_iterator aIt;
 280     for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt)
 281       aResList.append(*aIt);
 282
 283     foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
 284       if ((!aResList.contains(aPrs.object())) && (aPrs.object() != aFeature))
 285         aPreSelected.append(aPrs);
 286     }
 287   } else
 288     aPreSelected = theSelection->getSelected();
 289
 290   // convert the selection values to the values, which are set to the operation widgets
 291
 292   //Handle(V3d_View) aView = theViewer->activeView();
 293   //foreach (ModuleBase_ViewerPrs aPrs, aPreSelected) {
 294   //  ModuleBase_WidgetValueFeature* aValue = new ModuleBase_WidgetValueFeature();
 295   //  aValue->setObject(aPrs.object());
 296
 297   //  double aX, anY;
 298   //  if (getViewerPoint(aPrs, theViewer, aX, anY))
 299   //    aValue->setPoint(std::shared_ptr<GeomAPI_Pnt2d>(new GeomAPI_Pnt2d(aX, anY)));
 300   //  myPreSelection.append(aValue);
 301   //}
 302   myPreSelection = aPreSelected;
 303 }
 304
 305 //void ModuleBase_Operation::onWidgetActivated(ModuleBase_ModelWidget* theWidget)
 306 //{
 307 //  //activateByPreselection();
 308 //  //if (theWidget && myPropertyPanel) {
 309 //  //  myPropertyPanel->activateNextWidget();
 310 //  ////  //emit activateNextWidget(myActiveWidget);
 311 //  //}
 312 //}
 313
 314 //bool ModuleBase_Operation::setWidgetValue(ObjectPtr theFeature, double theX, double theY)
 315 //{
 316 //  ModuleBase_ModelWidget* aActiveWgt = myPropertyPanel->activeWidget();
 317 //  if (!aActiveWgt)
 318 //    return false;
 319 //  ModuleBase_WidgetValueFeature* aValue = new ModuleBase_WidgetValueFeature();
 320 //  aValue->setObject(theFeature);
 321 //  aValue->setPoint(std::shared_ptr<GeomAPI_Pnt2d>(new GeomAPI_Pnt2d(theX, theY)));
 322 //  bool isApplyed = aActiveWgt->setValue(aValue);
 323 //
 324 //  delete aValue;
 325 //  myIsModified = (myIsModified || isApplyed);
 326 //  return isApplyed;
 327 //}
 328
 329 bool ModuleBase_Operation::getViewerPoint(ModuleBase_ViewerPrs thePrs,
 330                                                ModuleBase_IViewer* theViewer,
 331                                                double& theX, double& theY)
 332 {
 333   return false;
 334 }
 335
 336 void ModuleBase_Operation::clearPreselection()
 337 {
 338   myPreSelection.clear();
 339 }
 340
 341 void ModuleBase_Operation::setPropertyPanel(ModuleBase_IPropertyPanel* theProp)
 342 {
 343   myPropertyPanel = theProp;
 344   myPropertyPanel->setEditingMode(isEditOperation());
 345
 346   // Do not activate widgets by default if the current operation is editing operation
 347   // Because we don't know which widget is going to be edited.
 348   if (!isEditOperation())
 349     activateByPreselection();
 350 }
 351
 352 bool ModuleBase_Operation::isGranted(QString theId) const
 353 {
 354   return myNestedFeatures.contains(theId);
 355 }