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 #include <iostream>
 145 // ============================================================================
 146 bool SketchSolver_Group::resolveConstraints()
 147 {
 148   static const int MAX_STACK_SIZE = 5;
 149   // check the "Multi" constraints do not drop sketch into infinite loop
 150   if (myMultiConstraintUpdateStack > MAX_STACK_SIZE) {
 151     myMultiConstraintUpdateStack = 0;
 152     myPrevResult = PlaneGCSSolver_Solver::STATUS_FAILED;
 153     // generate error message due to loop update of the sketch
 154     getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())
 155       ->setValue(SketchSolver_Error::INFINITE_LOOP());
 156     sendMessage(EVENT_SOLVER_FAILED, myConflictingConstraints);
 157     return false;
 158   }
 159
 160   bool aResolved = false;
 161   bool isGroupEmpty = isEmpty() && myStorage->isEmpty();
 162   if (myStorage->isNeedToResolve() &&
 163       (!isGroupEmpty || !myConflictingConstraints.empty() ||
 164         myPrevResult == PlaneGCSSolver_Solver::STATUS_FAILED)) {
 165
 166     PlaneGCSSolver_Solver::SolveStatus aResult = PlaneGCSSolver_Solver::STATUS_OK;
 167     try {
 168       if (!isGroupEmpty)
 169         aResult = mySketchSolver->solve();
 170     } catch (...) {
 171       getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())
 172         ->setValue(SketchSolver_Error::SOLVESPACE_CRASH());
 173       if (myPrevResult == PlaneGCSSolver_Solver::STATUS_OK ||
 174           myPrevResult == PlaneGCSSolver_Solver::STATUS_UNKNOWN) {
 175         // the error message should be changed before sending the message
 176         sendMessage(EVENT_SOLVER_FAILED);
 177         myPrevResult = PlaneGCSSolver_Solver::STATUS_FAILED;
 178       }
 179       mySketchSolver->undo();
 180       return false;
 181     }
 182     // solution succeeded, store results into correspondent attributes
 183     if (aResult == PlaneGCSSolver_Solver::STATUS_OK ||
 184         aResult == PlaneGCSSolver_Solver::STATUS_EMPTYSET) {
 185       myStorage->setNeedToResolve(false);
 186       myStorage->refresh();
 187
 188       // additional check that copied entities used in Mirror and other "Multi" constraints
 189       // is not connected with their originals by constraints.
 190       myMultiConstraintUpdateStack += 1;
 191       aResolved = true;
 192       if (myStorage->isNeedToResolve())
 193         aResolved = resolveConstraints();
 194
 195       if (aResolved) {
 196         myMultiConstraintUpdateStack -= 1;
 197
 198         if (myPrevResult != PlaneGCSSolver_Solver::STATUS_OK ||
 199             myPrevResult == PlaneGCSSolver_Solver::STATUS_UNKNOWN) {
 200           getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())->setValue("");
 201           std::set<ObjectPtr> aConflicting = myConflictingConstraints;
 202           myConflictingConstraints.clear();
 203           myPrevResult = PlaneGCSSolver_Solver::STATUS_OK;
 204           // the error message should be changed before sending the message
 205           sendMessage(EVENT_SOLVER_REPAIRED, aConflicting);
 206         }
 207       }
 208
 209       // show degrees of freedom
 210       computeDoF();
 211     } else {
 212       mySketchSolver->undo();
 213       if (!myConstraints.empty()) {
 214         // the error message should be changed before sending the message
 215         getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())
 216           ->setValue(SketchSolver_Error::CONSTRAINTS());
 217         if (myPrevResult != aResult ||
 218             myPrevResult == PlaneGCSSolver_Solver::STATUS_UNKNOWN ||
 219             myPrevResult == PlaneGCSSolver_Solver::STATUS_FAILED) {
 220           // Obtain list of conflicting constraints
 221           std::set<ObjectPtr> aConflicting = myStorage->getConflictingConstraints(mySketchSolver);
 222
 223           if (!myConflictingConstraints.empty()) {
 224             std::set<ObjectPtr>::iterator anIt = aConflicting.begin();
 225             for (; anIt != aConflicting.end(); ++anIt)
 226               myConflictingConstraints.erase(*anIt);
 227             if (!myConflictingConstraints.empty()) {
 228               // some constraints does not conflict, send corresponding message
 229               sendMessage(EVENT_SOLVER_REPAIRED, myConflictingConstraints);
 230             }
 231           }
 232           myConflictingConstraints = aConflicting;
 233           if (!myConflictingConstraints.empty())
 234             sendMessage(EVENT_SOLVER_FAILED, myConflictingConstraints);
 235           myPrevResult = aResult;
 236         }
 237       }
 238     }
 239
 240   } else if (isGroupEmpty && isWorkplaneValid())
 241     computeDoF();
 242   removeTemporaryConstraints();
 243   myStorage->setNeedToResolve(false);
 244   return aResolved;
 245 }
 246
 247 // ============================================================================
 248 //  Function: computeDoF
 249 //  Class:    SketchSolver_Group
 250 //  Purpose:  compute DoF of the sketch and set corresponding field
 251 // ============================================================================
 252 void SketchSolver_Group::computeDoF()
 253 {
 254   std::ostringstream aDoFMsg;
 255   int aDoF = mySketchSolver->dof();
 256   /// "DoF = 0" content of string value is used in PartSet by Sketch edit
 257   /// If it is changed, it should be corrected also there
 258   if (aDoF == 0)
 259     aDoFMsg << "Sketch is fully fixed (DoF = 0)";
 260   else
 261     aDoFMsg << "DoF (degrees of freedom) = " << aDoF;
 262   mySketch->string(SketchPlugin_Sketch::SOLVER_DOF())->setValue(aDoFMsg.str());
 263
 264   if (aDoF > 0 && myDOF == 0)
 265     sendMessage(EVENT_SKETCH_UNDER_CONSTRAINED, mySketch, aDoF);
 266   else if (aDoF == 0 && myDOF > 0)
 267     sendMessage(EVENT_SKETCH_FULLY_CONSTRAINED, mySketch, aDoF);
 268   else if (aDoF < 0)
 269     sendMessage(EVENT_SKETCH_OVER_CONSTRAINED, mySketch, aDoF);
 270
 271   myDOF = aDoF;
 272 }
 273
 274 // ============================================================================
 275 //  Function: repairConsistency
 276 //  Class:    SketchSolver_Group
 277 //  Purpose:  search removed entities and constraints
 278 // ============================================================================
 279 void SketchSolver_Group::repairConsistency()
 280 {
 281   if (!areConstraintsValid() || !myStorage->areFeaturesValid()) {
 282     // remove invalid constraints
 283     std::set<ConstraintPtr> anInvalidConstraints;
 284     ConstraintConstraintMap::iterator aCIter = myConstraints.begin();
 285     for (; aCIter != myConstraints.end(); ++aCIter) {
 286       if (!aCIter->first->data() || !aCIter->first->data()->isValid())
 287         anInvalidConstraints.insert(aCIter->first);
 288     }
 289     std::set<ConstraintPtr>::const_iterator aRemoveIt = anInvalidConstraints.begin();
 290     for (; aRemoveIt != anInvalidConstraints.end(); ++aRemoveIt)
 291       removeConstraint(*aRemoveIt);
 292
 293     // remove invalid features
 294     myStorage->removeInvalidEntities();
 295
 296     // show DoF
 297     computeDoF();
 298   }
 299 }
 300
 301 // ============================================================================
 302 //  Function: removeTemporaryConstraints
 303 //  Class:    SketchSolver_Group
 304 //  Purpose:  remove all transient SLVS_C_WHERE_DRAGGED constraints after
 305 //            resolving the set of constraints
 306 // ============================================================================
 307 void SketchSolver_Group::removeTemporaryConstraints()
 308 {
 309   if (!myTempConstraints.empty()) {
 310     mySketchSolver->removeConstraint(CID_MOVEMENT);
 311
 312     std::set<SolverConstraintPtr>::iterator aTmpIt = myTempConstraints.begin();
 313     for (; aTmpIt != myTempConstraints.end(); ++aTmpIt)
 314       (*aTmpIt)->remove();
 315
 316     myTempConstraints.clear();
 317   }
 318
 319   myStorage->setNeedToResolve(false);
 320 }
 321
 322 // ============================================================================
 323 //  Function: removeConstraint
 324 //  Class:    SketchSolver_Group
 325 //  Purpose:  remove constraint and all unused entities
 326 // ============================================================================
 327 void SketchSolver_Group::removeConstraint(ConstraintPtr theConstraint)
 328 {
 329   ConstraintConstraintMap::iterator aCIter = myConstraints.begin();
 330   for (; aCIter != myConstraints.end(); aCIter++)
 331     if (aCIter->first == theConstraint) {
 332       aCIter->second->remove(); // the constraint is not fully removed
 333
 334       // constraint is removed => reset stack of "multi" constraints updates
 335       myMultiConstraintUpdateStack = 0;
 336       break;
 337     }
 338   if (aCIter != myConstraints.end())
 339     myConstraints.erase(aCIter);
 340 }
 341
 342 // ============================================================================
 343 //  Function: setTemporary
 344 //  Class:    SketchSolver_Group
 345 //  Purpose:  append given constraint to the group of temporary constraints
 346 // ============================================================================
 347 void SketchSolver_Group::setTemporary(SolverConstraintPtr theConstraint)
 348 {
 349   myTempConstraints.insert(theConstraint);
 350 }
 351
 352 // ============================================================================
 353 //  Function: blockEvents
 354 //  Class:    SketchSolver_Group
 355 //  Purpose:  block or unblock events from features in this group
 356 // ============================================================================
 357 void SketchSolver_Group::blockEvents(bool isBlocked)
 358 {
 359   if (myIsEventsBlocked == isBlocked)
 360     return;
 361
 362   // block/unblock events from the features in the storage
 363   myStorage->blockEvents(isBlocked);
 364
 365   // block/unblock events from constraints
 366   ConstraintConstraintMap::iterator aCIt = myConstraints.begin();
 367   for (; aCIt != myConstraints.end(); ++aCIt)
 368     aCIt->second->blockEvents(isBlocked);
 369
 370   myIsEventsBlocked = isBlocked;
 371 }
 372
 373 bool SketchSolver_Group::areConstraintsValid() const
 374 {
 375   // Check the constraints are valid
 376   ConstraintConstraintMap::const_iterator aCIter = myConstraints.begin();
 377   for (; aCIter != myConstraints.end(); ++aCIter)
 378     if (!aCIter->first->data() || !aCIter->first->data()->isValid())
 379       return false;
 380   return true;
 381 }