src/SketchSolver/PlaneGCSSolver/PlaneGCSSolver_Storage.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:    PlaneGCSSolver_Storage.cpp
   4 // Created: 14 Dec 2015
   5 // Author:  Artem ZHIDKOV
   6
   7 #include <PlaneGCSSolver_Storage.h>
   8 #include <PlaneGCSSolver_Solver.h>
   9 #include <PlaneGCSSolver_ConstraintWrapper.h>
  10 #include <PlaneGCSSolver_EntityWrapper.h>
  11 #include <PlaneGCSSolver_PointWrapper.h>
  12
  13 #include <PlaneGCSSolver_AttributeBuilder.h>
  14 #include <PlaneGCSSolver_FeatureBuilder.h>
  15 #include <PlaneGCSSolver_EntityDestroyer.h>
  16
  17 #include <GeomAPI_Dir2d.h>
  18 #include <GeomAPI_Pnt2d.h>
  19 #include <GeomAPI_XY.h>
  20 #include <GeomDataAPI_Point2D.h>
  21 #include <ModelAPI_AttributeRefAttr.h>
  22 #include <SketchPlugin_Projection.h>
  23
  24 #include <cmath>
  25
  26
  27 static void constraintsToSolver(const ConstraintWrapperPtr& theConstraint,
  28                                 const SolverPtr& theSolver)
  29 {
  30   std::shared_ptr<PlaneGCSSolver_Solver> aSolver =
  31       std::dynamic_pointer_cast<PlaneGCSSolver_Solver>(theSolver);
  32   if (!aSolver)
  33     return;
  34
  35   const std::list<GCSConstraintPtr>& aConstraints =
  36       std::dynamic_pointer_cast<PlaneGCSSolver_ConstraintWrapper>(theConstraint)->constraints();
  37   std::list<GCSConstraintPtr>::const_iterator anIt = aConstraints.begin();
  38   for (; anIt != aConstraints.end(); ++anIt)
  39     aSolver->addConstraint(*anIt);
  40 }
  41
  42
  43 PlaneGCSSolver_Storage::PlaneGCSSolver_Storage(const SolverPtr& theSolver)
  44   : SketchSolver_Storage(theSolver),
  45     myConstraintLastID(CID_UNKNOWN)
  46 {
  47 }
  48
  49 void PlaneGCSSolver_Storage::addConstraint(
  50     ConstraintPtr        theConstraint,
  51     ConstraintWrapperPtr theSolverConstraint)
  52 {
  53   SketchSolver_Storage::addConstraint(theConstraint, theSolverConstraint);
  54
  55   theSolverConstraint->setId(++myConstraintLastID);
  56   constraintsToSolver(theSolverConstraint, mySketchSolver);
  57 }
  58
  59 void PlaneGCSSolver_Storage::addTemporaryConstraint(
  60     const ConstraintWrapperPtr& theSolverConstraint)
  61 {
  62   if (myConstraintMap.empty())
  63     return; // no need to process temporary constraints if there is no active constraint
  64
  65   theSolverConstraint->setId(CID_MOVEMENT);
  66   constraintsToSolver(theSolverConstraint, mySketchSolver);
  67 }
  68
  69
  70 EntityWrapperPtr PlaneGCSSolver_Storage::createFeature(
  71     const FeaturePtr&             theFeature,
  72     PlaneGCSSolver_EntityBuilder* theBuilder)
  73 {
  74   std::list<AttributePtr> anAttributes = theFeature->data()->attributes(std::string());
  75   std::list<AttributePtr>::const_iterator anIt = anAttributes.begin();
  76   for (; anIt != anAttributes.end(); ++anIt)
  77     createAttribute(*anIt, theBuilder);
  78
  79   EntityWrapperPtr aResult = theBuilder->createFeature(theFeature);
  80   if (aResult)
  81     addEntity(theFeature, aResult);
  82   return aResult;
  83 }
  84
  85 EntityWrapperPtr PlaneGCSSolver_Storage::createAttribute(
  86     const AttributePtr&           theAttribute,
  87     PlaneGCSSolver_EntityBuilder* theBuilder)
  88 {
  89   EntityWrapperPtr aResult = theBuilder->createAttribute(theAttribute);
  90   if (aResult)
  91     addEntity(theAttribute, aResult);
  92   return aResult;
  93 }
  94
  95 /// \brief Update value
  96 static bool updateValue(const double& theSource, double& theDest)
  97 {
  98   static const double aTol = 1000. * tolerance;
  99   bool isUpdated = fabs(theSource - theDest) > aTol;
 100   if (isUpdated)
 101     theDest = theSource;
 102   return isUpdated;
 103 }
 104
 105 /// \brief Update coordinates of the point or scalar using its base attribute
 106 static bool updateValues(AttributePtr& theAttribute, EntityWrapperPtr& theEntity)
 107 {
 108   bool isUpdated = false;
 109
 110   std::shared_ptr<GeomDataAPI_Point2D> aPoint2D =
 111       std::dynamic_pointer_cast<GeomDataAPI_Point2D>(theAttribute);
 112   if (aPoint2D) {
 113     const GCSPointPtr& aGCSPoint =
 114         std::dynamic_pointer_cast<PlaneGCSSolver_PointWrapper>(theEntity)->point();
 115     isUpdated = updateValue(aPoint2D->x(), *(aGCSPoint->x)) || isUpdated;
 116     isUpdated = updateValue(aPoint2D->y(), *(aGCSPoint->y)) || isUpdated;
 117   } else {
 118     AttributeDoublePtr aScalar =
 119         std::dynamic_pointer_cast<ModelAPI_AttributeDouble>(theAttribute);
 120     if (aScalar) {
 121       ScalarWrapperPtr aWrapper =
 122           std::dynamic_pointer_cast<PlaneGCSSolver_ScalarWrapper>(theEntity);
 123       // There is possible angular value, which is converted between degrees and radians.
 124       // So, we use its value instead of using direct pointer to value.
 125       double aValue = aWrapper->value();
 126       isUpdated = updateValue(aScalar->value(), aValue);
 127       if (isUpdated)
 128         aWrapper->setValue(aValue);
 129     }
 130   }
 131
 132   return isUpdated;
 133 }
 134
 135 static bool isCopyInMulti(std::shared_ptr<SketchPlugin_Feature> theFeature)
 136 {
 137   if (!theFeature)
 138     return false;
 139
 140   bool aResult = theFeature->isCopy();
 141   if (aResult) {
 142     const std::set<AttributePtr>& aRefs = theFeature->data()->refsToMe();
 143     for (std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin();
 144          aRefIt != aRefs.end() && aResult; ++aRefIt) {
 145       FeaturePtr anOwner = ModelAPI_Feature::feature((*aRefIt)->owner());
 146       if (anOwner->getKind() == SketchPlugin_Projection::ID())
 147         aResult = false;
 148     }
 149   }
 150   return aResult;
 151 }
 152
 153 bool PlaneGCSSolver_Storage::update(FeaturePtr theFeature, bool theForce)
 154 {
 155   bool isUpdated = false;
 156   EntityWrapperPtr aRelated = entity(theFeature);
 157   if (aRelated) // send signal to subscribers
 158     notify(theFeature);
 159   else { // Feature is not exist, create it
 160     std::shared_ptr<SketchPlugin_Feature> aSketchFeature =
 161         std::dynamic_pointer_cast<SketchPlugin_Feature>(theFeature);
 162     bool isCopy = isCopyInMulti(aSketchFeature);
 163     // the feature is a copy in "Multi" constraint and does not used in other constraints
 164     if (!theForce && isCopy && myFeatureMap.find(theFeature) == myFeatureMap.end())
 165       return false;
 166
 167     // external feature processing
 168     bool isExternal = (aSketchFeature && (aSketchFeature->isExternal() || isCopy));
 169
 170     PlaneGCSSolver_FeatureBuilder aBuilder(isExternal ? 0 : this);
 171
 172     // Reserve the feature in the map of features
 173     // (do not want to add several copies of it while adding attributes)
 174     aRelated = createFeature(theFeature, &aBuilder);
 175     myFeatureMap[theFeature] = aRelated;
 176
 177     const std::list<GCSConstraintPtr>& aConstraints = aBuilder.constraints();
 178     if (!aConstraints.empty()) { // the feature is arc
 179       /// TODO: avoid this workaround
 180       ConstraintWrapperPtr aWrapper(
 181           new PlaneGCSSolver_ConstraintWrapper(aConstraints, CONSTRAINT_UNKNOWN));
 182       aWrapper->setId(++myConstraintLastID);
 183       constraintsToSolver(aWrapper, mySketchSolver);
 184
 185       myArcConstraintMap[myFeatureMap[theFeature]] = aWrapper;
 186     }
 187     isUpdated = true;
 188   }
 189
 190   std::list<AttributePtr> anAttributes = theFeature->data()->attributes(std::string());
 191   std::list<AttributePtr>::iterator anAttrIt = anAttributes.begin();
 192   for (; anAttrIt != anAttributes.end(); ++anAttrIt)
 193     if ((*anAttrIt)->attributeType() == GeomDataAPI_Point2D::typeId() ||
 194         (*anAttrIt)->attributeType() == ModelAPI_AttributeDouble::typeId())
 195       isUpdated = update(*anAttrIt) || isUpdated;
 196
 197   // update arc
 198   if (aRelated && aRelated->type() == ENTITY_ARC) {
 199     /// TODO: this code should be shared with FeatureBuilder somehow
 200
 201     std::shared_ptr<PlaneGCSSolver_EntityWrapper> anEntity =
 202         std::dynamic_pointer_cast<PlaneGCSSolver_EntityWrapper>(aRelated);
 203     std::shared_ptr<GCS::Arc> anArc = std::dynamic_pointer_cast<GCS::Arc>(anEntity->entity());
 204
 205     static std::shared_ptr<GeomAPI_Dir2d> OX(new GeomAPI_Dir2d(1.0, 0.0));
 206     std::shared_ptr<GeomAPI_Pnt2d> aCenter(
 207         new GeomAPI_Pnt2d(*anArc->center.x, *anArc->center.y));
 208     std::shared_ptr<GeomAPI_Pnt2d> aStart(
 209         new GeomAPI_Pnt2d(*anArc->start.x, *anArc->start.y));
 210
 211     *anArc->rad = aStart->distance(aCenter);
 212
 213     std::shared_ptr<GeomAPI_Dir2d> aDir(new GeomAPI_Dir2d(aStart->xy()->decreased(aCenter->xy())));
 214     *anArc->startAngle = OX->angle(aDir);
 215
 216     aDir = std::shared_ptr<GeomAPI_Dir2d>(
 217         new GeomAPI_Dir2d((*anArc->end.x) - aCenter->x(), (*anArc->end.y) - aCenter->y()));
 218     *anArc->endAngle = OX->angle(aDir);
 219   }
 220
 221   return isUpdated;
 222 }
 223
 224 bool PlaneGCSSolver_Storage::update(AttributePtr theAttribute, bool theForce)
 225 {
 226   if (!theAttribute->isInitialized())
 227     return false;
 228
 229   AttributePtr anAttribute = theAttribute;
 230   AttributeRefAttrPtr aRefAttr = std::dynamic_pointer_cast<ModelAPI_AttributeRefAttr>(anAttribute);
 231   if (aRefAttr) {
 232     if (aRefAttr->isObject()) {
 233       FeaturePtr aFeature;
 234       /// TODO: Check resultToFeatureOrAttribute() precisely.
 235       resultToFeatureOrAttribute(aRefAttr->object(), aFeature, anAttribute);
 236       if (aFeature)
 237         return update(aFeature, theForce);
 238     } else
 239       anAttribute = aRefAttr->attr();
 240   }
 241
 242   EntityWrapperPtr aRelated = entity(anAttribute);
 243   if (!aRelated) { // Attribute does not exist, create it.
 244     // First of all check if the parent feature exists. If not, add it.
 245     FeaturePtr aFeature = ModelAPI_Feature::feature(anAttribute->owner());
 246     if (aFeature && myFeatureMap.find(aFeature) == myFeatureMap.end())
 247       return update(aFeature, theForce); // theAttribute has been processed while adding feature
 248
 249 ////    PlaneGCSSolver_AttributeBuilder aBuilder(this);
 250 ////    aRelated = createAttribute(anAttribute, &aBuilder);
 251     return aRelated.get() != 0;
 252   }
 253
 254   bool isUpdated = updateValues(anAttribute, aRelated);
 255   if (isUpdated)
 256     setNeedToResolve(true);
 257   return isUpdated;
 258 }
 259
 260
 261
 262 bool PlaneGCSSolver_Storage::removeConstraint(ConstraintPtr theConstraint)
 263 {
 264   std::map<ConstraintPtr, ConstraintWrapperPtr>::iterator
 265       aFound = myConstraintMap.find(theConstraint);
 266   if (aFound != myConstraintMap.end()) {
 267     ConstraintID anID = aFound->second->id();
 268     // Remove solver's constraints
 269     mySketchSolver->removeConstraint(anID);
 270     // Remove constraint
 271     myConstraintMap.erase(aFound);
 272
 273     // notify subscibers
 274     notify(theConstraint);
 275   }
 276   return true;
 277 }
 278
 279 void PlaneGCSSolver_Storage::removeInvalidEntities()
 280 {
 281   PlaneGCSSolver_EntityDestroyer aDestroyer;
 282
 283   // Remove invalid constraints
 284   std::list<ConstraintPtr> anInvalidConstraints;
 285   std::map<ConstraintPtr, ConstraintWrapperPtr>::const_iterator
 286       aCIter = myConstraintMap.begin();
 287   for (; aCIter != myConstraintMap.end(); ++aCIter)
 288     if (!aCIter->first->data() || !aCIter->first->data()->isValid())
 289       anInvalidConstraints.push_back(aCIter->first);
 290   std::list<ConstraintPtr>::const_iterator anInvCIt = anInvalidConstraints.begin();
 291   for (; anInvCIt != anInvalidConstraints.end(); ++anInvCIt)
 292     removeConstraint(*anInvCIt);
 293
 294   // Remove invalid features
 295   std::list<FeaturePtr> anInvalidFeatures;
 296   std::map<FeaturePtr, EntityWrapperPtr>::const_iterator aFIter = myFeatureMap.begin();
 297   for (; aFIter != myFeatureMap.end(); aFIter++)
 298     if (!aFIter->first->data() || !aFIter->first->data()->isValid()) {
 299       anInvalidFeatures.push_back(aFIter->first);
 300       aDestroyer.remove(aFIter->second);
 301
 302       // remove invalid arc
 303       std::map<EntityWrapperPtr, ConstraintWrapperPtr>::iterator
 304           aFound = myArcConstraintMap.find(aFIter->second);
 305       if (aFound != myArcConstraintMap.end()) {
 306         mySketchSolver->removeConstraint(aFound->second->id());
 307         myArcConstraintMap.erase(aFound);
 308       }
 309     }
 310   std::list<FeaturePtr>::const_iterator anInvFIt = anInvalidFeatures.begin();
 311   for (; anInvFIt != anInvalidFeatures.end(); ++anInvFIt)
 312     removeFeature(*anInvFIt);
 313
 314   // Remove invalid attributes
 315   std::list<AttributePtr> anInvalidAttributes;
 316   std::map<AttributePtr, EntityWrapperPtr>::const_iterator anAttrIt = myAttributeMap.begin();
 317   for (; anAttrIt != myAttributeMap.end(); ++anAttrIt) {
 318     FeaturePtr anOwner = ModelAPI_Feature::feature(anAttrIt->first->owner());
 319     if (!anOwner || !anOwner->data() || !anOwner->data()->isValid()) {
 320       anInvalidAttributes.push_back(anAttrIt->first);
 321       aDestroyer.remove(anAttrIt->second);
 322     }
 323   }
 324   std::list<AttributePtr>::const_iterator anInvAtIt = anInvalidAttributes.begin();
 325   for (; anInvAtIt != anInvalidAttributes.end(); ++anInvAtIt)
 326     removeAttribute(*anInvAtIt);
 327
 328   // free memory occupied by parameters
 329   removeParameters(aDestroyer.parametersToRemove());
 330
 331   /// TODO: Think on optimization of checking invalid features and attributes
 332 }
 333
 334
 335
 336 double* PlaneGCSSolver_Storage::createParameter()
 337 {
 338   return mySketchSolver->createParameter();
 339 }
 340
 341 void PlaneGCSSolver_Storage::removeParameters(const GCS::SET_pD& theParams)
 342 {
 343   mySketchSolver->removeParameters(theParams);
 344 }
 345
 346 // indicates attribute containing in the external feature
 347 bool isExternalAttribute(const AttributePtr& theAttribute)
 348 {
 349   if (!theAttribute)
 350     return false;
 351   std::shared_ptr<SketchPlugin_Feature> aSketchFeature =
 352       std::dynamic_pointer_cast<SketchPlugin_Feature>(theAttribute->owner());
 353   return aSketchFeature.get() && aSketchFeature->isExternal();
 354 }
 355
 356 void PlaneGCSSolver_Storage::refresh() const
 357 {
 358   const double aTol = 1000. * tolerance; // tolerance to prevent frequent updates
 359
 360   std::map<AttributePtr, EntityWrapperPtr>::const_iterator anIt = myAttributeMap.begin();
 361   for (; anIt != myAttributeMap.end(); ++anIt) {
 362     // the external feature always should keep the up to date values, so,
 363     // refresh from the solver is never needed
 364     if (isExternalAttribute(anIt->first))
 365       continue;
 366
 367     std::shared_ptr<GeomDataAPI_Point2D> aPoint2D =
 368         std::dynamic_pointer_cast<GeomDataAPI_Point2D>(anIt->first);
 369     if (aPoint2D) {
 370       std::shared_ptr<PlaneGCSSolver_PointWrapper> aPointWrapper =
 371           std::dynamic_pointer_cast<PlaneGCSSolver_PointWrapper>(anIt->second);
 372       GCSPointPtr aGCSPoint = aPointWrapper->point();
 373       if (fabs(aPoint2D->x() - (*aGCSPoint->x)) > aTol ||
 374           fabs(aPoint2D->y() - (*aGCSPoint->y)) > aTol)
 375         aPoint2D->setValue(*aGCSPoint->x, *aGCSPoint->y);
 376       continue;
 377     }
 378     AttributeDoublePtr aScalar = std::dynamic_pointer_cast<ModelAPI_AttributeDouble>(anIt->first);
 379     if (aScalar) {
 380       ScalarWrapperPtr aScalarWrapper =
 381           std::dynamic_pointer_cast<PlaneGCSSolver_ScalarWrapper>(anIt->second);
 382       if (fabs(aScalar->value() - aScalarWrapper->value()) > aTol)
 383         aScalar->setValue(aScalarWrapper->value());
 384       continue;
 385     }
 386   }
 387 }