Salome HOME
Updated copyright comment
[modules/shaper.git] / src / PartSet / PartSet_OverconstraintListener.cpp
old mode 100755 (executable)
new mode 100644 (file)
index 721c2d5..b8924b8
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        SketcherPrs_Angle.cpp
-// Created:     20 August 2015
-// Author:      Vitaly SMETANNIKOV
+// Copyright (C) 2014-2024  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// 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
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
+#include <ModelAPI_Tools.h>
+#include <ModelAPI_AttributeString.h>
+
+// Attention: keep the next include here,
+// otherwise it causes compilation errors at least on Debian 8
+#include <ModuleBase_Preferences.h>
 
 #include "PartSet_OverconstraintListener.h"
+#include <PartSet_Module.h>
+#include <PartSet_SketcherMgr.h>
+#include <PartSet_SketcherReentrantMgr.h>
 
+#include "XGUI_Displayer.h"
 #include "XGUI_ModuleConnector.h"
+#include "XGUI_OperationMgr.h"
+#include "XGUI_Tools.h"
 #include "XGUI_Workshop.h"
-#include "XGUI_Displayer.h"
 
 #include "SketcherPrs_SymbolPrs.h"
 #include "SketchPlugin_SketchEntity.h"
+#include "SketchPlugin_MacroArcReentrantMessage.h"
+#include "SketchPlugin_Sketch.h"
+#include "SketchPlugin_ConstraintHorizontal.h"
+#include "SketchPlugin_ConstraintVertical.h"
+
+#include <SUIT_ResourceMgr.h>
 
 #include "Events_Loop.h"
 
 #include <GeomAPI_IPresentable.h>
 #include <ModelAPI_Events.h>
+#include <ModelAPI_EventReentrantMessage.h>
 #include <ModuleBase_Tools.h>
 
 #include <QString>
+#include <QTimer>
 
-#define DEBUG_FEATURE_OVERCONSTRAINT_LISTENER
+//#define DEBUG_FEATURE_OVERCONSTRAINT_LISTENER
 
 PartSet_OverconstraintListener::PartSet_OverconstraintListener(ModuleBase_IWorkshop* theWorkshop)
-: myWorkshop(theWorkshop)
+: myWorkshop(theWorkshop), myIsActive(false), myIsFullyConstrained(false)
 {
   Events_Loop* aLoop = Events_Loop::loop();
   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_SOLVER_FAILED));
   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_SOLVER_REPAIRED));
+
+  aLoop->registerListener(this, Events_Loop::eventByName(EVENT_SKETCH_UNDER_CONSTRAINED));
+  aLoop->registerListener(this, Events_Loop::eventByName(EVENT_SKETCH_FULLY_CONSTRAINED));
+
+  aLoop->registerListener(this, ModelAPI_EventReentrantMessage::eventId());
+  aLoop->registerListener(this, SketchPlugin_MacroArcReentrantMessage::eventId());
+  aLoop->registerListener(this, Events_Loop::eventByName(EVENT_REMOVE_CONSTRAINTS));
 }
 
-bool PartSet_OverconstraintListener::isConflictingObject(const ObjectPtr& theObject)
+void PartSet_OverconstraintListener::setActive(const bool& theActive)
 {
-  return myConflictingObjects.find(theObject) != myConflictingObjects.end();
+  if (myIsActive == theActive)
+    return;
+
+  myIsActive = theActive;
+  myIsFullyConstrained = false; /// returned to default state, no custom color for it
+
+  if (myIsActive) {
+    PartSet_Module* aModule = module();
+    CompositeFeaturePtr aSketch = aModule->sketchMgr()->activeSketch();
+    if (aSketch.get()) {
+      QString aDOFMessage(aSketch->string(SketchPlugin_Sketch::SOLVER_DOF())->value().c_str());
+      if (aDOFMessage.contains('=')) {
+        // to support old data
+        aDOFMessage =
+          aDOFMessage.right(aDOFMessage.length() - aDOFMessage.lastIndexOf('=')).trimmed();
+      }
+      myIsFullyConstrained = (aDOFMessage == "0");
+    }
+  }
 }
 
-void PartSet_OverconstraintListener::getConflictingColor(std::vector<int>& theColor)
+void PartSet_OverconstraintListener::getCustomColor(const ObjectPtr& theObject,
+                                                    std::vector<int>& theColor)
 {
-  Quantity_Color aColor = ModuleBase_Tools::color("Visualization", "sketch_overconstraint_color",
-                                                  SKETCH_OVERCONSTRAINT_COLOR);
-  theColor.push_back(aColor.Red()*255.);
-  theColor.push_back(aColor.Green()*255.);
-  theColor.push_back(aColor.Blue()*255.);
+  if (!myIsActive)
+    return;
+
+  FeaturePtr aFeature = ModelAPI_Feature::feature(theObject);
+
+  if (myConflictingObjects.find(theObject) != myConflictingObjects.end()) {
+    theColor = Config_PropManager::color("Visualization", "sketch_overconstraint_color");
+  }
+  if (myIsFullyConstrained) {
+    // only entity features has custom color when sketch is fully constrained
+    if (aFeature.get() && PartSet_SketcherMgr::isEntity(aFeature->getKind()) &&
+        !PartSet_SketcherMgr::isExternalFeature(aFeature)) {
+      PartSet_Module* aModule = module();
+      CompositeFeaturePtr aSketch = aModule->sketchMgr()->activeSketch();
+      // the given object is sub feature of the current sketch(created or edited)
+      if (ModelAPI_Tools::compositeOwner(aFeature) == aSketch)
+        theColor = Config_PropManager::color("Visualization", "sketch_fully_constrained_color");
+    }
+  }
 }
 
-void PartSet_OverconstraintListener::processEvent(
-                                                 const std::shared_ptr<Events_Message>& theMessage)
+void PartSet_OverconstraintListener::processEvent(const std::shared_ptr<Events_Message>& theMessage)
 {
+  // #2271 open document: if sketch has confilcting elements, solver sends message with the
+  // elements by opening the document. Sketch is not active, but an internal container should
+  // be updated. So, we should not check whether the listener is active here
+  //if (!myIsActive)
+  //  return;
+
 #ifdef DEBUG_FEATURE_OVERCONSTRAINT_LISTENER
   bool isRepaired = theMessage->eventID() == Events_Loop::eventByName(EVENT_SOLVER_REPAIRED);
   int aCount = 0;
@@ -63,37 +141,126 @@ void PartSet_OverconstraintListener::processEvent(
 
   QString aCurrentInfoStr = getObjectsInfo(myConflictingObjects);
 
-  qDebug(QString("PartSet_OverconstraintListener::processEvent: %1,\nobjects count = %2:%3\ncurrent objects count = %4:%5")
-                .arg(isRepaired ? "REPAIRED" : "FAILED")
-                .arg(aCount).arg(anInfoStr).arg(myConflictingObjects.size()).arg(aCurrentInfoStr).toStdString().c_str());
+  QString aMsg("PartSet_OverconstraintListener::processEvent: %1,\nobjects "
+               "count = %2:%3\ncurrent objects count = %4:%5");
+  qDebug(aMsg.arg(isRepaired ? "REPAIRED" : "FAILED")
+             .arg(aCount).arg(anInfoStr).arg(myConflictingObjects.size())
+             .arg(aCurrentInfoStr).toStdString().c_str());
 #endif
 
-  if (theMessage->eventID() == Events_Loop::eventByName(EVENT_SOLVER_FAILED)) {
+  Events_ID anEventID = theMessage->eventID();
+  if (anEventID == Events_Loop::eventByName(EVENT_SOLVER_FAILED) ||
+      anEventID == Events_Loop::eventByName(EVENT_SOLVER_REPAIRED)) {
     std::shared_ptr<ModelAPI_SolverFailedMessage> anErrorMsg =
                    std::dynamic_pointer_cast<ModelAPI_SolverFailedMessage>(theMessage);
-    bool anUpdated = false;
     if (anErrorMsg.get()) {
       const std::set<ObjectPtr>& aConflictingObjects = anErrorMsg->objects();
-      anUpdated = appendConflictingObjects(aConflictingObjects);
+      if (anEventID == Events_Loop::eventByName(EVENT_SOLVER_FAILED))
+        appendConflictingObjects(aConflictingObjects);
+      else
+        repairConflictingObjects(aConflictingObjects);
     }
-    else {
-      // there is a crash in the solver. All objects are invalid
-      //anUpdated = appendConflictingObjects(std::set<ObjectPtr>());
+  }
+  else if (anEventID == Events_Loop::eventByName(EVENT_SKETCH_UNDER_CONSTRAINED) ||
+           anEventID == Events_Loop::eventByName(EVENT_SKETCH_FULLY_CONSTRAINED)) {
+    bool aPrevFullyConstrained = myIsFullyConstrained;
+    myIsFullyConstrained = anEventID == Events_Loop::eventByName(EVENT_SKETCH_FULLY_CONSTRAINED);
+
+    if (aPrevFullyConstrained != myIsFullyConstrained) {
+      std::set<ObjectPtr> aModifiedObjects;
+      PartSet_Module* aModule = dynamic_cast<PartSet_Module*>(myWorkshop->module());
+      CompositeFeaturePtr aSketch = aModule->sketchMgr()->activeSketch();
+
+      // check the sketch in the message and the active sketch are the same
+      std::shared_ptr<ModelAPI_SolverFailedMessage> anErrorMsg =
+          std::dynamic_pointer_cast<ModelAPI_SolverFailedMessage>(theMessage);
+      if (aSketch && anErrorMsg && !anErrorMsg->objects().empty()) {
+        ObjectPtr anObject = *anErrorMsg->objects().begin();
+        CompositeFeaturePtr aSketchFromMsg =
+            std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(anObject);
+        if (!aSketchFromMsg || aSketchFromMsg != aSketch)
+          aSketch = CompositeFeaturePtr();
+      }
+
+      if (aSketch.get()) {
+        int aNumberOfSubs = aSketch->numberOfSubs();
+        for (int i = 0; i < aNumberOfSubs; i++) {
+          FeaturePtr aFeature = aSketch->subFeature(i);
+          aModifiedObjects.insert(aFeature); // is necessary to redisplay presentations
+          std::list<ResultPtr> aResults = aFeature->results();
+          for (std::list<ResultPtr>::const_iterator aIt = aResults.begin();
+               aIt != aResults.end(); ++aIt) {
+            aModifiedObjects.insert(*aIt);
+          }
+        }
+        redisplayObjects(aModifiedObjects);
+      }
     }
   }
-   if (theMessage->eventID() == Events_Loop::eventByName(EVENT_SOLVER_REPAIRED)) {
-    std::shared_ptr<ModelAPI_SolverFailedMessage> anErrorMsg =
-                   std::dynamic_pointer_cast<ModelAPI_SolverFailedMessage>(theMessage);
-    bool anUpdated = false;
-    if (anErrorMsg.get()) {
-      const std::set<ObjectPtr>& aConflictingObjects = anErrorMsg->objects();
-      anUpdated = repairConflictingObjects(aConflictingObjects);
+  else if (anEventID == ModelAPI_EventReentrantMessage::eventId() ||
+           anEventID == SketchPlugin_MacroArcReentrantMessage::eventId()) {
+    // the message is sent to sketcher reentrant manager only if the name of feature
+    // sender is equal to feature name of the current operation. E.g. Horizontal create operation
+    // is active. Sketch Line feature is changed, so execute is called, it will send message
+    // This Line's message should not be processed, as the reentrant operation is not for Line
+    // It is not enoght of kind, the name should be used, e.g. restarted Lines on auxiliary
+    // cirlce sometimes causes previous line change, kind the same, but feature line is different
+    std::wstring aCurrentFeatureName;
+    ModuleBase_Operation* anOperation =
+                XGUI_Tools::workshop(myWorkshop)->operationMgr()->currentOperation();
+    if (anOperation) {
+      ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
+                                                           (anOperation);
+      if (aFOperation) {
+        FeaturePtr aFeature = aFOperation->feature();
+        // data valid is necessary if the feature has been already deleted
+        // (e.g. Esc of Lenght if lenght value is modified)
+        if (aFeature.get() && aFeature->data()->isValid())
+          aCurrentFeatureName = aFeature->data()->name();
+      }
     }
-    else {
-      // there is no repaired objects, do nothing
+    if (theMessage->sender()) {
+      ModelAPI_Object* aSender = static_cast<ModelAPI_Object*>(theMessage->sender());
+      if (aSender) {
+        FeaturePtr aFeatureSender =
+          std::dynamic_pointer_cast<ModelAPI_Feature>(aSender->data()->owner());
+        if (aFeatureSender.get() && aFeatureSender->data()->name() == aCurrentFeatureName) {
+          PartSet_Module* aModule = dynamic_cast<PartSet_Module*>(myWorkshop->module());
+          PartSet_SketcherReentrantMgr* aReentrantMgr = aModule->sketchReentranceMgr();
+          aReentrantMgr->setReentrantMessage(theMessage);
+        }
+      }
     }
   }
+  else if (anEventID == Events_Loop::eventByName(EVENT_REMOVE_CONSTRAINTS)) {
+    std::shared_ptr<ModelAPI_CheckConstraintsMessage> aConstraintsMsg =
+      std::dynamic_pointer_cast<ModelAPI_CheckConstraintsMessage>(theMessage);
+    if (aConstraintsMsg.get()) {
+      myObjectsToRemove = aConstraintsMsg->constraints();
+
+      std::set<ObjectPtr>::const_iterator anIt = myObjectsToRemove.begin();
+
+      PartSet_Module* aModule = dynamic_cast<PartSet_Module*>(myWorkshop->module());
+
+      for (; anIt != myObjectsToRemove.end(); )
+      {
+        ObjectPtr anObject = *anIt;
+        FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(anObject);
+        std::string aType = aFeature->getKind();
+        if ((aType == SketchPlugin_ConstraintHorizontal::ID() ||
+             aType == SketchPlugin_ConstraintVertical::ID()) &&
+             !aModule->sketchReentranceMgr()->isLastAutoConstraint(*anIt))
+          anIt = myObjectsToRemove.erase(anIt);
+        else
+          anIt++;
+      }
+
+      if (myObjectsToRemove.empty())
+        return;
 
+      QTimer::singleShot(5, aModule, SLOT(onRemoveConflictingConstraints()));
+    }
+  }
 #ifdef DEBUG_FEATURE_OVERCONSTRAINT_LISTENER
   aCurrentInfoStr = getObjectsInfo(myConflictingObjects);
   qDebug(QString("RESULT: current objects count = %1:%2\n")
@@ -102,38 +269,58 @@ void PartSet_OverconstraintListener::processEvent(
 }
 
 bool PartSet_OverconstraintListener::appendConflictingObjects(
-                                                  const std::set<ObjectPtr>& theConflictingObjects)
+                                               const std::set<ObjectPtr>& theConflictingObjects)
 {
-  std::set<ObjectPtr> aModifiedObjects;
-  // set error state for new objects and append them in the internal map of objects
-  std::set<ObjectPtr>::const_iterator anIt = theConflictingObjects.begin(), aLast = theConflictingObjects.end();
-  for (; anIt != aLast; anIt++) {
-    ObjectPtr anObject = *anIt;
-    if (myConflictingObjects.find(anObject) == myConflictingObjects.end()) { // it is not found
-      setConflictingObject(anObject, true);
-      aModifiedObjects.insert(anObject);
-      myConflictingObjects.insert(anObject);
+  bool isAllowToChange = ModuleBase_Preferences::resourceMgr()->booleanValue(SKETCH_TAB_NAME,
+                                        "allow_change_constraint");
+  if (isAllowToChange) {
+    std::set<ObjectPtr> aModifiedObjects;
+
+    // set error state for new objects and append them in the internal map of objects
+    std::set<ObjectPtr>::const_iterator
+      anIt = theConflictingObjects.begin(), aLast = theConflictingObjects.end();
+
+    int aCountOfSimilarConstraints = 0;
+    for (; anIt != aLast; anIt++) {
+      ObjectPtr anObject = *anIt;
+      if (myConflictingObjects.find(anObject) == myConflictingObjects.end()) { // it is not found
+        aModifiedObjects.insert(anObject);
+        myConflictingObjects.insert(anObject);
+      }
+      else
+        ++aCountOfSimilarConstraints;
     }
-  }
-  bool isUpdated = !aModifiedObjects.empty();
-  if (isUpdated)
-    redisplayObjects(aModifiedObjects);
 
-  return isUpdated;
+    if (theConflictingObjects.size() == aCountOfSimilarConstraints)
+      return false;
+
+    std::shared_ptr<ModelAPI_CheckConstraintsMessage> aMessage =
+      std::shared_ptr<ModelAPI_CheckConstraintsMessage>(
+        new ModelAPI_CheckConstraintsMessage(
+          Events_Loop::eventByName(EVENT_CHECK_CONSTRAINTS)));
+    aMessage->setConstraints(theConflictingObjects);
+    Events_Loop::loop()->send(aMessage);
+
+    bool isUpdated = !aModifiedObjects.empty();
+    if (isUpdated)
+      redisplayObjects(aModifiedObjects);
+    return isUpdated;
+  }
+  else
+    return false;
 }
 
 bool PartSet_OverconstraintListener::repairConflictingObjects(
-                                                  const std::set<ObjectPtr>& theConflictingObjects)
+                                              const std::set<ObjectPtr>& theConflictingObjects)
 {
   std::set<ObjectPtr> aModifiedObjects;
   // erase error state of absent current objects in the parameter list
   std::set<ObjectPtr>::const_iterator anIt, aLast;
-  for (anIt = theConflictingObjects.begin(), aLast = theConflictingObjects.end() ; anIt != aLast; anIt++) {
+  for (anIt = theConflictingObjects.begin(), aLast = theConflictingObjects.end();
+       anIt != aLast; anIt++) {
     ObjectPtr anObject = *anIt;
     if (theConflictingObjects.find(anObject) != theConflictingObjects.end()) { // it is found
-      setConflictingObject(anObject, false);
       myConflictingObjects.erase(anObject);
-
       aModifiedObjects.insert(anObject);
     }
   }
@@ -147,68 +334,28 @@ bool PartSet_OverconstraintListener::repairConflictingObjects(
 void PartSet_OverconstraintListener::redisplayObjects(
                                               const std::set<ObjectPtr>& theObjects)
 {
-/*static Events_Loop* aLoop = Events_Loop::loop();
-  static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_UPDATED);
+  static Events_Loop* aLoop = Events_Loop::loop();
 
+  static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_VISUAL_ATTRIBUTES);
+  static Events_ID EVENT_REDISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
   static const ModelAPI_EventCreator* aECreator = ModelAPI_EventCreator::get();
 
   std::set<ObjectPtr>::const_iterator anIt = theObjects.begin(), aLast = theObjects.end();
   for (; anIt != aLast; anIt++) {
-    aECreator->sendUpdated(*anIt, EVENT_DISP);
-
-    //#ifdef DEBUG_FEATURE_OVERCONSTRAINT_LISTENER
-    //  QString anInfoStr = ModuleBase_Tools::objectInfo(*anIt);
-    //  qDebug(QString("PartSet_OverconstraintListener::SEND UPDATED: %1").arg(anInfoStr).toStdString().c_str());
-    //#endif
-  }
-  aLoop->flush(EVENT_DISP);*/
-
-  XGUI_Displayer* aDisplayer = workshop()->displayer();
-  bool aHidden;
-  std::set<ObjectPtr>::const_iterator anIt = theObjects.begin(), aLast = theObjects.end();
-  for (; anIt != aLast; anIt++) {
-    ObjectPtr anObject = *anIt;
-    aHidden = !anObject->data() || !anObject->data()->isValid() || 
-               anObject->isDisabled() || (!anObject->isDisplayed());
-    if (!aHidden)
-      aDisplayer->redisplay(anObject, false);
-  }
-  aDisplayer->updateViewer();
-}
-
-void PartSet_OverconstraintListener::setConflictingObject(const ObjectPtr& theObject,
-                                                          const bool theConflicting)
-{
-  if (!theObject.get() || !theObject->data()->isValid())
-    return;
-
-  AISObjectPtr anAISObject;
-  GeomPresentablePtr aPrs = std::dynamic_pointer_cast<GeomAPI_IPresentable>(theObject);
-
-  if (aPrs.get() != NULL) {
-    XGUI_Workshop* aWorkshop = workshop();
-    XGUI_Displayer* aDisplayer = aWorkshop->displayer();
-
-    anAISObject = aPrs->getAISObject(aDisplayer->getAISObject(theObject));
-    if (anAISObject.get()) {
-      Handle(AIS_InteractiveObject) anAISIO = anAISObject->impl<Handle(AIS_InteractiveObject)>();
-      if (!anAISIO.IsNull()) {
-        if (!Handle(SketcherPrs_SymbolPrs)::DownCast(anAISIO).IsNull()) {
-          Handle(SketcherPrs_SymbolPrs) aPrs = Handle(SketcherPrs_SymbolPrs)::DownCast(anAISIO);
-          if (!aPrs.IsNull())
-            aPrs->SetConflictingConstraint(theConflicting);
-        }
-      }
-    }
+    ObjectPtr aObj = *anIt;
+    aECreator->sendUpdated(aObj, EVENT_DISP);
+    aECreator->sendUpdated(aObj, EVENT_REDISP);
   }
+  aLoop->flush(EVENT_DISP);
+  aLoop->flush(EVENT_REDISP);
 }
 
-XGUI_Workshop* PartSet_OverconstraintListener::workshop() const
+PartSet_Module* PartSet_OverconstraintListener::module() const
 {
-  XGUI_ModuleConnector* aConnector = dynamic_cast<XGUI_ModuleConnector*>(myWorkshop);
-  return aConnector->workshop();
+  return dynamic_cast<PartSet_Module*>(myWorkshop->module());
 }
 
+#ifdef _DEBUG
 QString PartSet_OverconstraintListener::getObjectsInfo(const std::set<ObjectPtr>& theObjects)
 {
   std::set<ObjectPtr>::const_iterator anIt = theObjects.begin(),
@@ -219,3 +366,4 @@ QString PartSet_OverconstraintListener::getObjectsInfo(const std::set<ObjectPtr>
 
   return anInfo.join(";\n");
 }
+#endif