src/SketchSolver/SketchSolver_Group.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:    SketchSolver_Group.cpp
   4 // Created: 27 May 2014
   5 // Author:  Artem ZHIDKOV
   6
   7 #include "SketchSolver_Group.h"
   8 #include <SketchSolver_Error.h>
   9 #include <SketchSolver_Manager.h>
  10
  11 #include <PlaneGCSSolver_Solver.h>
  12 #include <PlaneGCSSolver_Storage.h>
  13 #include <PlaneGCSSolver_Tools.h>
  14
  15 #include <Events_InfoMessage.h>
  16 #include <ModelAPI_AttributeString.h>
  17 #include <ModelAPI_Events.h>
  18 #include <SketchPlugin_ConstraintMirror.h>
  19 #include <SketchPlugin_ConstraintRigid.h>
  20 #include <SketchPlugin_MultiRotation.h>
  21 #include <SketchPlugin_MultiTranslation.h>
  22
  23
  24 static void sendMessage(const char* theMessageName)
  25 {
  26   std::shared_ptr<Events_Message> aMessage = std::shared_ptr<Events_Message>(
  27       new Events_Message(Events_Loop::eventByName(theMessageName)));
  28   Events_Loop::loop()->send(aMessage);
  29 }
  30
  31 static void sendMessage(const char* theMessageName, const std::set<ObjectPtr>& theConflicting)
  32 {
  33   std::shared_ptr<ModelAPI_SolverFailedMessage> aMessage =
  34       std::shared_ptr<ModelAPI_SolverFailedMessage>(
  35       new ModelAPI_SolverFailedMessage(Events_Loop::eventByName(theMessageName)));
  36   aMessage->setObjects(theConflicting);
  37   Events_Loop::loop()->send(aMessage);
  38 }
  39
  40 static void sendMessage(const char* theMessageName,
  41                         const CompositeFeaturePtr& theSketch,
  42                         const int theDOF)
  43 {
  44   std::shared_ptr<ModelAPI_SolverFailedMessage> aMessage =
  45       std::shared_ptr<ModelAPI_SolverFailedMessage>(
  46       new ModelAPI_SolverFailedMessage(Events_Loop::eventByName(theMessageName)));
  47
  48   std::set<ObjectPtr> anObjects;
  49   anObjects.insert(theSketch);
  50   aMessage->setObjects(anObjects);
  51   aMessage->dof(theDOF);
  52
  53   Events_Loop::loop()->send(aMessage);
  54 }
  55
  56
  57
  58 // ========================================================
  59 // =========  SketchSolver_Group  ===============
  60 // ========================================================
  61
  62 SketchSolver_Group::SketchSolver_Group(const CompositeFeaturePtr& theWorkplane)
  63   : mySketch(theWorkplane),
  64     myPrevResult(PlaneGCSSolver_Solver::STATUS_UNKNOWN),
  65     myDOF(0),
  66     myIsEventsBlocked(false),
  67     myMultiConstraintUpdateStack(0)
  68 {
  69   mySketchSolver = SolverPtr(new PlaneGCSSolver_Solver);
  70   myStorage = StoragePtr(new PlaneGCSSolver_Storage(mySketchSolver));
  71 }
  72
  73 SketchSolver_Group::~SketchSolver_Group()
  74 {
  75   myConstraints.clear();
  76   // send the message that there is no more conflicting constraints
  77   if (!myConflictingConstraints.empty()) {
  78     sendMessage(EVENT_SOLVER_REPAIRED, myConflictingConstraints);
  79     myConflictingConstraints.clear();
  80   }
  81 }
  82
  83 // ============================================================================
  84 //  Function: changeConstraint
  85 //  Class:    SketchSolver_Group
  86 //  Purpose:  create/update the constraint in the group
  87 // ============================================================================
  88 bool SketchSolver_Group::changeConstraint(
  89     std::shared_ptr<SketchPlugin_Constraint> theConstraint)
  90 {
  91   bool isNewConstraint = myConstraints.find(theConstraint) == myConstraints.end();
  92   if (isNewConstraint) {
  93     // Add constraint to the current group
  94     SolverConstraintPtr aConstraint = PlaneGCSSolver_Tools::createConstraint(theConstraint);
  95     if (!aConstraint)
  96       return false;
  97     aConstraint->process(myStorage, myIsEventsBlocked);
  98     if (!aConstraint->error().empty()) {
  99       if (aConstraint->error() == SketchSolver_Error::NOT_INITIALIZED())
 100         return false; // some attribute are not initialized yet, don't show message
 101       Events_InfoMessage("SketchSolver_Group", aConstraint->error(), this).send();
 102     }
 103     myConstraints[theConstraint] = aConstraint;
 104   }
 105   else
 106     myConstraints[theConstraint]->update();
 107
 108   // constraint is created/updated => reset stack of "multi" constraints updates
 109   myMultiConstraintUpdateStack = 0;
 110   return true;
 111 }
 112
 113 bool SketchSolver_Group::updateFeature(FeaturePtr theFeature)
 114 {
 115   return myStorage->update(theFeature);
 116 }
 117
 118 bool SketchSolver_Group::moveFeature(FeaturePtr theFeature)
 119 {
 120   bool isFeatureExists = (myStorage->entity(theFeature).get() != 0);
 121   if (myDOF == 0 && isFeatureExists) {
 122     // avoid moving elements of fully constrained sketch
 123     myStorage->refresh();
 124     return true;
 125   }
 126
 127   // Create temporary Fixed constraint
 128   SolverConstraintPtr aConstraint = PlaneGCSSolver_Tools::createMovementConstraint(theFeature);
 129   if (!aConstraint)
 130     return false;
 131   aConstraint->process(myStorage, myIsEventsBlocked);
 132   if (aConstraint->error().empty())
 133     setTemporary(aConstraint);
 134   else
 135     myStorage->notify(theFeature);
 136
 137   return true;
 138 }
 139
 140 // ============================================================================
 141 //  Function: resolveConstraints
 142 //  Class:    SketchSolver_Group
 143 //  Purpose:  solve the set of constraints for the current group
 144 // ============================================================================
 145 bool SketchSolver_Group::resolveConstraints()
 146 {
 147   // check the "Multi" constraints do not drop sketch into infinite loop
 148   if (myMultiConstraintUpdateStack > 1) {
 149     myPrevResult = PlaneGCSSolver_Solver::STATUS_FAILED;
 150     // generate error message due to loop update of the sketch
 151     getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())
 152       ->setValue(SketchSolver_Error::INFINITE_LOOP());
 153     sendMessage(EVENT_SOLVER_FAILED, myConflictingConstraints);
 154     return false;
 155   }
 156
 157   bool aResolved = false;
 158   bool isGroupEmpty = isEmpty() && myStorage->isEmpty();
 159   if (myStorage->isNeedToResolve() &&
 160       (!isGroupEmpty || !myConflictingConstraints.empty() ||
 161         myPrevResult == PlaneGCSSolver_Solver::STATUS_FAILED)) {
 162
 163     PlaneGCSSolver_Solver::SolveStatus aResult = PlaneGCSSolver_Solver::STATUS_OK;
 164     try {
 165       if (!isGroupEmpty && myMultiConstraintUpdateStack <= 1)
 166         aResult = mySketchSolver->solve();
 167     } catch (...) {
 168       getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())
 169         ->setValue(SketchSolver_Error::SOLVESPACE_CRASH());
 170       if (myPrevResult == PlaneGCSSolver_Solver::STATUS_OK ||
 171           myPrevResult == PlaneGCSSolver_Solver::STATUS_UNKNOWN) {
 172         // the error message should be changed before sending the message
 173         sendMessage(EVENT_SOLVER_FAILED);
 174         myPrevResult = PlaneGCSSolver_Solver::STATUS_FAILED;
 175       }
 176       mySketchSolver->undo();
 177       return false;
 178     }
 179     // solution succeeded, store results into correspondent attributes
 180     if (aResult == PlaneGCSSolver_Solver::STATUS_OK ||
 181         aResult == PlaneGCSSolver_Solver::STATUS_EMPTYSET) {
 182       myStorage->setNeedToResolve(false);
 183       myStorage->refresh();
 184
 185       // additional check that copied entities used in Mirror and other "Multi" constraints
 186       // is not connected with their originals by constraints.
 187       myMultiConstraintUpdateStack += 1;
 188       aResolved = true;
 189       if (myStorage->isNeedToResolve())
 190         aResolved = resolveConstraints();
 191
 192       if (aResolved) {
 193         myMultiConstraintUpdateStack -= 1;
 194
 195         if (myPrevResult != PlaneGCSSolver_Solver::STATUS_OK ||
 196             myPrevResult == PlaneGCSSolver_Solver::STATUS_UNKNOWN) {
 197           getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())->setValue("");
 198           std::set<ObjectPtr> aConflicting = myConflictingConstraints;
 199           myConflictingConstraints.clear();
 200           myPrevResult = PlaneGCSSolver_Solver::STATUS_OK;
 201           // the error message should be changed before sending the message
 202           sendMessage(EVENT_SOLVER_REPAIRED, aConflicting);
 203         }
 204       }
 205
 206       // show degrees of freedom
 207       computeDoF();
 208     } else {
 209       mySketchSolver->undo();
 210       if (!myConstraints.empty()) {
 211         // the error message should be changed before sending the message
 212         getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())
 213           ->setValue(SketchSolver_Error::CONSTRAINTS());
 214         if (myPrevResult != aResult ||
 215             myPrevResult == PlaneGCSSolver_Solver::STATUS_UNKNOWN ||
 216             myPrevResult == PlaneGCSSolver_Solver::STATUS_FAILED) {
 217           // Obtain list of conflicting constraints
 218           std::set<ObjectPtr> aConflicting = myStorage->getConflictingConstraints(mySketchSolver);
 219
 220           if (!myConflictingConstraints.empty()) {
 221             std::set<ObjectPtr>::iterator anIt = aConflicting.begin();
 222             for (; anIt != aConflicting.end(); ++anIt)
 223               myConflictingConstraints.erase(*anIt);
 224             if (!myConflictingConstraints.empty()) {
 225               // some constraints does not conflict, send corresponding message
 226               sendMessage(EVENT_SOLVER_REPAIRED, myConflictingConstraints);
 227             }
 228           }
 229           myConflictingConstraints = aConflicting;
 230           if (!myConflictingConstraints.empty())
 231             sendMessage(EVENT_SOLVER_FAILED, myConflictingConstraints);
 232           myPrevResult = aResult;
 233         }
 234       }
 235     }
 236
 237   } else if (isGroupEmpty && isWorkplaneValid())
 238     computeDoF();
 239   removeTemporaryConstraints();
 240   myStorage->setNeedToResolve(false);
 241   return aResolved;
 242 }
 243
 244 // ============================================================================
 245 //  Function: computeDoF
 246 //  Class:    SketchSolver_Group
 247 //  Purpose:  compute DoF of the sketch and set corresponding field
 248 // ============================================================================
 249 void SketchSolver_Group::computeDoF()
 250 {
 251   std::ostringstream aDoFMsg;
 252   int aDoF = mySketchSolver->dof();
 253   /// "DoF = 0" content of string value is used in PartSet by Sketch edit
 254   /// If it is changed, it should be corrected also there
 255   if (aDoF == 0)
 256     aDoFMsg << "Sketch is fully fixed (DoF = 0)";
 257   else
 258     aDoFMsg << "DoF (degrees of freedom) = " << aDoF;
 259   mySketch->string(SketchPlugin_Sketch::SOLVER_DOF())->setValue(aDoFMsg.str());
 260
 261   if (aDoF > 0 && myDOF == 0)
 262     sendMessage(EVENT_SKETCH_UNDER_CONSTRAINED, mySketch, aDoF);
 263   else if (aDoF == 0 && myDOF > 0)
 264     sendMessage(EVENT_SKETCH_FULLY_CONSTRAINED, mySketch, aDoF);
 265   else if (aDoF < 0)
 266     sendMessage(EVENT_SKETCH_OVER_CONSTRAINED, mySketch, aDoF);
 267
 268   myDOF = aDoF;
 269 }
 270
 271 // ============================================================================
 272 //  Function: repairConsistency
 273 //  Class:    SketchSolver_Group
 274 //  Purpose:  search removed entities and constraints
 275 // ============================================================================
 276 void SketchSolver_Group::repairConsistency()
 277 {
 278   if (!areConstraintsValid() || !myStorage->areFeaturesValid()) {
 279     // remove invalid constraints
 280     std::set<ConstraintPtr> anInvalidConstraints;
 281     ConstraintConstraintMap::iterator aCIter = myConstraints.begin();
 282     for (; aCIter != myConstraints.end(); ++aCIter) {
 283       if (!aCIter->first->data() || !aCIter->first->data()->isValid())
 284         anInvalidConstraints.insert(aCIter->first);
 285     }
 286     std::set<ConstraintPtr>::const_iterator aRemoveIt = anInvalidConstraints.begin();
 287     for (; aRemoveIt != anInvalidConstraints.end(); ++aRemoveIt)
 288       removeConstraint(*aRemoveIt);
 289
 290     // remove invalid features
 291     myStorage->removeInvalidEntities();
 292
 293     // show DoF
 294     computeDoF();
 295   }
 296 }
 297
 298 // ============================================================================
 299 //  Function: removeTemporaryConstraints
 300 //  Class:    SketchSolver_Group
 301 //  Purpose:  remove all transient SLVS_C_WHERE_DRAGGED constraints after
 302 //            resolving the set of constraints
 303 // ============================================================================
 304 void SketchSolver_Group::removeTemporaryConstraints()
 305 {
 306   if (!myTempConstraints.empty()) {
 307     mySketchSolver->removeConstraint(CID_MOVEMENT);
 308
 309     std::set<SolverConstraintPtr>::iterator aTmpIt = myTempConstraints.begin();
 310     for (; aTmpIt != myTempConstraints.end(); ++aTmpIt)
 311       (*aTmpIt)->remove();
 312
 313     myTempConstraints.clear();
 314   }
 315
 316   myStorage->setNeedToResolve(false);
 317 }
 318
 319 // ============================================================================
 320 //  Function: removeConstraint
 321 //  Class:    SketchSolver_Group
 322 //  Purpose:  remove constraint and all unused entities
 323 // ============================================================================
 324 void SketchSolver_Group::removeConstraint(ConstraintPtr theConstraint)
 325 {
 326   ConstraintConstraintMap::iterator aCIter = myConstraints.begin();
 327   for (; aCIter != myConstraints.end(); aCIter++)
 328     if (aCIter->first == theConstraint) {
 329       aCIter->second->remove(); // the constraint is not fully removed
 330
 331       // constraint is removed => reset stack of "multi" constraints updates
 332       myMultiConstraintUpdateStack = 0;
 333       break;
 334     }
 335   if (aCIter != myConstraints.end())
 336     myConstraints.erase(aCIter);
 337 }
 338
 339 // ============================================================================
 340 //  Function: setTemporary
 341 //  Class:    SketchSolver_Group
 342 //  Purpose:  append given constraint to the group of temporary constraints
 343 // ============================================================================
 344 void SketchSolver_Group::setTemporary(SolverConstraintPtr theConstraint)
 345 {
 346   myTempConstraints.insert(theConstraint);
 347 }
 348
 349 // ============================================================================
 350 //  Function: blockEvents
 351 //  Class:    SketchSolver_Group
 352 //  Purpose:  block or unblock events from features in this group
 353 // ============================================================================
 354 void SketchSolver_Group::blockEvents(bool isBlocked)
 355 {
 356   if (myIsEventsBlocked == isBlocked)
 357     return;
 358
 359   // block/unblock events from the features in the storage
 360   myStorage->blockEvents(isBlocked);
 361
 362   // block/unblock events from constraints
 363   ConstraintConstraintMap::iterator aCIt = myConstraints.begin();
 364   for (; aCIt != myConstraints.end(); ++aCIt)
 365     aCIt->second->blockEvents(isBlocked);
 366
 367   myIsEventsBlocked = isBlocked;
 368 }
 369
 370 bool SketchSolver_Group::areConstraintsValid() const
 371 {
 372   // Check the constraints are valid
 373   ConstraintConstraintMap::const_iterator aCIter = myConstraints.begin();
 374   for (; aCIter != myConstraints.end(); ++aCIter)
 375     if (!aCIter->first->data() || !aCIter->first->data()->isValid())
 376       return false;
 377   return true;
 378 }