1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: PlaneGCSSolver_Storage.cpp
4 // Created: 14 Dec 2015
5 // Author: Artem ZHIDKOV
7 #include <PlaneGCSSolver_Storage.h>
8 #include <PlaneGCSSolver_Solver.h>
9 #include <PlaneGCSSolver_ConstraintWrapper.h>
10 #include <PlaneGCSSolver_EdgeWrapper.h>
11 #include <PlaneGCSSolver_PointWrapper.h>
13 #include <PlaneGCSSolver_AttributeBuilder.h>
14 #include <PlaneGCSSolver_FeatureBuilder.h>
15 #include <PlaneGCSSolver_EntityDestroyer.h>
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>
27 static void constraintsToSolver(const ConstraintWrapperPtr& theConstraint,
28 const SolverPtr& theSolver)
30 const std::list<GCSConstraintPtr>& aConstraints =
31 std::dynamic_pointer_cast<PlaneGCSSolver_ConstraintWrapper>(theConstraint)->constraints();
32 std::list<GCSConstraintPtr>::const_iterator anIt = aConstraints.begin();
33 for (; anIt != aConstraints.end(); ++anIt)
34 theSolver->addConstraint(*anIt);
38 PlaneGCSSolver_Storage::PlaneGCSSolver_Storage(const SolverPtr& theSolver)
39 : SketchSolver_Storage(theSolver),
40 myConstraintLastID(CID_UNKNOWN)
44 void PlaneGCSSolver_Storage::addConstraint(
45 ConstraintPtr theConstraint,
46 ConstraintWrapperPtr theSolverConstraint)
48 SketchSolver_Storage::addConstraint(theConstraint, theSolverConstraint);
50 theSolverConstraint->setId(++myConstraintLastID);
51 constraintsToSolver(theSolverConstraint, mySketchSolver);
54 void PlaneGCSSolver_Storage::addTemporaryConstraint(
55 const ConstraintWrapperPtr& theSolverConstraint)
57 if (myConstraintMap.empty())
58 return; // no need to process temporary constraints if there is no active constraint
60 // before adding movement constraint to solver, re-check its DOF
61 if (mySketchSolver->dof() == 0)
62 mySketchSolver->diagnose();
64 theSolverConstraint->setId(CID_MOVEMENT);
65 constraintsToSolver(theSolverConstraint, mySketchSolver);
69 EntityWrapperPtr PlaneGCSSolver_Storage::createFeature(
70 const FeaturePtr& theFeature,
71 PlaneGCSSolver_EntityBuilder* theBuilder)
73 std::list<AttributePtr> anAttributes = theFeature->data()->attributes(std::string());
74 std::list<AttributePtr>::const_iterator anIt = anAttributes.begin();
75 for (; anIt != anAttributes.end(); ++anIt)
76 createAttribute(*anIt, theBuilder);
78 EntityWrapperPtr aResult = theBuilder->createFeature(theFeature);
80 addEntity(theFeature, aResult);
84 EntityWrapperPtr PlaneGCSSolver_Storage::createAttribute(
85 const AttributePtr& theAttribute,
86 PlaneGCSSolver_EntityBuilder* theBuilder)
88 EntityWrapperPtr aResult = theBuilder->createAttribute(theAttribute);
90 addEntity(theAttribute, aResult);
94 /// \brief Update value
95 static bool updateValue(const double& theSource, double& theDest)
97 static const double aTol = 1000. * tolerance;
98 bool isUpdated = fabs(theSource - theDest) > aTol;
104 /// \brief Update coordinates of the point or scalar using its base attribute
105 static bool updateValues(AttributePtr& theAttribute, EntityWrapperPtr& theEntity)
107 bool isUpdated = false;
109 std::shared_ptr<GeomDataAPI_Point2D> aPoint2D =
110 std::dynamic_pointer_cast<GeomDataAPI_Point2D>(theAttribute);
112 const GCSPointPtr& aGCSPoint =
113 std::dynamic_pointer_cast<PlaneGCSSolver_PointWrapper>(theEntity)->point();
114 isUpdated = updateValue(aPoint2D->x(), *(aGCSPoint->x)) || isUpdated;
115 isUpdated = updateValue(aPoint2D->y(), *(aGCSPoint->y)) || isUpdated;
117 AttributeDoublePtr aScalar =
118 std::dynamic_pointer_cast<ModelAPI_AttributeDouble>(theAttribute);
120 ScalarWrapperPtr aWrapper =
121 std::dynamic_pointer_cast<PlaneGCSSolver_ScalarWrapper>(theEntity);
122 // There is possible angular value, which is converted between degrees and radians.
123 // So, we use its value instead of using direct pointer to value.
124 double aValue = aWrapper->value();
125 isUpdated = updateValue(aScalar->value(), aValue);
127 aWrapper->setValue(aValue);
134 static bool isCopyInMulti(std::shared_ptr<SketchPlugin_Feature> theFeature)
139 bool aResult = theFeature->isCopy();
141 const std::set<AttributePtr>& aRefs = theFeature->data()->refsToMe();
142 for (std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin();
143 aRefIt != aRefs.end() && aResult; ++aRefIt) {
144 FeaturePtr anOwner = ModelAPI_Feature::feature((*aRefIt)->owner());
145 if (anOwner->getKind() == SketchPlugin_Projection::ID())
152 bool PlaneGCSSolver_Storage::update(FeaturePtr theFeature, bool theForce)
154 bool isUpdated = false;
155 EntityWrapperPtr aRelated = entity(theFeature);
156 if (aRelated) // send signal to subscribers
158 else { // Feature is not exist, create it
159 std::shared_ptr<SketchPlugin_Feature> aSketchFeature =
160 std::dynamic_pointer_cast<SketchPlugin_Feature>(theFeature);
161 bool isCopy = isCopyInMulti(aSketchFeature);
162 // the feature is a copy in "Multi" constraint and does not used in other constraints
163 if (!theForce && isCopy && myFeatureMap.find(theFeature) == myFeatureMap.end())
166 // external feature processing
167 bool isExternal = (aSketchFeature && (aSketchFeature->isExternal() || isCopy));
169 PlaneGCSSolver_FeatureBuilder aBuilder(isExternal ? 0 : this);
171 // Reserve the feature in the map of features
172 // (do not want to add several copies of it while adding attributes)
173 aRelated = createFeature(theFeature, &aBuilder);
174 myFeatureMap[theFeature] = aRelated;
176 const std::list<GCSConstraintPtr>& aConstraints = aBuilder.constraints();
177 if (!aConstraints.empty()) { // the feature is arc
178 /// TODO: avoid this workaround
179 ConstraintWrapperPtr aWrapper(
180 new PlaneGCSSolver_ConstraintWrapper(aConstraints, CONSTRAINT_UNKNOWN));
181 aWrapper->setId(++myConstraintLastID);
182 constraintsToSolver(aWrapper, mySketchSolver);
184 myArcConstraintMap[myFeatureMap[theFeature]] = aWrapper;
189 std::list<AttributePtr> anAttributes = theFeature->data()->attributes(std::string());
190 std::list<AttributePtr>::iterator anAttrIt = anAttributes.begin();
191 for (; anAttrIt != anAttributes.end(); ++anAttrIt)
192 if ((*anAttrIt)->attributeType() == GeomDataAPI_Point2D::typeId() ||
193 (*anAttrIt)->attributeType() == ModelAPI_AttributeDouble::typeId())
194 isUpdated = update(*anAttrIt) || isUpdated;
197 if (aRelated && aRelated->type() == ENTITY_ARC) {
198 /// TODO: this code should be shared with FeatureBuilder somehow
200 std::shared_ptr<PlaneGCSSolver_EdgeWrapper> anEntity =
201 std::dynamic_pointer_cast<PlaneGCSSolver_EdgeWrapper>(aRelated);
202 std::shared_ptr<GCS::Arc> anArc = std::dynamic_pointer_cast<GCS::Arc>(anEntity->entity());
204 static std::shared_ptr<GeomAPI_Dir2d> OX(new GeomAPI_Dir2d(1.0, 0.0));
205 std::shared_ptr<GeomAPI_Pnt2d> aCenter(
206 new GeomAPI_Pnt2d(*anArc->center.x, *anArc->center.y));
207 std::shared_ptr<GeomAPI_Pnt2d> aStart(
208 new GeomAPI_Pnt2d(*anArc->start.x, *anArc->start.y));
210 *anArc->rad = aStart->distance(aCenter);
212 std::shared_ptr<GeomAPI_Dir2d> aDir(new GeomAPI_Dir2d(aStart->xy()->decreased(aCenter->xy())));
213 *anArc->startAngle = OX->angle(aDir);
215 aDir = std::shared_ptr<GeomAPI_Dir2d>(
216 new GeomAPI_Dir2d((*anArc->end.x) - aCenter->x(), (*anArc->end.y) - aCenter->y()));
217 *anArc->endAngle = OX->angle(aDir);
223 bool PlaneGCSSolver_Storage::update(AttributePtr theAttribute, bool theForce)
225 if (!theAttribute->isInitialized())
228 AttributePtr anAttribute = theAttribute;
229 AttributeRefAttrPtr aRefAttr = std::dynamic_pointer_cast<ModelAPI_AttributeRefAttr>(anAttribute);
231 if (aRefAttr->isObject()) {
233 /// TODO: Check resultToFeatureOrAttribute() precisely.
234 resultToFeatureOrAttribute(aRefAttr->object(), aFeature, anAttribute);
236 return update(aFeature, theForce);
238 anAttribute = aRefAttr->attr();
241 EntityWrapperPtr aRelated = entity(anAttribute);
242 if (!aRelated) { // Attribute does not exist, create it.
243 // First of all check if the parent feature exists. If not, add it.
244 FeaturePtr aFeature = ModelAPI_Feature::feature(anAttribute->owner());
245 if (aFeature && myFeatureMap.find(aFeature) == myFeatureMap.end())
246 return update(aFeature, theForce); // theAttribute has been processed while adding feature
248 //// PlaneGCSSolver_AttributeBuilder aBuilder(this);
249 //// aRelated = createAttribute(anAttribute, &aBuilder);
250 return aRelated.get() != 0;
253 bool isUpdated = updateValues(anAttribute, aRelated);
255 setNeedToResolve(true);
261 bool PlaneGCSSolver_Storage::removeConstraint(ConstraintPtr theConstraint)
263 std::map<ConstraintPtr, ConstraintWrapperPtr>::iterator
264 aFound = myConstraintMap.find(theConstraint);
265 if (aFound != myConstraintMap.end()) {
266 ConstraintWrapperPtr aCW = aFound->second;
267 ConstraintID anID = aCW->id();
269 // Remove solver's constraints
270 mySketchSolver->removeConstraint(anID);
272 // Remove value if exists
273 const ScalarWrapperPtr& aValue = aCW->valueParameter();
275 GCS::SET_pD aParToRemove;
276 aParToRemove.insert(aValue->scalar());
277 removeParameters(aParToRemove);
281 myConstraintMap.erase(aFound);
283 if (anID != CID_MOVEMENT)
284 myNeedToResolve = true;
287 notify(theConstraint);
292 void PlaneGCSSolver_Storage::removeInvalidEntities()
294 PlaneGCSSolver_EntityDestroyer aDestroyer;
296 // Remove invalid constraints
297 std::list<ConstraintPtr> anInvalidConstraints;
298 std::map<ConstraintPtr, ConstraintWrapperPtr>::const_iterator
299 aCIter = myConstraintMap.begin();
300 for (; aCIter != myConstraintMap.end(); ++aCIter)
301 if (!aCIter->first->data() || !aCIter->first->data()->isValid())
302 anInvalidConstraints.push_back(aCIter->first);
303 std::list<ConstraintPtr>::const_iterator anInvCIt = anInvalidConstraints.begin();
304 for (; anInvCIt != anInvalidConstraints.end(); ++anInvCIt)
305 removeConstraint(*anInvCIt);
307 // Remove invalid features
308 std::list<FeaturePtr> anInvalidFeatures;
309 std::map<FeaturePtr, EntityWrapperPtr>::const_iterator aFIter = myFeatureMap.begin();
310 for (; aFIter != myFeatureMap.end(); aFIter++)
311 if (!aFIter->first->data() || !aFIter->first->data()->isValid()) {
312 anInvalidFeatures.push_back(aFIter->first);
314 aDestroyer.remove(aFIter->second);
316 // remove invalid arc
317 std::map<EntityWrapperPtr, ConstraintWrapperPtr>::iterator
318 aFound = myArcConstraintMap.find(aFIter->second);
319 if (aFound != myArcConstraintMap.end()) {
320 mySketchSolver->removeConstraint(aFound->second->id());
321 myArcConstraintMap.erase(aFound);
324 std::list<FeaturePtr>::const_iterator anInvFIt = anInvalidFeatures.begin();
325 for (; anInvFIt != anInvalidFeatures.end(); ++anInvFIt)
326 removeFeature(*anInvFIt);
328 // Remove invalid attributes
329 std::list<AttributePtr> anInvalidAttributes;
330 std::map<AttributePtr, EntityWrapperPtr>::const_iterator anAttrIt = myAttributeMap.begin();
331 for (; anAttrIt != myAttributeMap.end(); ++anAttrIt) {
332 FeaturePtr anOwner = ModelAPI_Feature::feature(anAttrIt->first->owner());
333 if (!anOwner || !anOwner->data() || !anOwner->data()->isValid()) {
334 anInvalidAttributes.push_back(anAttrIt->first);
335 aDestroyer.remove(anAttrIt->second);
338 std::list<AttributePtr>::const_iterator anInvAtIt = anInvalidAttributes.begin();
339 for (; anInvAtIt != anInvalidAttributes.end(); ++anInvAtIt)
340 removeAttribute(*anInvAtIt);
342 // free memory occupied by parameters
343 removeParameters(aDestroyer.parametersToRemove());
345 /// TODO: Think on optimization of checking invalid features and attributes
350 double* PlaneGCSSolver_Storage::createParameter()
352 return mySketchSolver->createParameter();
355 void PlaneGCSSolver_Storage::removeParameters(const GCS::SET_pD& theParams)
357 mySketchSolver->removeParameters(theParams);
360 // indicates attribute containing in the external feature
361 bool isExternalAttribute(const AttributePtr& theAttribute)
365 std::shared_ptr<SketchPlugin_Feature> aSketchFeature =
366 std::dynamic_pointer_cast<SketchPlugin_Feature>(theAttribute->owner());
367 return aSketchFeature.get() && aSketchFeature->isExternal();
370 void PlaneGCSSolver_Storage::refresh() const
372 const double aTol = 1000. * tolerance; // tolerance to prevent frequent updates
374 std::map<AttributePtr, EntityWrapperPtr>::const_iterator anIt = myAttributeMap.begin();
375 for (; anIt != myAttributeMap.end(); ++anIt) {
376 // the external feature always should keep the up to date values, so,
377 // refresh from the solver is never needed
378 if (isExternalAttribute(anIt->first))
381 std::shared_ptr<GeomDataAPI_Point2D> aPoint2D =
382 std::dynamic_pointer_cast<GeomDataAPI_Point2D>(anIt->first);
384 std::shared_ptr<PlaneGCSSolver_PointWrapper> aPointWrapper =
385 std::dynamic_pointer_cast<PlaneGCSSolver_PointWrapper>(anIt->second);
386 GCSPointPtr aGCSPoint = aPointWrapper->point();
387 if (fabs(aPoint2D->x() - (*aGCSPoint->x)) > aTol ||
388 fabs(aPoint2D->y() - (*aGCSPoint->y)) > aTol)
389 aPoint2D->setValue(*aGCSPoint->x, *aGCSPoint->y);
392 AttributeDoublePtr aScalar = std::dynamic_pointer_cast<ModelAPI_AttributeDouble>(anIt->first);
394 ScalarWrapperPtr aScalarWrapper =
395 std::dynamic_pointer_cast<PlaneGCSSolver_ScalarWrapper>(anIt->second);
396 if (fabs(aScalar->value() - aScalarWrapper->value()) > aTol)
397 aScalar->setValue(aScalarWrapper->value());