Salome HOME
Fix for the issue #1156
[modules/shaper.git] / src / Model / Model_Update.cpp
index 5a170ae99b48172bc812a4d18e14e85d0376f333..9d655c03c64a57db054c18350b13bd99554b50fc 100644 (file)
@@ -54,14 +54,18 @@ Model_Update::Model_Update()
   aLoop->registerListener(this, kOpAbortEvent);
   static const Events_ID kOpStartEvent = aLoop->eventByName("StartOperation");
   aLoop->registerListener(this, kOpStartEvent);
+  static const Events_ID kStabilityEvent = aLoop->eventByName(EVENT_STABILITY_CHANGED);
+  aLoop->registerListener(this, kStabilityEvent);
 
+  /* not needed now with history line
   Config_PropManager::registerProp("Model update", "automatic_rebuild", "Rebuild immediately",
-                                   Config_Prop::Boolean, "false");
+                                   Config_Prop::Boolean, "false");*/
   myIsAutomatic = true;
   //  Config_PropManager::findProp("Model update", "automatic_rebuild")->value() == "true";
   myIsParamUpdated = false;
   myIsFinish = false;
   myModification = 0;
+  myModificationInStartProcessing = 0;
 }
 
 void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessage)
@@ -75,17 +79,21 @@ void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessag
   static const Events_ID kOpFinishEvent = aLoop->eventByName("FinishOperation");
   static const Events_ID kOpAbortEvent = aLoop->eventByName("AbortOperation");
   static const Events_ID kOpStartEvent = aLoop->eventByName("StartOperation");
+  static const Events_ID kStabilityEvent = aLoop->eventByName(EVENT_STABILITY_CHANGED);
 #ifdef DEB_UPDATE
   std::cout<<"****** Event "<<theMessage->eventID().eventText()<<std::endl;
 #endif
+  if (theMessage->eventID() == kStabilityEvent)
+    updateStability(theMessage->sender());
   if (theMessage->eventID() == kChangedEvent) { // automatic and manual rebuild flag is changed
-    bool aPropVal =
+    /*bool aPropVal =
       Config_PropManager::findProp("Model update", "automatic_rebuild")->value() == "true";
     if (aPropVal != myIsAutomatic) { // something is changed
       // myIsAutomatic = aPropVal;
       if (myIsAutomatic) // higher level of automatization => to rebuild
         processOperation(false);
-    }
+    }*/
+    return;
   } else if (theMessage->eventID() == kRebuildEvent) { // the rebuild command
     processOperation(true);
   } else if (theMessage->eventID() == kCreatedEvent || theMessage->eventID() == kUpdatedEvent ||
@@ -102,6 +110,8 @@ void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessag
       if ((*anObjIter)->groupName() == ModelAPI_ResultParameter::group()) {
         myIsParamUpdated = true;
       }
+      if (myIsExecuted) // modifications from outside are with never IDs to take them into account in the current updates
+        myModification++;
       // on undo/redo, abort do not update persisten features
       FeaturePtr anUpdated = std::dynamic_pointer_cast<ModelAPI_Feature>(*anObjIter);
       if (std::dynamic_pointer_cast<Model_Document>((*anObjIter)->document())->executeFeatures() ||
@@ -162,7 +172,8 @@ void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessag
     // place where results are cleared)
     myIsParamUpdated = false;
     myUpdated.clear();
-    myModification = 0;
+    // do not erase it since there may be modification increment on start of operation
+    //myModification = 0;
     myWaitForFinish.clear();
   }
 }
@@ -216,33 +227,13 @@ void Model_Update::iterateUpdateBreak(std::shared_ptr<ModelAPI_Feature> theFeatu
 
 void Model_Update::processOperation(const bool theTotalUpdate, const bool theFinish)
 {
-  /* cancel hardcode due to issue 948
-  if (theFinish) {
-    // the hardcode (DBC asked): hide the sketch referenced by extrusion on apply
-    std::set<std::shared_ptr<ModelAPI_Object> >::iterator aFIter;
-    for(aFIter = myWaitForFinish.begin(); aFIter != myWaitForFinish.end(); aFIter++)
-    {
-      FeaturePtr aF = std::dynamic_pointer_cast<ModelAPI_Feature>(*aFIter);
-      if (aF && aF->data()->isValid() && 
-           (aF->getKind() == "Extrusion" || aF->getKind() == "Revolution")) {
-        AttributeSelectionListPtr aBase = aF->selectionList("base");
-        if (aBase.get()) {
-          for(int a = aBase->size() - 1; a >= 0; a--) {
-            ResultPtr aSketchRes = aBase->value(a)->context();
-            if (aSketchRes) {
-              aSketchRes->setDisplayed(false);
-            }
-          }
-        }
-      }
-    }
-  } */
   // perform update of everything if needed
   if (!myIsExecuted) {
     #ifdef DEB_UPDATE
       std::cout<<"****** Start processing"<<std::endl;
     #endif
     myIsExecuted = true;
+    myModificationInStartProcessing = myModification;
 
     bool isAutomaticChanged = false;
 
@@ -250,15 +241,22 @@ void Model_Update::processOperation(const bool theTotalUpdate, const bool theFin
       isAutomaticChanged = true;
       myIsAutomatic = true;
     }
+    // modifications inside of the iteration will be different from modification that comes outside
+    myModification++;
     // init iteration from the root document
     iterateUpdate(CompositeFeaturePtr());
 
     if (isAutomaticChanged) myIsAutomatic = false;
     myIsExecuted = false;
+    // flush updates just before "myModification" increment: to distinguish
+    // updates by "execute" produced by this updater and other updates, coming outside,
+    // which are really important for "processEvent" of this updater
+    static Events_Loop* aLoop = Events_Loop::loop();
+    static const Events_ID kUpdatedEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
+    aLoop->flush(kUpdatedEvent);
     myModification++;
 
     // flush to update display
-    static Events_Loop* aLoop = Events_Loop::loop();
     static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
     aLoop->flush(EVENT_DISP);
     #ifdef DEB_UPDATE
@@ -267,18 +265,33 @@ void Model_Update::processOperation(const bool theTotalUpdate, const bool theFin
   }
 }
 
+bool Model_Update::isProcessed(const int theModificationID)
+{
+  return theModificationID >= myModificationInStartProcessing && 
+         theModificationID <= myModification;
+}
+
 void Model_Update::updateFeature(FeaturePtr theFeature)
 {
   // check all features this feature depended on (recursive call of updateFeature)
   static ModelAPI_ValidatorsFactory* aFactory = ModelAPI_Session::get()->validators();
 
-  if (theFeature->isDisabled())
+  if (theFeature->isDisabled()) {
+    // possibly sub-elements are not disabled?
+    CompositeFeaturePtr aCompos = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
+    if (aCompos)
+      iterateUpdate(aCompos);
     return;
+  }
 
-  // to optimize with NDS: how to update sketch state if sketch is not executed on apply of sub-element
-  //CompositeFeaturePtr aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
-  //if (aMain.get() && aMain->isSub(theFeature->document()->currentFeature(false))) // do no update the composite that contains the current
-  //  return;
+  // do not execute the composite that contains the current
+  bool isPostponedMain = false;
+  CompositeFeaturePtr aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
+  if (theFeature->getKind() == "ExtrusionSketch" && aMain.get()) {
+    CompositeFeaturePtr aCurrentOwner = 
+      ModelAPI_Tools::compositeOwner(theFeature->document()->currentFeature(false));
+    isPostponedMain = aCurrentOwner.get() && aMain->isSub(aCurrentOwner);
+  }
 
   #ifdef DEB_UPDATE
     std::cout<<"Update Feature "<<theFeature->name()<<std::endl;
@@ -287,7 +300,7 @@ void Model_Update::updateFeature(FeaturePtr theFeature)
   // If automatice update is not needed and feature attributes were not updated right now,
   // do not execute it and do not update arguments.
   if (!myIsAutomatic && 
-       (myUpdated.find(theFeature) == myUpdated.end() || myUpdated[theFeature] != myModification)
+       (myUpdated.find(theFeature) == myUpdated.end() || !isProcessed(myUpdated[theFeature]))
        && !aCompos.get()) {
     // execute will be performed later, but some features may have not-result 
     // presentations, so call update for them (like coincidence in the sketcher)
@@ -322,7 +335,7 @@ void Model_Update::updateFeature(FeaturePtr theFeature)
   if (aJustUpdated) {
     // if preview is not needed, the created feature was not updated before, so, myModification is not actual for this
     if (theFeature->isPreviewNeeded()) {
-      aJustUpdated = myUpdated[theFeature] == myModification;
+      aJustUpdated = isProcessed(myUpdated[theFeature]);
     }
   }
 
@@ -359,10 +372,12 @@ void Model_Update::updateFeature(FeaturePtr theFeature)
     if (aJustUpdated) {
       ModelAPI_ExecState aState = theFeature->data()->execState();
       if (aFactory->validate(theFeature)) {
-        #ifdef DEB_UPDATE
-          std::cout<<"Execute Feature "<<theFeature->name()<<std::endl;
-        #endif
-        executeFeature(theFeature);
+        if (!isPostponedMain) {
+          #ifdef DEB_UPDATE
+            std::cout<<"Execute Feature "<<theFeature->name()<<std::endl;
+          #endif
+          executeFeature(theFeature);
+        }
       } else {
         #ifdef DEB_UPDATE
           std::cout<<"Feature is not valid, erase results "<<theFeature->name()<<std::endl;
@@ -374,8 +389,10 @@ void Model_Update::updateFeature(FeaturePtr theFeature)
   } else { // preview is not needed => make state Done
     if (theFeature->data()->execState() == ModelAPI_StateMustBeUpdated) {
       theFeature->data()->execState(ModelAPI_StateDone);
-      if (aJustUpdated) // store that it must be updated on finish
+      if (aJustUpdated) {// store that it must be updated on finish
         myUpdated[theFeature] = myModification;
+        aFactory->validate(theFeature); // need to be validated to update the "Apply" state if not previewed
+      }
     }
   }
 }
@@ -384,9 +401,11 @@ void Model_Update::redisplayWithResults(FeaturePtr theFeature, const ModelAPI_Ex
 {
   // make updated and redisplay all results
   static Events_ID EVENT_DISP = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
-  const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
-  std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
-  for (; aRIter != aResults.cend(); aRIter++) {
+
+  std::list<ResultPtr> allResults;
+  ModelAPI_Tools::allResults(theFeature, allResults);
+  std::list<ResultPtr>::iterator aRIter = allResults.begin();
+  for (; aRIter != allResults.cend(); aRIter++) {
     std::shared_ptr<ModelAPI_Result> aRes = *aRIter;
     if (!aRes->isDisabled()) {// update state only for enabled results (Placement Result Part may make the original Part Result as invalid)
       aRes->data()->execState(theState);
@@ -397,27 +416,11 @@ void Model_Update::redisplayWithResults(FeaturePtr theFeature, const ModelAPI_Ex
       aRes->data()->setUpdateID(theFeature->data()->updateID());
     }
     ModelAPI_EventCreator::get()->sendUpdated(aRes, EVENT_DISP);
-    // iterate sub-bodies of compsolid
-    ResultCompSolidPtr aComp = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(aRes);
-    if (aComp.get()) {
-      int aNumSub = aComp->numberOfSubs();
-      for(int a = 0; a < aNumSub; a++) {
-        ResultPtr aSub = aComp->subResult(a);
-        if (!aSub->isDisabled()) {// update state only for enabled results (Placement Result Part may make the original Part Result as invalid)
-          aSub->data()->execState(theState);
-          if (theState == ModelAPI_StateDone) // feature become "done", so execution changed results
-            myUpdated[aSub] = myModification;
-        }
-        if (theFeature->data()->updateID() > aSub->data()->updateID()) {
-          aSub->data()->setUpdateID(theFeature->data()->updateID());
-        }
-        ModelAPI_EventCreator::get()->sendUpdated(aSub, EVENT_DISP);
-      }
-    }
   }
   // to redisplay "presentable" feature (for ex. distance constraint)
   ModelAPI_EventCreator::get()->sendUpdated(theFeature, EVENT_DISP);
   theFeature->data()->execState(theState);
+  myUpdated[theFeature] = myModification; // feature is also updated to avoid re-updation of it
 }
 
 /// Updates the state by the referenced object: if something bad with it, set state for this one
@@ -445,6 +448,27 @@ bool Model_Update::isOlder(std::shared_ptr<ModelAPI_Feature> theFeature,
   std::map<std::shared_ptr<ModelAPI_Object>, int >::iterator anAIter = myUpdated.find(theArgument);
   if (anAIter == myUpdated.end())
     return false;
+  // for the modification IDs compare results: modification ID of feature means only that attributes
+  // of this feature were updated, but if results are obsolete relatively to the referenced results,
+  // the feature must be updated
+  std::list<ResultPtr> aResults;
+  ModelAPI_Tools::allResults(theFeature, aResults);
+  std::list<ResultPtr>::iterator aRIter = aResults.begin();
+  for (; aRIter != aResults.cend(); aRIter++) {
+    std::shared_ptr<ModelAPI_Result> aRes = *aRIter;
+    if (!aRes->isDisabled()) {
+      std::map<std::shared_ptr<ModelAPI_Object>, int >::iterator anRIter = myUpdated.find(aRes);
+      int aResultID = aRes->data()->updateID();
+      if (aResultID < anArgID)
+        return true;
+      if (anRIter == myUpdated.end()) // not updated at all
+        return true;
+      if (anRIter->second < anAIter->second)
+        return true;
+    }
+  }
+  // also check a feature: some have no parameters,
+  // but must be updated anyway (like Coincidence of sketch) to be redisplayed
   std::map<std::shared_ptr<ModelAPI_Object>, int >::iterator aFIter = myUpdated.find(theFeature);
   if (aFIter == myUpdated.end())
     return true; // argument is updated, but feature is not updated at all
@@ -541,7 +565,8 @@ void Model_Update::updateArguments(FeaturePtr theFeature) {
             aState = ModelAPI_StateInvalidArgument;
         }
       } else if (aSel->isInvalid()) { // not needed to update, but invalid (stated previously)
-        aState = ModelAPI_StateInvalidArgument;
+        if (isObligatory)
+          aState = ModelAPI_StateInvalidArgument;
       }
     }
   }
@@ -567,7 +592,8 @@ void Model_Update::updateArguments(FeaturePtr theFeature) {
                 aState = ModelAPI_StateInvalidArgument;
             }
           } else if (aSelAttr->isInvalid()) {
-            aState = ModelAPI_StateInvalidArgument;
+            if (isObligatory)
+              aState = ModelAPI_StateInvalidArgument;
           }
         }
       }
@@ -638,13 +664,14 @@ void Model_Update::executeFeature(FeaturePtr theFeature)
       aState = ModelAPI_StateExecFailed;
     } else {
       aState = ModelAPI_StateDone;
-      myWaitForFinish.insert(theFeature);
     }
   } catch(...) {
     aState = ModelAPI_StateExecFailed;
     Events_Error::send(
       "Feature " + theFeature->getKind() + " has failed during the execution");
   }
+  // The macro feature has to be deleted in any case even its execution is failed 
+  myWaitForFinish.insert(theFeature);
   if (aState != ModelAPI_StateDone) {
     theFeature->eraseResults();
   }
@@ -652,6 +679,53 @@ void Model_Update::executeFeature(FeaturePtr theFeature)
   redisplayWithResults(theFeature, aState);
 }
 
+void Model_Update::updateStability(void* theSender)
+{
+  if (theSender) {
+    bool added = false; // object may be was crated
+    ModelAPI_Object* aSender = static_cast<ModelAPI_Object*>(theSender);
+    if (aSender && aSender->document()) {
+      FeaturePtr aFeatureSender = 
+        std::dynamic_pointer_cast<ModelAPI_Feature>(aSender->data()->owner());
+      if (aFeatureSender.get()) {
+        Model_Objects* aDocObjects = 
+          std::dynamic_pointer_cast<Model_Document>(aSender->document())->objects();
+        if (aDocObjects) {
+          //aDocObjects->synchronizeBackRefs();
+          // remove or add all concealment refs from this feature
+          std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
+          aSender->data()->referencesToObjects(aRefs);
+          std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator aRefIt = aRefs.begin();
+          for(; aRefIt != aRefs.end(); aRefIt++) {
+            std::list<ObjectPtr>& aRefFeaturesList = aRefIt->second;
+            std::list<ObjectPtr>::iterator aReferenced = aRefFeaturesList.begin();
+            for(; aReferenced != aRefFeaturesList.end(); aReferenced++) {
+               // stability is only on results: feature to feature reference mean nested 
+              // features, that will remove nesting references
+              if (aReferenced->get() && (*aReferenced)->data()->isValid() && 
+                (*aReferenced)->groupName() != ModelAPI_Feature::group()) {
+                std::shared_ptr<Model_Data> aData = 
+                  std::dynamic_pointer_cast<Model_Data>((*aReferenced)->data());
+                if (aFeatureSender->isStable()) {
+                  aData->addBackReference(aFeatureSender, aRefIt->first);
+                } else {
+                  aData->removeBackReference(aFeatureSender, aRefIt->first);
+                  added = true; // remove of concealment may be caused creation of some result
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+    if (added) {
+      static Events_Loop* aLoop = Events_Loop::loop();
+      static Events_ID kEventCreated = aLoop->eventByName(EVENT_OBJECT_CREATED);
+      aLoop->flush(kEventCreated);
+    }
+  }
+}
+
 ///////////////// Updated items iterator ////////////////////////
 Model_Update::IterationItem::IterationItem(std::shared_ptr<ModelAPI_CompositeFeature> theFeature)
 {