Salome HOME
Merge branch 'master' of salome:modules/shaper
[modules/shaper.git] / src / ModuleBase / ModuleBase_OperationFeature.cpp
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #include "ModuleBase_OperationFeature.h"
22
23 #include "ModuleBase_OperationDescription.h"
24 #include "ModuleBase_ModelWidget.h"
25 #include "ModuleBase_ViewerPrs.h"
26 #include "ModuleBase_IPropertyPanel.h"
27 #include "ModuleBase_ISelection.h"
28 #include "ModuleBase_IViewer.h"
29 #include "ModuleBase_Tools.h"
30
31 #include <ModelAPI_AttributeDouble.h>
32 #include <ModelAPI_Document.h>
33 #include <ModelAPI_Feature.h>
34 #include <ModelAPI_Data.h>
35 #include <ModelAPI_Document.h>
36 #include <ModelAPI_Events.h>
37 #include <ModelAPI_Result.h>
38 #include <ModelAPI_Object.h>
39 #include <ModelAPI_Validator.h>
40 #include <ModelAPI_Session.h>
41 #include <ModelAPI_Tools.h>
42
43 #include <GeomAPI_Pnt2d.h>
44
45 #include <Events_Loop.h>
46
47 #include <QTimer>
48
49 // the define to check the activated object as a sub-feature by argument of
50 // the operation feature. E.g. rectangle feature(operation), line(in argument) to be not activated
51 #define DEBUG_DO_NOT_ACTIVATE_SUB_FEATURE
52 #ifdef DEBUG_DO_NOT_ACTIVATE_SUB_FEATURE
53 #include <ModelAPI_AttributeRefList.h>
54 #endif
55
56 //#define DEBUG_OPERATION_START
57
58 #ifdef _DEBUG
59 #include <QDebug>
60 #endif
61
62 ModuleBase_OperationFeature::ModuleBase_OperationFeature(const QString& theId, QObject* theParent)
63 : ModuleBase_Operation(theId, theParent), myIsEditing(false), myNeedToBeAborted(false)
64 {
65 }
66
67 ModuleBase_OperationFeature::~ModuleBase_OperationFeature()
68 {
69   clearPreselection();
70 }
71
72 void ModuleBase_OperationFeature::setEditOperation(const bool& isEditState
73                                                    /*const bool theRestartTransaction*/)
74 {
75   bool isCurrentEditState = isEditOperation();
76   if (isCurrentEditState == isEditState)
77     return;
78
79   /*
80   // this case is obsolete as it was not approved for reentrant sketch operation
81   // it was implemented when isEditState did not exist and only edit operation can be set
82   if (theRestartTransaction) {
83     // finsh previous create operation
84     emit beforeCommitted();
85     SessionPtr aMgr = ModelAPI_Session::get();
86     ModelAPI_Session::get()->finishOperation();
87
88     // start new edit operation
89     myIsEditing = true;
90     QString anId = getDescription()->operationId();
91     if (myIsEditing) {
92       anId = anId.append(EditSuffix());
93     }
94     ModelAPI_Session::get()->startOperation(anId.toStdString());
95     emit beforeStarted();
96   } else*/
97   myIsEditing = isEditState;
98
99   propertyPanel()->setEditingMode(isEditOperation());
100 }
101
102 FeaturePtr ModuleBase_OperationFeature::feature() const
103 {
104   return myFeature;
105 }
106
107 bool ModuleBase_OperationFeature::isValid() const
108 {
109   if (!myFeature || !myFeature->data()->isValid())
110     return true; // rename operation
111   if (myFeature->isAction())
112     return true;
113
114   std::string anError = ModelAPI_Tools::getFeatureError(myFeature);
115   //ModuleBase_Tools::translate(myFeature->getKind(), anError);
116   return anError.empty();
117 }
118
119 void ModuleBase_OperationFeature::startOperation()
120 {
121   FeaturePtr aFeature = feature();
122   if (!aFeature.get() || !isEditOperation())
123     return;
124
125   if (aFeature.get() && isEditOperation())
126     aFeature->setStable(false);
127
128   myVisualizedObjects.clear();
129   // store hidden result features
130   std::list<ResultPtr> aResults;
131   ModelAPI_Tools::allResults(aFeature, aResults);
132   std::list<ResultPtr>::const_iterator aIt;
133   for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt) {
134     ObjectPtr anObject = *aIt;
135     if (anObject.get() && !anObject->isDisplayed()) {
136       myVisualizedObjects.insert(*aIt);
137       anObject->setDisplayed(true);
138     }
139   }
140   if (!aFeature->isDisplayed()) {
141     myVisualizedObjects.insert(aFeature);
142     aFeature->setDisplayed(true);
143   }
144   Events_Loop::loop()->flush(Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY));
145 }
146
147 void ModuleBase_OperationFeature::stopOperation()
148 {
149   FeaturePtr aFeature = feature();
150   if (!aFeature.get() || !isEditOperation())
151     return;
152
153   // store hidden result features
154   std::list<ResultPtr> aResults;
155   ModelAPI_Tools::allResults(aFeature, aResults);
156   std::list<ResultPtr>::const_iterator aIt;
157   for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt) {
158     ObjectPtr anObject = *aIt;
159     if (anObject.get() && myVisualizedObjects.find(anObject) != myVisualizedObjects.end()) {
160       anObject->setDisplayed(false);
161     }
162   }
163   if (myVisualizedObjects.find(aFeature) != myVisualizedObjects.end()) {
164     aFeature->setDisplayed(false);
165   }
166   if (myVisualizedObjects.size() > 0)
167     Events_Loop::loop()->flush(Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY));
168 }
169
170 FeaturePtr ModuleBase_OperationFeature::createFeature(const bool theFlushMessage)
171 {
172   if (myParentFeature.get()) {
173     myFeature = myParentFeature->addFeature(getDescription()->operationId().toStdString());
174   } else {
175     std::shared_ptr<ModelAPI_Document> aDoc = ModelAPI_Session::get()->activeDocument();
176     myFeature = aDoc->addFeature(getDescription()->operationId().toStdString());
177   }
178   if (myFeature) {  // TODO: generate an error if feature was not created
179     setIsModified(true);
180     // Model update should call "execute" of a feature.
181     //myFeature->execute();
182     // Init default values
183     /*QList<ModuleBase_ModelWidget*> aWidgets = getDescription()->modelWidgets();
184      QList<ModuleBase_ModelWidget*>::const_iterator anIt = aWidgets.begin(), aLast = aWidgets.end();
185      for (; anIt != aLast; anIt++) {
186      (*anIt)->storeValue(aFeature);
187      }*/
188   }
189
190   if (theFlushMessage) {
191     Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
192     Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
193   }
194   return myFeature;
195 }
196
197 void ModuleBase_OperationFeature::setFeature(FeaturePtr theFeature)
198 {
199   myFeature = theFeature;
200   myIsEditing = true;
201 }
202
203 bool ModuleBase_OperationFeature::hasObject(ObjectPtr theObj) const
204 {
205   FeaturePtr aFeature = feature();
206   if (aFeature) {
207     if (aFeature == theObj)
208       return true;
209     std::list<ResultPtr> aResults;
210     ModelAPI_Tools::allResults(aFeature, aResults);
211     std::list<ResultPtr>::const_iterator aIt;
212     for (aIt = aResults.cbegin(); aIt != aResults.cend(); ++aIt) {
213       ResultPtr aResult = *aIt;
214       if (theObj == aResult)
215          return true;
216     }
217 #ifdef DEBUG_DO_NOT_ACTIVATE_SUB_FEATURE
218     if (aFeature->isMacro()) {
219       // macro feature may refers to sub-features,
220       // which also should be deactivated when the operation
221       // is active, e.g. rectangle'lines.
222       FeaturePtr anObjectFeature = ModelAPI_Feature::feature(theObj);
223       std::list<AttributePtr> anAttributes = aFeature->data()->attributes(
224                                               ModelAPI_AttributeRefList::typeId());
225       std::list<AttributePtr>::const_iterator
226         anIt = anAttributes.begin(), aLast = anAttributes.end();
227       bool aFoundObject = false;
228       for (; anIt != aLast && !aFoundObject; anIt++) {
229         std::shared_ptr<ModelAPI_AttributeRefList> aCurSelList =
230                                std::dynamic_pointer_cast<ModelAPI_AttributeRefList>(*anIt);
231         for (int i = 0, aNb = aCurSelList->size(); i < aNb && !aFoundObject; i++) {
232           ObjectPtr anObject = aCurSelList->object(i);
233           FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(anObject);
234           if (aFeature.get()) {
235             aFoundObject = anObjectFeature == aFeature;
236           }
237         }
238       }
239       return aFoundObject;
240     }
241 #endif
242   }
243   return false;
244 }
245
246 bool ModuleBase_OperationFeature::isDisplayedOnStart(ObjectPtr theObject)
247 {
248   return myVisualizedObjects.find(theObject) != myVisualizedObjects.end();
249 }
250
251 bool ModuleBase_OperationFeature::start()
252 {
253 #ifdef DEBUG_OPERATION_START
254   qDebug("ModuleBase_OperationFeature::start -- begin");
255 #endif
256   setIsModified(false);
257   QString anId = getDescription()->operationId();
258   if (myIsEditing) {
259     anId = anId.append(EditSuffix());
260   }
261   ModelAPI_Session::get()->startOperation(anId.toStdString());
262
263   emit beforeStarted();
264   startOperation();
265
266   if (!myIsEditing) {
267     FeaturePtr aFeature = createFeature();
268     // if the feature is not created, there is no sense to start the operation
269     if (aFeature.get() == NULL) {
270       // it is necessary to abor the operation in the session and emit the aborted signal
271       // in order to update commands status in the workshop, to be exact the feature action
272       // to be unchecked
273       abort();
274 #ifdef DEBUG_OPERATION_START
275   qDebug("ModuleBase_OperationFeature::start -- end : IMPOSSIBLE to start");
276 #endif
277       return false;
278     }
279   }
280   //Already called startOperation();
281   emit started();
282 #ifdef DEBUG_OPERATION_START
283   qDebug("ModuleBase_OperationFeature::start -- end");
284 #endif
285   return true;
286 }
287
288 void ModuleBase_OperationFeature::abort()
289 {
290 #ifdef DEBUG_OPERATION_START
291   qDebug("ModuleBase_OperationFeature::abort -- begin");
292 #endif
293
294   emit beforeAborted();
295
296   // the viewer update should be blocked in order to avoid the features blinking before they are
297   // hidden
298   std::shared_ptr<Events_Message> aMsg = std::shared_ptr<Events_Message>(
299       new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED)));
300   Events_Loop::loop()->send(aMsg);
301
302   // the widgets of property panel should not process any events come from data mode
303   // after abort clicked. Some signal such as redisplay/create influence on content
304   // of the object browser and viewer context. Therefore it influence to the current
305   // selection and if the active widget listens it, the attribute value is errnoneous
306   // changed.
307   ModuleBase_IPropertyPanel* aPropertyPanel = propertyPanel();
308   if (aPropertyPanel)
309     aPropertyPanel->cleanContent();
310
311   if (myFeature.get())
312     myFeature->setStable(true);
313
314   abortOperation();
315   stopOperation();
316
317   SessionPtr aMgr = ModelAPI_Session::get();
318   aMgr->abortOperation();
319   emit stopped();
320   // the viewer update should be unblocked in order to avoid the features blinking before they are
321   // hidden
322   aMsg = std::shared_ptr<Events_Message>(
323                 new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED)));
324
325   Events_Loop::loop()->send(aMsg);
326
327   emit aborted();
328 #ifdef DEBUG_OPERATION_START
329   qDebug("ModuleBase_OperationFeature::abort -- end");
330 #endif
331 }
332
333 bool ModuleBase_OperationFeature::commit()
334 {
335 #ifdef DEBUG_OPERATION_START
336   qDebug("ModuleBase_OperationFeature::commit -- begin");
337 #endif
338   ModuleBase_IPropertyPanel* aPanel = propertyPanel();
339   if (aPanel) {
340     ModuleBase_ModelWidget* anActiveWidget = aPanel->activeWidget();
341     if (anActiveWidget && anActiveWidget->getValueState() == ModuleBase_ModelWidget::ModifiedInPP) {
342       anActiveWidget->storeValue();
343     }
344     aPanel->onAcceptData();
345   }
346   if (canBeCommitted()) {
347     emit beforeCommitted();
348     // the widgets of property panel should not process any events come from data mode
349     // after commit clicked. Some signal such as redisplay/create influence on content
350     // of the object browser and viewer context. Therefore it influence to the current
351     // selection and if the active widget listens it, the attribute value is errnoneous
352     // changed.
353     ModuleBase_IPropertyPanel* aPropertyPanel = propertyPanel();
354     if (aPropertyPanel)
355       aPropertyPanel->cleanContent();
356
357     myFeature->setStable(true);
358
359     SessionPtr aMgr = ModelAPI_Session::get();
360     /// Set current feature and remeber old current feature
361
362     commitOperation();
363     aMgr->finishOperation();
364
365     stopOperation();
366     emit stopped();
367     emit committed();
368
369     afterCommitOperation();
370 #ifdef DEBUG_OPERATION_START
371   qDebug("ModuleBase_OperationFeature::commit -- end");
372 #endif
373     return true;
374   }
375 #ifdef DEBUG_OPERATION_START
376   qDebug("ModuleBase_OperationFeature::commit -- end : IMPOSSIBLE to commit");
377 #endif
378   return false;
379 }
380
381 ModuleBase_ModelWidget* ModuleBase_OperationFeature::activateByPreselection(
382                                               const std::string& theGreedAttributeId)
383 {
384   ModuleBase_ModelWidget* aWidget = 0;
385   if (myPreSelection.empty())
386     return aWidget;
387
388   ModuleBase_IPropertyPanel* aPropertyPanel = propertyPanel();
389   ModuleBase_ModelWidget* aFilledWgt = 0;
390   if (aPropertyPanel) {
391     const QList<ModuleBase_ModelWidget*>& aWidgets = aPropertyPanel->modelWidgets();
392     QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
393     ModuleBase_ModelWidget* aWgt = 0;
394     if (!aWidgets.empty()) {
395       // equal vertices should not be used here
396       ModuleBase_ISelection::filterSelectionOnEqualPoints(myPreSelection);
397
398       if (!theGreedAttributeId.empty()) {
399         // set preselection to greed widget
400         for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
401           aWgt = (*aWIt);
402           if (aWgt->attributeID() == theGreedAttributeId) {
403             aPropertyPanel->setPreselectionWidget(aWgt);
404             if (aWgt->setSelection(myPreSelection, true)) {
405               aPropertyPanel->setPreselectionWidget(NULL);
406               aFilledWgt = aWgt;
407               break;
408             }
409             else { // do not process invalid for greed widget selection
410               break;
411             }
412           }
413         }
414       }
415       else {
416         bool isSet = false;
417         // 1. apply the selection to controls
418         for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
419           aWgt = (*aWIt);
420           if (!aWgt->canAcceptFocus())
421             continue;
422           aPropertyPanel->setPreselectionWidget(aWgt);
423           if (myPreSelection.empty() || !aWgt->setSelection(myPreSelection, true)) {
424             isSet = false;
425             break;
426           } else {
427             isSet = true;
428             aFilledWgt = aWgt;
429           }
430         }
431       }
432       aPropertyPanel->setPreselectionWidget(NULL);
433       // in order to redisplay object in the viewer, the update/redisplay signals should be flushed
434       // it is better to perform it not in setSelection of each widget, but do it here,
435       // after the preselection is processed
436       ModuleBase_Tools::flushUpdated(myFeature);
437     }
438   }
439   clearPreselection();
440
441   return aFilledWgt;
442 }
443
444 void ModuleBase_OperationFeature::setParentFeature(CompositeFeaturePtr theParent)
445 {
446   myParentFeature = theParent;
447 }
448
449 CompositeFeaturePtr ModuleBase_OperationFeature::parentFeature() const
450 {
451   return myParentFeature;
452 }
453
454 void ModuleBase_OperationFeature::setPreviousCurrentFeature(const FeaturePtr& theFeature)
455 {
456   myPreviousCurrentFeature = theFeature;
457 }
458
459 FeaturePtr ModuleBase_OperationFeature::previousCurrentFeature()
460 {
461   return myPreviousCurrentFeature;
462 }
463
464 void ModuleBase_OperationFeature::initSelection(
465   const QList<ModuleBase_ViewerPrsPtr>& thePreSelected)
466 {
467   QObjectPtrList aCurrentFeatureResults;
468
469   // Check that the selected result are not results of operation feature
470   FeaturePtr aFeature = feature();
471   if (aFeature) {
472     std::list<ResultPtr> aResults;
473     ModelAPI_Tools::allResults(aFeature, aResults);
474     std::list<ResultPtr>::const_iterator aIt;
475     for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt)
476       aCurrentFeatureResults.append(*aIt);
477   }
478
479   if (aCurrentFeatureResults.empty()) /// filtering of selection is not necessary
480     setPreselection(thePreSelected);
481   else { // create preselection list without results of current feature
482     QList<ModuleBase_ViewerPrsPtr> aPreSelected;
483     foreach (ModuleBase_ViewerPrsPtr aPrs, thePreSelected) {
484       if ((!aCurrentFeatureResults.contains(aPrs->object())) && (aPrs->object() != aFeature))
485         aPreSelected.append(aPrs);
486     }
487     setPreselection(aPreSelected);
488   }
489 }
490
491 void ModuleBase_OperationFeature::setPreselection(const QList<ModuleBase_ViewerPrsPtr>& theValues)
492 {
493   clearPreselection();
494   myPreSelection = theValues;
495 }
496
497 void ModuleBase_OperationFeature::clearPreselection()
498 {
499   myPreSelection.clear();
500 }
501
502 void ModuleBase_OperationFeature::setPropertyPanel(ModuleBase_IPropertyPanel* theProp)
503 {
504   ModuleBase_Operation::setPropertyPanel(theProp);
505
506   theProp->setEditingMode(isEditOperation());
507
508   if (theProp) {
509     const QList<ModuleBase_ModelWidget*>& aWidgets = theProp->modelWidgets();
510     QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
511     for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
512       ModuleBase_ModelWidget* aWgt = (*aWIt);
513       connect(aWgt, SIGNAL(valuesChanged()), this, SLOT(onValuesChanged()));
514       connect(aWgt, SIGNAL(valueStateChanged(int)), this, SLOT(onValueStateChanged(int)));
515     }
516   }
517
518   // Do not activate widgets by default if the current operation is editing operation
519   // Because we don't know which widget is going to be edited.
520   if (!isEditOperation()) {
521     // 4. activate the first obligatory widget
522     theProp->activateNextWidget(NULL);
523   }
524   else {
525     // set focus on Ok button in order to operation manager could process Enter press
526     if (theProp)
527       theProp->setFocusOnOkButton();
528   }
529 }