Salome HOME
Abort sketcher when it is not the last feature: fix for modifications outside of...
[modules/shaper.git] / 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   if (myIsEditing) {
184     SessionPtr aMgr = ModelAPI_Session::get();
185     DocumentPtr aDoc = aMgr->activeDocument();
186     bool aIsOp = aMgr->isOperation();
187     if (!aIsOp)
188       aMgr->startOperation();
189     aDoc->setCurrentFeature(myCurrentFeature, true);
190     if (!aIsOp)
191       aMgr->finishOperation();
192     myCurrentFeature = FeaturePtr();
193   }
194   abortOperation();
195   emit aborted();
196
197   stopOperation();
198   // is is necessary to deactivate current widgets before the model operation is aborted
199   // because abort removes the feature and activated filters should not check it
200   propertyPanel()->cleanContent();
201
202   ModelAPI_Session::get()->abortOperation();
203   emit stopped();
204 }
205
206 bool ModuleBase_Operation::commit()
207 {
208   if (canBeCommitted()) {
209     SessionPtr aMgr = ModelAPI_Session::get();
210     /// Set current feature and remeber old current feature
211     if (myIsEditing) {
212       DocumentPtr aDoc = aMgr->activeDocument();
213       bool aIsOp = aMgr->isOperation();
214       if (!aIsOp)
215         aMgr->startOperation();
216       aDoc->setCurrentFeature(myCurrentFeature, true);
217       if (!aIsOp)
218         aMgr->finishOperation();
219       myCurrentFeature = FeaturePtr();
220     }
221     commitOperation();
222     // check whether there are modifications performed during the current operation
223     // in the model
224     // in case if there are no modifications, do not increase the undo/redo stack
225     if (aMgr->isModified())
226       aMgr->finishOperation();
227     else
228       aMgr->abortOperation();
229
230     stopOperation();
231     emit stopped();
232     emit committed();
233
234     afterCommitOperation();
235     return true;
236   }
237   return false;
238 }
239
240 void ModuleBase_Operation::setRunning(bool theState)
241 {
242   emit triggered(theState);
243 }
244
245 void ModuleBase_Operation::activateByPreselection()
246 {
247   if (!myPropertyPanel || myPreSelection.empty()) {
248     myPropertyPanel->activateNextWidget(NULL);
249     return;
250   }
251   const QList<ModuleBase_ModelWidget*>& aWidgets = myPropertyPanel->modelWidgets();
252   if (aWidgets.empty()) {
253     myPropertyPanel->activateNextWidget(NULL);
254     return;
255   }
256   
257   ModuleBase_ModelWidget* aWgt, *aFilledWgt = 0;
258   QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
259   bool isSet = false;
260   // 1. apply the selection to controls
261   int aCurrentPosition = 0;
262   for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
263     aWgt = (*aWIt);
264     if (!aWgt->canSetValue())
265       continue;
266
267     if (!aWgt->setSelection(myPreSelection, aCurrentPosition/*aValue*/)) {
268       isSet = false;
269       break;
270     } else {
271       isSet = true;
272       aFilledWgt = aWgt;
273     }
274   }
275   // 2. ignore not obligatory widgets
276   /*for (; aWIt != aWidgets.constEnd(); ++aWIt) {
277     aWgt = (*aWIt);
278     if (aWgt && aWgt->isObligatory())
279       continue;
280     aFilledWgt = aWgt;
281   }*/
282
283   // 3. a signal should be emitted before the next widget activation
284   // because, the activation of the next widget will give a focus to the widget. As a result
285   // the value of the widget is initialized. And commit may happens until the value is entered.
286   if (aFilledWgt)
287     emit activatedByPreselection();
288
289   // 4. activate the next obligatory widget
290   myPropertyPanel->activateNextWidget(aFilledWgt);
291 }
292
293 void ModuleBase_Operation::setParentFeature(CompositeFeaturePtr theParent)
294 {
295   myParentFeature = theParent;
296 }
297
298 CompositeFeaturePtr ModuleBase_Operation::parentFeature() const
299 {
300   return myParentFeature;
301 }
302
303 void ModuleBase_Operation::initSelection(ModuleBase_ISelection* theSelection,
304                                          ModuleBase_IViewer* theViewer)
305 {
306   clearPreselection();
307
308   QList<ModuleBase_ViewerPrs> aPreSelected;
309   // Check that the selected result are not results of operation feature
310   FeaturePtr aFeature = feature();
311   if (aFeature) {
312     QList<ModuleBase_ViewerPrs> aSelected = theSelection->getSelected();
313
314     std::list<ResultPtr> aResults = aFeature->results();
315     QObjectPtrList aResList;
316     std::list<ResultPtr>::const_iterator aIt;
317     for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt)
318       aResList.append(*aIt);
319
320     foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
321       if ((!aResList.contains(aPrs.object())) && (aPrs.object() != aFeature))
322         aPreSelected.append(aPrs);
323     }
324   } else
325     aPreSelected = theSelection->getSelected();
326
327   // convert the selection values to the values, which are set to the operation widgets
328
329   //Handle(V3d_View) aView = theViewer->activeView();
330   //foreach (ModuleBase_ViewerPrs aPrs, aPreSelected) {
331   //  ModuleBase_WidgetValueFeature* aValue = new ModuleBase_WidgetValueFeature();
332   //  aValue->setObject(aPrs.object());
333
334   //  double aX, anY;
335   //  if (getViewerPoint(aPrs, theViewer, aX, anY))
336   //    aValue->setPoint(std::shared_ptr<GeomAPI_Pnt2d>(new GeomAPI_Pnt2d(aX, anY)));
337   //  myPreSelection.append(aValue);
338   //}
339   myPreSelection = aPreSelected;
340 }
341
342 //void ModuleBase_Operation::onWidgetActivated(ModuleBase_ModelWidget* theWidget)
343 //{
344 //  //activateByPreselection();
345 //  //if (theWidget && myPropertyPanel) {
346 //  //  myPropertyPanel->activateNextWidget();
347 //  ////  //emit activateNextWidget(myActiveWidget);
348 //  //}
349 //}
350
351 //bool ModuleBase_Operation::setWidgetValue(ObjectPtr theFeature, double theX, double theY)
352 //{
353 //  ModuleBase_ModelWidget* aActiveWgt = myPropertyPanel->activeWidget();
354 //  if (!aActiveWgt)
355 //    return false;
356 //  ModuleBase_WidgetValueFeature* aValue = new ModuleBase_WidgetValueFeature();
357 //  aValue->setObject(theFeature);
358 //  aValue->setPoint(std::shared_ptr<GeomAPI_Pnt2d>(new GeomAPI_Pnt2d(theX, theY)));
359 //  bool isApplyed = aActiveWgt->setValue(aValue);
360 //
361 //  delete aValue;
362 //  myIsModified = (myIsModified || isApplyed);
363 //  return isApplyed;
364 //}
365
366 bool ModuleBase_Operation::getViewerPoint(ModuleBase_ViewerPrs thePrs,
367                                                ModuleBase_IViewer* theViewer,
368                                                double& theX, double& theY)
369 {
370   return false;
371 }
372
373 void ModuleBase_Operation::clearPreselection()
374 {
375   myPreSelection.clear();
376 }
377
378 void ModuleBase_Operation::setPropertyPanel(ModuleBase_IPropertyPanel* theProp) 
379
380   myPropertyPanel = theProp; 
381   myPropertyPanel->setEditingMode(isEditOperation());
382
383   // Do not activate widgets by default if the current operation is editing operation
384   // Because we don't know which widget is going to be edited. 
385   if (!isEditOperation())
386     activateByPreselection();
387 }
388
389 bool ModuleBase_Operation::isGranted(QString theId) const
390 {
391   return myNestedFeatures.contains(theId);
392 }