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