src/ModuleBase/ModuleBase_Operation.cpp

   1 /*
   2  * ModuleBase_Operation.cpp
   3  *
   4  *  Created on: Apr 2, 2014
   5  *      Author: sbh
   6  */
   7
   8 #include "ModuleBase_Operation.h"
   9
  10 #include "ModuleBase_OperationDescription.h"
  11 #include "ModuleBase_ModelWidget.h"
  12 #include "ModuleBase_ViewerPrs.h"
  13 #include "ModuleBase_IPropertyPanel.h"
  14 #include "ModuleBase_ISelection.h"
  15 #include "ModuleBase_IViewer.h"
  16
  17 #include <ModelAPI_AttributeDouble.h>
  18 #include <ModelAPI_Document.h>
  19 #include <ModelAPI_Feature.h>
  20 #include <ModelAPI_Data.h>
  21 #include <ModelAPI_Document.h>
  22 #include <ModelAPI_Events.h>
  23 #include <ModelAPI_Result.h>
  24 #include <ModelAPI_Object.h>
  25 #include <ModelAPI_Validator.h>
  26 #include <ModelAPI_Session.h>
  27
  28 #include <GeomAPI_Pnt2d.h>
  29
  30 #include <Events_Loop.h>
  31
  32 #include <QTimer>
  33
  34 #ifdef _DEBUG
  35 #include <QDebug>
  36 #endif
  37
  38 ModuleBase_Operation::ModuleBase_Operation(const QString& theId, QObject* theParent)
  39     : QObject(theParent),
  40       myIsEditing(false),
  41       myIsModified(false),
  42       myPropertyPanel(NULL)
  43 {
  44   myDescription = new ModuleBase_OperationDescription(theId);
  45 }
  46
  47 ModuleBase_Operation::~ModuleBase_Operation()
  48 {
  49   delete myDescription;
  50   clearPreselection();
  51 }
  52
  53 QString ModuleBase_Operation::id() const
  54 {
  55   return getDescription()->operationId();
  56 }
  57
  58 FeaturePtr ModuleBase_Operation::feature() const
  59 {
  60   return myFeature;
  61 }
  62
  63 bool ModuleBase_Operation::isValid() const
  64 {
  65   if (!myFeature)
  66     return true; // rename operation
  67   //Get validators for the Id
  68   SessionPtr aMgr = ModelAPI_Session::get();
  69   ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
  70   return aFactory->validate(myFeature);
  71 }
  72
  73 bool ModuleBase_Operation::isNestedOperationsEnabled() const
  74 {
  75   return true;
  76 }
  77
  78 //void ModuleBase_Operation::storeCustomValue()
  79 //{
  80 //  if (!myFeature) {
  81 //#ifdef _DEBUG
  82 //    qDebug() << "ModuleBase_Operation::storeCustom: " <<
  83 //    "trying to store value without opening a transaction.";
  84 //#endif
  85 //    return;
  86 //  }
  87 //
  88 //  ModuleBase_ModelWidget* aCustom = dynamic_cast<ModuleBase_ModelWidget*>(sender());
  89 //  if (aCustom)
  90 //    aCustom->storeValue();
  91 //}
  92
  93
  94 bool ModuleBase_Operation::canBeCommitted() const
  95 {
  96   return isValid();
  97 }
  98
  99 void ModuleBase_Operation::flushUpdated()
 100 {
 101   Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
 102 }
 103
 104 void ModuleBase_Operation::flushCreated()
 105 {
 106   Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
 107 }
 108
 109 FeaturePtr ModuleBase_Operation::createFeature(const bool theFlushMessage)
 110 {
 111   if (myParentFeature) {
 112     myFeature = myParentFeature->addFeature(getDescription()->operationId().toStdString());
 113   } else {
 114     std::shared_ptr<ModelAPI_Document> aDoc = document();
 115     myFeature = aDoc->addFeature(getDescription()->operationId().toStdString());
 116   }
 117   if (myFeature) {  // TODO: generate an error if feature was not created
 118     myIsModified = true;
 119     // Model update should call "execute" of a feature.
 120     //myFeature->execute();
 121     // Init default values
 122     /*QList<ModuleBase_ModelWidget*> aWidgets = getDescription()->modelWidgets();
 123      QList<ModuleBase_ModelWidget*>::const_iterator anIt = aWidgets.begin(), aLast = aWidgets.end();
 124      for (; anIt != aLast; anIt++) {
 125      (*anIt)->storeValue(aFeature);
 126      }*/
 127   }
 128
 129   if (theFlushMessage)
 130     flushCreated();
 131   return myFeature;
 132 }
 133
 134 void ModuleBase_Operation::setFeature(FeaturePtr theFeature)
 135 {
 136   myFeature = theFeature;
 137   myIsEditing = true;
 138 }
 139
 140 bool ModuleBase_Operation::hasObject(ObjectPtr theObj) const
 141 {
 142   FeaturePtr aFeature = feature();
 143   if (aFeature) {
 144     if (aFeature == theObj)
 145       return true;
 146     std::list<ResultPtr> aResults = aFeature->results();
 147     std::list<ResultPtr>::const_iterator aIt;
 148     for (aIt = aResults.cbegin(); aIt != aResults.cend(); ++aIt) {
 149       if (theObj == (*aIt))
 150         return true;
 151     }
 152   }
 153   return false;
 154 }
 155
 156
 157 std::shared_ptr<ModelAPI_Document> ModuleBase_Operation::document() const
 158 {
 159   return ModelAPI_Session::get()->moduleDocument();
 160 }
 161
 162
 163 void ModuleBase_Operation::start()
 164 {
 165   ModelAPI_Session::get()->startOperation();
 166
 167   if (!myIsEditing)
 168     createFeature();
 169
 170   startOperation();
 171   emit started();
 172
 173 }
 174
 175 void ModuleBase_Operation::postpone()
 176 {
 177   if (myPropertyPanel)
 178     disconnect(myPropertyPanel, 0, this, 0);
 179   emit postponed();
 180 }
 181
 182 void ModuleBase_Operation::resume()
 183 {
 184   //  connect(myPropertyPanel, SIGNAL(widgetActivated(ModuleBase_ModelWidget*)),
 185   //          this,            SLOT(onWidgetActivated(ModuleBase_ModelWidget*)));
 186   emit resumed();
 187 }
 188
 189 void ModuleBase_Operation::abort()
 190 {
 191   abortOperation();
 192   emit aborted();
 193   if (myPropertyPanel)
 194     disconnect(myPropertyPanel, 0, this, 0);
 195
 196   stopOperation();
 197
 198   ModelAPI_Session::get()->abortOperation();
 199   emit stopped();
 200 }
 201
 202 bool ModuleBase_Operation::commit()
 203 {
 204   if (canBeCommitted()) {
 205     if (myPropertyPanel)
 206       disconnect(myPropertyPanel, 0, this, 0);
 207
 208     commitOperation();
 209     // check whether there are modifications performed during the current operation
 210     // in the model
 211     // in case if there are no modifications, do not increase the undo/redo stack
 212     if (ModelAPI_Session::get()->isModified())
 213       ModelAPI_Session::get()->finishOperation();
 214     else
 215       ModelAPI_Session::get()->abortOperation();
 216
 217     stopOperation();
 218     emit stopped();
 219     emit committed();
 220
 221     afterCommitOperation();
 222     return true;
 223   }
 224   return false;
 225 }
 226
 227 void ModuleBase_Operation::setRunning(bool theState)
 228 {
 229   if (!theState) {
 230     abort();
 231   }
 232 }
 233
 234 void ModuleBase_Operation::activateByPreselection()
 235 {
 236   if (!myPropertyPanel || myPreSelection.empty()) {
 237     myPropertyPanel->activateNextWidget(NULL);
 238     return;
 239   }
 240   const QList<ModuleBase_ModelWidget*>& aWidgets = myPropertyPanel->modelWidgets();
 241   if (aWidgets.empty()) {
 242     myPropertyPanel->activateNextWidget(NULL);
 243     return;
 244   }
 245
 246   ModuleBase_ModelWidget* aWgt, *aFilledWgt = 0;
 247   QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
 248   QList<ModuleBase_ViewerPrs>::const_iterator aPIt;
 249   bool isSet = false;
 250   for (aWIt = aWidgets.constBegin(), aPIt = myPreSelection.constBegin();
 251        (aWIt != aWidgets.constEnd()) && (aPIt != myPreSelection.constEnd());
 252        ++aWIt) {
 253     aWgt = (*aWIt);
 254     ModuleBase_ViewerPrs aValue = (*aPIt);
 255     if (!aWgt->canSetValue())
 256       continue;
 257
 258     ++aPIt;
 259     if (!aWgt->setSelection(aValue)) {
 260       isSet = false;
 261       break;
 262     } else {
 263       isSet = true;
 264       aFilledWgt = aWgt;
 265     }
 266   }
 267
 268   myPropertyPanel->activateNextWidget(aFilledWgt);
 269   if (aFilledWgt)
 270     emit activatedByPreselection();
 271
 272 }
 273
 274 void ModuleBase_Operation::initSelection(ModuleBase_ISelection* theSelection,
 275                                          ModuleBase_IViewer* theViewer)
 276 {
 277   clearPreselection();
 278
 279   QList<ModuleBase_ViewerPrs> aPreSelected;
 280   // Check that the selected result are not results of operation feature
 281   FeaturePtr aFeature = feature();
 282   if (aFeature) {
 283     QList<ModuleBase_ViewerPrs> aSelected = theSelection->getSelected();
 284
 285     std::list<ResultPtr> aResults = aFeature->results();
 286     QObjectPtrList aResList;
 287     std::list<ResultPtr>::const_iterator aIt;
 288     for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt)
 289       aResList.append(*aIt);
 290
 291     foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
 292       if ((!aResList.contains(aPrs.object())) && (aPrs.object() != aFeature))
 293         aPreSelected.append(aPrs);
 294     }
 295   } else
 296     aPreSelected = theSelection->getSelected();
 297
 298   // convert the selection values to the values, which are set to the operation widgets
 299
 300   //Handle(V3d_View) aView = theViewer->activeView();
 301   //foreach (ModuleBase_ViewerPrs aPrs, aPreSelected) {
 302   //  ModuleBase_WidgetValueFeature* aValue = new ModuleBase_WidgetValueFeature();
 303   //  aValue->setObject(aPrs.object());
 304
 305   //  double aX, anY;
 306   //  if (getViewerPoint(aPrs, theViewer, aX, anY))
 307   //    aValue->setPoint(std::shared_ptr<GeomAPI_Pnt2d>(new GeomAPI_Pnt2d(aX, anY)));
 308   //  myPreSelection.append(aValue);
 309   //}
 310   myPreSelection = aPreSelected;
 311 }
 312
 313 //void ModuleBase_Operation::onWidgetActivated(ModuleBase_ModelWidget* theWidget)
 314 //{
 315 //  //activateByPreselection();
 316 //  //if (theWidget && myPropertyPanel) {
 317 //  //  myPropertyPanel->activateNextWidget();
 318 //  ////  //emit activateNextWidget(myActiveWidget);
 319 //  //}
 320 //}
 321
 322 //bool ModuleBase_Operation::setWidgetValue(ObjectPtr theFeature, double theX, double theY)
 323 //{
 324 //  ModuleBase_ModelWidget* aActiveWgt = myPropertyPanel->activeWidget();
 325 //  if (!aActiveWgt)
 326 //    return false;
 327 //  ModuleBase_WidgetValueFeature* aValue = new ModuleBase_WidgetValueFeature();
 328 //  aValue->setObject(theFeature);
 329 //  aValue->setPoint(std::shared_ptr<GeomAPI_Pnt2d>(new GeomAPI_Pnt2d(theX, theY)));
 330 //  bool isApplyed = aActiveWgt->setValue(aValue);
 331 //
 332 //  delete aValue;
 333 //  myIsModified = (myIsModified || isApplyed);
 334 //  return isApplyed;
 335 //}
 336
 337 bool ModuleBase_Operation::getViewerPoint(ModuleBase_ViewerPrs thePrs,
 338                                                ModuleBase_IViewer* theViewer,
 339                                                double& theX, double& theY)
 340 {
 341   return false;
 342 }
 343
 344 void ModuleBase_Operation::clearPreselection()
 345 {
 346   myPreSelection.clear();
 347 }
 348
 349 void ModuleBase_Operation::setPropertyPanel(ModuleBase_IPropertyPanel* theProp)
 350 {
 351   myPropertyPanel = theProp;
 352   myPropertyPanel->setEditingMode(isEditOperation());
 353   //connect(myPropertyPanel, SIGNAL(widgetActivated(ModuleBase_ModelWidget*)), this,
 354   //        SLOT(onWidgetActivated(ModuleBase_ModelWidget*)));
 355
 356   // Do not activate widgets by default if the current operation is editing operation
 357   // Because we don't know which widget is going to be edited.
 358   if (!isEditOperation())
 359     activateByPreselection();
 360 }
 361
 362 bool ModuleBase_Operation::isGranted(QString theId) const
 363 {
 364   return myNestedFeatures.contains(theId);
 365 }