Salome HOME
Fix instability in unit-test checking coincidence with ellipse.
[modules/shaper.git] / src / Model / Model_Update.cpp
old mode 100755 (executable)
new mode 100644 (file)
index 2bf951a..d8896e6
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2019  CEA/DEN, EDF R&D
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 //
 // You should have received a copy of the GNU Lesser General Public
 // License along with this library; if not, write to the Free Software
-// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-// See http://www.salome-platform.org/ or
-// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #include <Model_Update.h>
 #include <ModelAPI_Tools.h>
 #include <ModelAPI_ResultBody.h>
 #include <ModelAPI_ResultPart.h>
+#include <ModelAPI_ResultConstruction.h>
 #include <GeomAPI_Shape.h>
 #include <GeomDataAPI_Point.h>
+#include <GeomDataAPI_Dir.h>
 #include <GeomDataAPI_Point2D.h>
 #include <Events_Loop.h>
 #include <Events_LongOp.h>
@@ -76,10 +77,8 @@ Model_Update::Model_Update()
   aLoop->registerListener(this, kReorderEvent);
   static const Events_ID kUpdatedSel = aLoop->eventByName(EVENT_UPDATE_SELECTION);
   aLoop->registerListener(this, kUpdatedSel);
-  static const Events_ID kAutomaticOff = aLoop->eventByName(EVENT_AUTOMATIC_RECOMPUTATION_DISABLE);
-  aLoop->registerListener(this, kAutomaticOff);
-  static const Events_ID kAutomaticOn = aLoop->eventByName(EVENT_AUTOMATIC_RECOMPUTATION_ENABLE);
-  aLoop->registerListener(this, kAutomaticOn);
+  static const Events_ID kAutoRecomp = aLoop->eventByName(EVENT_AUTOMATIC_RECOMPUTATION_ENABLE);
+  aLoop->registerListener(this, kAutoRecomp);
 
   //  Config_PropManager::findProp("Model update", "automatic_rebuild")->value() == "true";
   myIsParamUpdated = false;
@@ -198,7 +197,7 @@ bool Model_Update::addModified(FeaturePtr theFeature, FeaturePtr theReason) {
       }
     }
   }
-  // proccess also results
+  // process also results
   std::list<ResultPtr> allResults; // list of this feature and results
   ModelAPI_Tools::allResults(theFeature, allResults);
   std::list<ResultPtr>::iterator aRes = allResults.begin();
@@ -240,12 +239,36 @@ void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessag
   static const Events_ID kReorderEvent = aLoop->eventByName(EVENT_ORDER_UPDATED);
   static const Events_ID kRedisplayEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
   static const Events_ID kUpdatedSel = aLoop->eventByName(EVENT_UPDATE_SELECTION);
-  static const Events_ID kAutomaticOff = aLoop->eventByName(EVENT_AUTOMATIC_RECOMPUTATION_DISABLE);
-  static const Events_ID kAutomaticOn = aLoop->eventByName(EVENT_AUTOMATIC_RECOMPUTATION_ENABLE);
 
 #ifdef DEB_UPDATE
   std::cout<<"****** Event "<<theMessage->eventID().eventText()<<std::endl;
 #endif
+  // check the automatic update flag on any event
+  bool aNewAutomaticState = ModelAPI_Session::get()->isAutoUpdateBlocked();
+  if (myUpdateBlocked != aNewAutomaticState) {
+    myUpdateBlocked = aNewAutomaticState;
+    if (!myUpdateBlocked) { // process all modified features, even if preview is blocked
+      bool aPreviewBlockedState = myIsPreviewBlocked; // to update the selected arguments
+      myIsPreviewBlocked = false;
+      // iterate everything and add features in state "MustBeUpdated" into modified
+      std::list<std::shared_ptr<ModelAPI_Document> > allDocs =
+        ModelAPI_Session::get()->allOpenedDocuments();
+      std::list<std::shared_ptr<ModelAPI_Document> >::iterator aDoc = allDocs.begin();
+      for(; aDoc != allDocs.end(); aDoc++) {
+        std::list<std::shared_ptr<ModelAPI_Feature> > allFeats = (*aDoc)->allFeatures();
+        std::list<std::shared_ptr<ModelAPI_Feature> >::iterator aFeat = allFeats.begin();
+        for(; aFeat != allFeats.end(); aFeat++) {
+          if ((*aFeat)->data()->isValid() &&
+            (*aFeat)->data()->execState() == ModelAPI_StateMustBeUpdated) {
+            addModified(*aFeat, FeaturePtr());
+          }
+        }
+      }
+      processFeatures();
+      myIsPreviewBlocked = myIsPreviewBlocked;
+    }
+  }
+
   if (theMessage->eventID() == kStabilityEvent) {
     updateStability(theMessage->sender());
     return;
@@ -265,32 +288,6 @@ void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessag
     }
     return;
   }
-  if (theMessage->eventID() == kAutomaticOff) {
-    myUpdateBlocked = true;
-    return;
-  }
-  if (theMessage->eventID() == kAutomaticOn) {
-    myUpdateBlocked = false; // then process all modified features, even if preview is blocked
-    bool aPreviewBlockedState = myIsPreviewBlocked; // to update the selected arguments
-    myIsPreviewBlocked = false;
-    // iterate everything and add efatures in state "MustBeUpdated" into modified
-    std::list<std::shared_ptr<ModelAPI_Document> > allDocs =
-      ModelAPI_Session::get()->allOpenedDocuments();
-    std::list<std::shared_ptr<ModelAPI_Document> >::iterator aDoc = allDocs.begin();
-    for(; aDoc != allDocs.end(); aDoc++) {
-      std::list<std::shared_ptr<ModelAPI_Feature> > allFeats = (*aDoc)->allFeatures();
-      std::list<std::shared_ptr<ModelAPI_Feature> >::iterator aFeat = allFeats.begin();
-      for(; aFeat != allFeats.end(); aFeat++) {
-        if ((*aFeat)->data()->isValid() &&
-            (*aFeat)->data()->execState() == ModelAPI_StateMustBeUpdated) {
-          addModified(*aFeat, FeaturePtr());
-        }
-      }
-    }
-    processFeatures();
-    myIsPreviewBlocked = myIsPreviewBlocked;
-    return;
-  }
   if (theMessage->eventID() == kUpdatedSel) {
     std::shared_ptr<ModelAPI_ObjectUpdatedMessage> aMsg =
         std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
@@ -303,16 +300,19 @@ void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessag
         std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
     const std::set<ObjectPtr>& anObjs = aMsg->objects();
     std::set<ObjectPtr>::const_iterator anObjIter = anObjs.cbegin();
+    std::list<ObjectPtr> aFeatures, aResults;
     for(; anObjIter != anObjs.cend(); anObjIter++) {
       if (std::dynamic_pointer_cast<Model_Document>((*anObjIter)->document())->executeFeatures()) {
         if ((*anObjIter)->groupName() == ModelAPI_Feature::group()) {
           // results creation means enabling, not update
-          ModelAPI_EventCreator::get()->sendUpdated(*anObjIter, kUpdatedEvent);
+          aFeatures.push_back(*anObjIter);
         } else {
-          ModelAPI_EventCreator::get()->sendUpdated(*anObjIter, kRedisplayEvent);
+          aResults.push_back(*anObjIter);
         }
       }
     }
+    ModelAPI_EventCreator::get()->sendUpdated(aFeatures, kUpdatedEvent);
+    ModelAPI_EventCreator::get()->sendUpdated(aResults, kRedisplayEvent);
     return;
   }
   if (theMessage->eventID() == kUpdatedEvent) {
@@ -331,7 +331,7 @@ void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessag
       if ((*anObjIter)->groupName() == ModelAPI_ResultParameter::group()) {
         myIsParamUpdated = true;
       }
-      // on undo/redo, abort do not update persisten features
+      // on undo/redo, abort do not update persistent features
       FeaturePtr anUpdated = std::dynamic_pointer_cast<ModelAPI_Feature>(*anObjIter);
       if (anUpdated.get()) {
         if (addModified(anUpdated, FeaturePtr()))
@@ -395,7 +395,7 @@ void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessag
       }
       myIsFinish = false;
     }
-    // processed features must be only on finish, so clear anyway (to avoid reimport on load)
+    // processed features must be only on finish, so clear anyway (to avoid re-import on load)
     myProcessOnFinish.clear();
 
     // #2156: current must be sketch, left after the macro execution
@@ -409,7 +409,8 @@ void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessag
     }
 
     if (anActiveDoc.get() && aCurrent.get() && aCurrent->data()->isValid()) {
-      if (anActiveDoc->currentFeature(false) != aCurrent)
+      if (anActiveDoc->currentFeature(false) != aCurrent &&
+          ModelAPI_Tools::compositeOwner(anActiveDoc->currentFeature(false)) == aCurrent)
         anActiveDoc->setCurrentFeature(aCurrent, false); // #2156 make the current feature back
     }
 
@@ -440,7 +441,7 @@ void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessag
     Events_Loop::loop()->flush(kRedisplayEvent);
 
     // in the end of transaction everything is updated, so clear the old objects
-    myIsParamUpdated = false;
+    //myIsParamUpdated = false; // to avoid problems in sprocket.py parameter update
     myWaitForFinish.clear();
   } else if (theMessage->eventID() == kReorderEvent) {
     std::shared_ptr<ModelAPI_OrderUpdatedMessage> aMsg =
@@ -483,7 +484,7 @@ void Model_Update::processFeatures(const bool theFlushRedisplay)
   }
 }
 
-// collects all the feautres this feature depends on: reasons
+// collects all the features this feature depends on: reasons
 static void allReasons(FeaturePtr theFeature, std::set<FeaturePtr>& theReasons) {
   std::list<std::pair<std::string, std::list<std::shared_ptr<ModelAPI_Object> > > > aDeps;
   theFeature->data()->referencesToObjects(aDeps);
@@ -567,36 +568,46 @@ bool Model_Update::processFeature(FeaturePtr theFeature)
 
   // update the sketch plane before the sketch sub-elements are recomputed
   // (otherwise sketch will update plane, modify subs, after executed, but with old subs edges)
-  if (aIsModified && theFeature->getKind() == "Sketch") {
+    if (aIsModified && theFeature->getKind() == "Sketch") {
 #ifdef DEB_UPDATE
-    std::cout<<"****** Update sketch args "<<theFeature->name()<<std::endl;
+      std::cout << "****** Update sketch args " << theFeature->name() << std::endl;
 #endif
-    AttributeSelectionPtr anExtSel = theFeature->selection("External");
-    if (anExtSel.get()) {
-      ResultPtr aContext = anExtSel->context();
-      if (aContext.get() && aContext->document().get()) {
-        FeaturePtr anExtBase = aContext->document()->feature(aContext);
-        if (anExtBase.get()) {
-          processFeature(anExtBase);
+      AttributeSelectionPtr anExtSel = theFeature->selection("External");
+      if (anExtSel.get()) {
+        ResultPtr aContext = anExtSel->context();
+        if (aContext.get() && aContext->document().get()) {
+          FeaturePtr anExtBase = aContext->document()->feature(aContext);
+          if (anExtBase.get()) {
+            processFeature(anExtBase);
+          }
+          std::shared_ptr<GeomDataAPI_Point> anOrigin =
+            std::dynamic_pointer_cast<GeomDataAPI_Point>(theFeature->attribute("Origin"));
+          double anOX = anOrigin->x(), anOY = anOrigin->y(), anOZ = anOrigin->z();
+          std::shared_ptr<GeomDataAPI_Dir> aDir =
+            std::dynamic_pointer_cast<GeomDataAPI_Dir>(theFeature->attribute("DirX"));
+          double aDX = aDir->x(), aDY = aDir->y(), aDZ = aDir->z();
+          std::shared_ptr<GeomDataAPI_Dir> aNorm =
+            std::dynamic_pointer_cast<GeomDataAPI_Dir>(theFeature->attribute("Norm"));
+          double aNX = aNorm->x(), aNY = aNorm->y(), aNZ = aNorm->z();
+          // update sketch plane
+          updateArguments(theFeature);
+          theFeature->attributeChanged("External"); // to recompute origin, direction and normal
+          // check it is updated, so all must be changed
+          if (anOrigin->x() != anOX || anOrigin->y() != anOY || anOrigin->z() != anOZ ||
+              aDir->x() != aDX || aDir->y() != aDY || aDir->z() != aDZ ||
+              aNorm->x() != aNX || aNorm->y() != aNY || aNorm->z() != aNZ)
+          {
+            std::set<FeaturePtr> aWholeR;
+            allReasons(theFeature, aWholeR);
+            std::set<FeaturePtr>::iterator aRIter = aWholeR.begin();
+            for (; aRIter != aWholeR.end(); aRIter++) {
+              if ((*aRIter)->data()->selection("External").get())
+                (*aRIter)->attributeChanged("External");
+            }
+          }
         }
       }
     }
-    std::shared_ptr<GeomAPI_Shape> aShapeBefore = anExtSel->value();
-    if (!aShapeBefore.get() && anExtSel->context()) aShapeBefore = anExtSel->context()->shape();
-    updateArguments(theFeature);
-    std::shared_ptr<GeomAPI_Shape> aShapeAfter = anExtSel->value();
-    if (!aShapeAfter.get() && anExtSel->context()) aShapeAfter = anExtSel->context()->shape();
-    // if selected plane is changed, try to re-take external references of all subs of the sketch
-    if (aShapeBefore.get() && !aShapeBefore->isEqual(aShapeAfter)) {
-      std::set<FeaturePtr> aWholeR;
-      allReasons(theFeature, aWholeR);
-      std::set<FeaturePtr>::iterator aRIter = aWholeR.begin();
-      for(; aRIter != aWholeR.end(); aRIter++) {
-        if ((*aRIter)->data()->selection("External"))
-          (*aRIter)->attributeChanged("External");
-      }
-    }
-  }
 
   if (!aIsModified) { // no modification is needed
     return false;
@@ -636,7 +647,12 @@ bool Model_Update::processFeature(FeaturePtr theFeature)
     }
     // searching for the next not used reason
     aProcessedReasons.insert(aReason);
-    aReasons.erase(aReason);
+    // check theFeature is still in the list of modified, because it may be removed sometimes
+    // while updating SketchPlugin_Ellipse
+    if (myModified.find(theFeature) != myModified.end())
+      aReasons.erase(aReason);
+    else
+      break;
   }
   // restore the modified reasons: they will be used in the update of arguments
   if (allSubsUsed) { // restore theFeature in this set
@@ -690,7 +706,7 @@ bool Model_Update::processFeature(FeaturePtr theFeature)
     theFeature->data()->execState(ModelAPI_StateDone);
 
   // this checking must be after the composite feature sub-elements processing:
-  // composite feature status may depend on it's subelements
+  // composite feature status may depend on it's sub-elements
   if ((theFeature->data()->execState() == ModelAPI_StateInvalidArgument || isReferencedInvalid) &&
     theFeature->getKind() != "Part") {
       // don't disable Part because it will make disabled all the features
@@ -711,9 +727,8 @@ bool Model_Update::processFeature(FeaturePtr theFeature)
       if (myUpdateBlocked) {
         if (!theFeature->isStable()) {
           aDoExecute = true;
-        } else if (theFeature->results().size()) { // execute only not-results features
-          aDoExecute = !(theFeature->firstResult()->groupName() == ModelAPI_ResultBody::group() ||
-                         theFeature->firstResult()->groupName() == ModelAPI_ResultPart::group());
+        } else if (theFeature->results().size()) { // execute only not persistent results features
+          aDoExecute = !theFeature->isPersistentResult();
         } else {
           aDoExecute = aState != ModelAPI_StateInvalidArgument;
         }
@@ -902,7 +917,7 @@ void Model_Update::updateArguments(FeaturePtr theFeature) {
       if (aSelAttr) {
         ObjectPtr aContext = aSelAttr->context();
         // update argument only if the referenced object is ready to use
-        if (aContext.get() && !aContext->isDisabled() && !aSelAttr->isInvalid()) {
+        if (aContext.get() && !aContext->isDisabled()) {
           if (isReason(theFeature, aContext)) {
             if (!aSelAttr->update()) {
               bool isObligatory = !aFactory->isNotObligatory(
@@ -912,7 +927,7 @@ void Model_Update::updateArguments(FeaturePtr theFeature) {
                 aState = ModelAPI_StateInvalidArgument;
             }
           }
-        } else if (aContext.get() || aSelAttr->isInvalid()) {
+        } else if (aContext.get()) {
           // here it may be not obligatory, but if the reference is wrong, it should not be correct
           bool isObligatory = aFactory->isCase(theFeature, theFeature->data()->id(aSel));
           if (isObligatory)
@@ -990,6 +1005,8 @@ void Model_Update::executeFeature(FeaturePtr theFeature)
   redisplayWithResults(theFeature, aState);
 }
 
+// it is called on GUI edit of feature start
+// LCOV_EXCL_START
 void Model_Update::updateStability(void* theSender)
 {
   static ModelAPI_ValidatorsFactory* aFactory = ModelAPI_Session::get()->validators();
@@ -1042,6 +1059,7 @@ void Model_Update::updateStability(void* theSender)
     }
   }
 }
+// LCOV_EXCL_STOP
 
 void Model_Update::updateSelection(const std::set<std::shared_ptr<ModelAPI_Object> >& theObjects)
 {
@@ -1053,19 +1071,27 @@ void Model_Update::updateSelection(const std::set<std::shared_ptr<ModelAPI_Objec
     for (; aRefsIter != aRefs.end(); aRefsIter++) {
       std::shared_ptr<Model_AttributeSelection> aSel =
         std::dynamic_pointer_cast<Model_AttributeSelection>(*aRefsIter);
-      aSel->updateInHistory();
+      bool aRemove = false;
+      aSel->updateInHistory(aRemove);
     }
     // update the selection list attributes if any
     aRefs = (*anObj)->data()->attributes(ModelAPI_AttributeSelectionList::typeId());
     for (aRefsIter = aRefs.begin(); aRefsIter != aRefs.end(); aRefsIter++) {
+      std::set<int> aRemoveSet;
       std::shared_ptr<ModelAPI_AttributeSelectionList> aSel =
         std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(*aRefsIter);
       for(int a = aSel->size() - 1; a >= 0; a--) {
         std::shared_ptr<Model_AttributeSelection> aSelAttr =
           std::dynamic_pointer_cast<Model_AttributeSelection>(aSel->value(a));
-        if (aSelAttr.get())
-          aSelAttr->updateInHistory();
+        if (aSelAttr.get()) {
+          bool theRemove = false;
+          aSelAttr->updateInHistory(theRemove);
+          if (theRemove) {
+            aRemoveSet.insert(a);
+          }
+        }
       }
+      aSel->remove(aRemoveSet);
     }
   }
 }