Salome HOME
Issue #2024: Redesign of circle and arc of circle
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_MacroArc.cpp
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
2
3 // File:        SketchPlugin_MacroArc.cpp
4 // Created:     26 Apr 2014
5 // Author:      Artem ZHIDKOV
6
7 #include "SketchPlugin_MacroArc.h"
8
9 #include "SketchPlugin_Arc.h"
10 #include "SketchPlugin_ConstraintTangent.h"
11 #include "SketchPlugin_Sketch.h"
12 #include "SketchPlugin_Tools.h"
13
14 #include <ModelAPI_AttributeDouble.h>
15 #include <ModelAPI_AttributeRefAttr.h>
16 #include <ModelAPI_AttributeString.h>
17 #include <ModelAPI_Session.h>
18 #include <ModelAPI_Validator.h>
19
20 #include <GeomAPI_Circ.h>
21 #include <GeomAPI_Circ2d.h>
22 #include <GeomAPI_Curve.h>
23 #include <GeomAPI_Dir2d.h>
24 #include <GeomAPI_Edge.h>
25 #include <GeomAPI_Lin.h>
26 #include <GeomAPI_Lin2d.h>
27 #include <GeomAPI_Pnt2d.h>
28 #include <GeomAPI_Vertex.h>
29 #include <GeomAPI_XY.h>
30
31 #include <GeomDataAPI_Point2D.h>
32 #include <GeomDataAPI_Dir.h>
33 #include <GeomAlgoAPI_PointBuilder.h>
34 #include <GeomAlgoAPI_EdgeBuilder.h>
35 #include <GeomAlgoAPI_CompoundBuilder.h>
36
37 // for sqrt on Linux
38 #include <math.h>
39
40 const double tolerance = 1e-7;
41 const double paramTolerance = 1.e-4;
42 const double PI = 3.141592653589793238463;
43
44 static void projectPointOnCircle(AttributePoint2DPtr& thePoint, const GeomAPI_Circ2d& theCircle)
45 {
46   std::shared_ptr<GeomAPI_Pnt2d> aProjection = theCircle.project(thePoint->pnt());
47   if(aProjection.get())
48     thePoint->setValue(aProjection);
49 }
50
51
52 SketchPlugin_MacroArc::SketchPlugin_MacroArc()
53 : SketchPlugin_SketchEntity(),
54   myParamBefore(0.0)
55 {
56 }
57
58 void SketchPlugin_MacroArc::initAttributes()
59 {
60   data()->addAttribute(ARC_TYPE(), ModelAPI_AttributeString::typeId());
61
62   data()->addAttribute(CENTER_POINT_ID(), GeomDataAPI_Point2D::typeId());
63   data()->addAttribute(START_POINT_1_ID(), GeomDataAPI_Point2D::typeId());
64   data()->addAttribute(END_POINT_1_ID(), GeomDataAPI_Point2D::typeId());
65
66   data()->addAttribute(START_POINT_2_ID(), GeomDataAPI_Point2D::typeId());
67   data()->addAttribute(END_POINT_2_ID(), GeomDataAPI_Point2D::typeId());
68   data()->addAttribute(PASSED_POINT_ID(), GeomDataAPI_Point2D::typeId());
69
70   data()->addAttribute(TANGENT_POINT_ID(), ModelAPI_AttributeRefAttr::typeId());
71   data()->addAttribute(END_POINT_3_ID(), GeomDataAPI_Point2D::typeId());
72
73   data()->addAttribute(REVERSED_ID(), ModelAPI_AttributeBoolean::typeId());
74
75   data()->addAttribute(RADIUS_ID(), ModelAPI_AttributeDouble::typeId());
76   data()->addAttribute(ANGLE_ID(), ModelAPI_AttributeDouble::typeId());
77
78   data()->addAttribute(AUXILIARY_ID(), ModelAPI_AttributeBoolean::typeId());
79
80   data()->addAttribute(CENTER_POINT_REF_ID(), ModelAPI_AttributeRefAttr::typeId());
81   data()->addAttribute(START_POINT_REF_ID(), ModelAPI_AttributeRefAttr::typeId());
82   data()->addAttribute(END_POINT_REF_ID(), ModelAPI_AttributeRefAttr::typeId());
83   data()->addAttribute(PASSED_POINT_REF_ID(), ModelAPI_AttributeRefAttr::typeId());
84
85   boolean(REVERSED_ID())->setValue(false);
86
87   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), CENTER_POINT_REF_ID());
88   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), START_POINT_REF_ID());
89   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), END_POINT_REF_ID());
90   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), PASSED_POINT_REF_ID());
91 }
92
93 void SketchPlugin_MacroArc::attributeChanged(const std::string& theID)
94 {
95   std::string anArcType = string(ARC_TYPE())->value();
96
97   // If arc type switched reset according attributes.
98   if(theID == ARC_TYPE()) {
99     SketchPlugin_Tools::resetAttribute(this, CENTER_POINT_ID());
100     SketchPlugin_Tools::resetAttribute(this, CENTER_POINT_REF_ID());
101     SketchPlugin_Tools::resetAttribute(this, START_POINT_1_ID());
102     SketchPlugin_Tools::resetAttribute(this, START_POINT_REF_ID());
103     SketchPlugin_Tools::resetAttribute(this, END_POINT_1_ID());
104     SketchPlugin_Tools::resetAttribute(this, END_POINT_REF_ID());
105     SketchPlugin_Tools::resetAttribute(this, START_POINT_2_ID());
106     SketchPlugin_Tools::resetAttribute(this, END_POINT_2_ID());
107     SketchPlugin_Tools::resetAttribute(this, PASSED_POINT_ID());
108     SketchPlugin_Tools::resetAttribute(this, PASSED_POINT_REF_ID());
109     SketchPlugin_Tools::resetAttribute(this, TANGENT_POINT_ID());
110     SketchPlugin_Tools::resetAttribute(this, END_POINT_3_ID());
111     SketchPlugin_Tools::resetAttribute(this, REVERSED_ID());
112     SketchPlugin_Tools::resetAttribute(this, RADIUS_ID());
113     SketchPlugin_Tools::resetAttribute(this, ANGLE_ID());
114
115     myCenter.reset();
116     myStart.reset();
117     myEnd.reset();
118     boolean(REVERSED_ID())->setValue(false);
119     myParamBefore = 0.0;
120   } else if(anArcType == ARC_TYPE_BY_CENTER_AND_POINTS())
121     fillByCenterAndTwoPassed();
122   else if(anArcType == ARC_TYPE_BY_THREE_POINTS())
123     fillByThreePassedPoints();
124   else if(anArcType == ARC_TYPE_BY_TANGENT_EDGE())
125     fillByTangentEdge();
126
127   double aRadius = 0;
128   double anAngle = 0;
129   if(myCenter.get() && myStart.get()) {
130     aRadius = myCenter->distance(myStart);
131     if(myEnd.get()) {
132       if(myStart->isEqual(myEnd)) {
133         anAngle = 360;
134       } else {
135         GeomAPI_Circ2d aCircleForArc(myCenter, myStart);
136         double aStartParam, anEndParam;
137         aCircleForArc.parameter(myStart, paramTolerance, aStartParam);
138         aCircleForArc.parameter(myEnd, paramTolerance, anEndParam);
139         anAngle = (anEndParam - aStartParam) / PI * 180.0;
140         if(boolean(REVERSED_ID())->value()) anAngle = 360.0 - anAngle;
141       }
142     }
143   }
144
145   bool aWasBlocked = data()->blockSendAttributeUpdated(true);
146   real(RADIUS_ID())->setValue(aRadius);
147   real(ANGLE_ID())->setValue(anAngle);
148   data()->blockSendAttributeUpdated(aWasBlocked, false);
149 }
150
151 GeomShapePtr SketchPlugin_MacroArc::getArcShape()
152 {
153   if(!myStart.get() || !myEnd.get() || !myCenter.get()) {
154     return GeomShapePtr();
155   }
156
157   SketchPlugin_Sketch* aSketch = sketch();
158   if(!aSketch) {
159     return GeomShapePtr();
160   }
161
162   std::shared_ptr<GeomAPI_Pnt> aCenter(aSketch->to3D(myCenter->x(), myCenter->y()));
163   std::shared_ptr<GeomAPI_Pnt> aStart(aSketch->to3D(myStart->x(), myStart->y()));
164   std::shared_ptr<GeomAPI_Pnt> anEnd(aSketch->to3D(myEnd->x(), myEnd->y()));
165   std::shared_ptr<GeomDataAPI_Dir> aNDir =
166     std::dynamic_pointer_cast<GeomDataAPI_Dir>(aSketch->attribute(SketchPlugin_Sketch::NORM_ID()));
167   std::shared_ptr<GeomAPI_Dir> aNormal(new GeomAPI_Dir(aNDir->x(), aNDir->y(), aNDir->z()));
168
169   GeomShapePtr anArcShape = boolean(REVERSED_ID())->value() ?
170       GeomAlgoAPI_EdgeBuilder::lineCircleArc(aCenter, anEnd, aStart, aNormal)
171     : GeomAlgoAPI_EdgeBuilder::lineCircleArc(aCenter, aStart, anEnd, aNormal);
172
173   return anArcShape;
174 }
175
176 AISObjectPtr SketchPlugin_MacroArc::getAISObject(AISObjectPtr thePrevious)
177 {
178   if(!myStart.get() || !myEnd.get() || !myCenter.get()) {
179     return AISObjectPtr();
180   }
181
182   SketchPlugin_Sketch* aSketch = sketch();
183   if(!aSketch) {
184     return AISObjectPtr();
185   }
186
187   GeomShapePtr anArcShape = getArcShape();
188   std::shared_ptr<GeomAPI_Pnt> aCenter = aSketch->to3D(myCenter->x(), myCenter->y());;
189   GeomShapePtr aCenterPointShape = GeomAlgoAPI_PointBuilder::vertex(aCenter);
190
191   if(!anArcShape.get() || !aCenterPointShape.get()) {
192     return AISObjectPtr();
193   }
194
195   std::list<std::shared_ptr<GeomAPI_Shape> > aShapes;
196   aShapes.push_back(anArcShape);
197   aShapes.push_back(aCenterPointShape);
198
199   std::shared_ptr<GeomAPI_Shape> aCompound = GeomAlgoAPI_CompoundBuilder::compound(aShapes);
200   AISObjectPtr anAIS = thePrevious;
201   if(!anAIS.get()) {
202     anAIS.reset(new GeomAPI_AISObject());
203   }
204   anAIS->createShape(aCompound);
205   return anAIS;
206 }
207
208 void SketchPlugin_MacroArc::execute()
209 {
210   FeaturePtr anArcFeature = createArcFeature();
211
212   myCenter.reset();
213   myStart.reset();
214   myEnd.reset();
215
216   // Create constraints.
217   std::string anArcType = string(ARC_TYPE())->value();
218   if(anArcType == ARC_TYPE_BY_CENTER_AND_POINTS()) {
219     SketchPlugin_Tools::createConstraint(this,
220                                          CENTER_POINT_REF_ID(),
221                                          anArcFeature->attribute(SketchPlugin_Arc::CENTER_ID()),
222                                          ObjectPtr(),
223                                          false);
224     SketchPlugin_Tools::createConstraint(this,
225                                          START_POINT_REF_ID(),
226                                          anArcFeature->attribute(SketchPlugin_Arc::START_ID()),
227                                          ObjectPtr(),
228                                          false);
229     SketchPlugin_Tools::createConstraint(this,
230                                          END_POINT_REF_ID(),
231                                          anArcFeature->attribute(SketchPlugin_Arc::END_ID()),
232                                          ObjectPtr(),
233                                          false);
234   } else if(anArcType == ARC_TYPE_BY_THREE_POINTS()) {
235     SketchPlugin_Tools::createConstraint(this,
236                                          START_POINT_REF_ID(),
237                                          anArcFeature->attribute(SketchPlugin_Arc::START_ID()),
238                                          ObjectPtr(),
239                                          false);
240     SketchPlugin_Tools::createConstraint(this,
241                                          END_POINT_REF_ID(),
242                                          anArcFeature->attribute(SketchPlugin_Arc::END_ID()),
243                                          ObjectPtr(),
244                                          false);
245     SketchPlugin_Tools::createConstraint(this,
246                                          PASSED_POINT_REF_ID(),
247                                          AttributePtr(),
248                                          anArcFeature->lastResult(),
249                                          true);
250   } else if(anArcType == ARC_TYPE_BY_TANGENT_EDGE()) {
251     // constraints for tangent arc
252     SketchPlugin_Tools::createConstraint(this,
253                                          TANGENT_POINT_ID(),
254                                          anArcFeature->attribute(SketchPlugin_Arc::START_ID()),
255                                          ObjectPtr(),
256                                          false);
257     FeaturePtr aTangent = sketch()->addFeature(SketchPlugin_ConstraintTangent::ID());
258     AttributeRefAttrPtr aRefAttrA = aTangent->refattr(SketchPlugin_Constraint::ENTITY_A());
259     AttributeRefAttrPtr aTgPntRefAttr = refattr(TANGENT_POINT_ID());
260     FeaturePtr aTgFeature = ModelAPI_Feature::feature(aTgPntRefAttr->attr()->owner());
261     aRefAttrA->setObject(aTgFeature->lastResult());
262     AttributeRefAttrPtr aRefAttrB = aTangent->refattr(SketchPlugin_Constraint::ENTITY_B());
263     aRefAttrB->setObject(anArcFeature->lastResult());
264     // constraint for end point
265     SketchPlugin_Tools::createConstraint(this,
266                                          END_POINT_REF_ID(),
267                                          anArcFeature->attribute(SketchPlugin_Arc::END_ID()),
268                                          ObjectPtr(),
269                                          false);
270   }
271 }
272
273 FeaturePtr SketchPlugin_MacroArc::createArcFeature()
274 {
275   FeaturePtr anArcFeature = sketch()->addFeature(SketchPlugin_Arc::ID());
276   std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
277       anArcFeature->attribute(SketchPlugin_Arc::CENTER_ID()))->setValue(myCenter);
278   std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
279       anArcFeature->attribute(SketchPlugin_Arc::START_ID()))->setValue(myStart);
280   std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
281       anArcFeature->attribute(SketchPlugin_Arc::END_ID()))->setValue(myEnd);
282   anArcFeature->boolean(SketchPlugin_Arc::REVERSED_ID())
283                 ->setValue(boolean(REVERSED_ID())->value());
284   anArcFeature->boolean(SketchPlugin_Arc::AUXILIARY_ID())
285                 ->setValue(boolean(AUXILIARY_ID())->value());
286   anArcFeature->execute();
287
288   return anArcFeature;
289 }
290
291 void SketchPlugin_MacroArc::fillByCenterAndTwoPassed()
292 {
293   AttributePoint2DPtr aCenterPointAttr =
294       std::dynamic_pointer_cast<GeomDataAPI_Point2D>(attribute(CENTER_POINT_ID()));
295   if (!aCenterPointAttr->isInitialized())
296       return;
297
298   AttributePoint2DPtr aStartPointAttr =
299       std::dynamic_pointer_cast<GeomDataAPI_Point2D>(attribute(START_POINT_1_ID()));
300   if (!aStartPointAttr->isInitialized())
301     return;
302
303   myCenter = aCenterPointAttr->pnt();
304   myStart = aStartPointAttr->pnt();
305   myEnd = myStart;
306
307   AttributePoint2DPtr anEndPointAttr =
308       std::dynamic_pointer_cast<GeomDataAPI_Point2D>(attribute(END_POINT_1_ID()));
309   if (!anEndPointAttr->isInitialized())
310     return;
311
312   GeomAPI_Circ2d aCircleForArc(myCenter, myStart);
313
314   // End point should be a projection on circle.
315   bool aWasBlocked = data()->blockSendAttributeUpdated(true);
316   projectPointOnCircle(anEndPointAttr, aCircleForArc);
317   data()->blockSendAttributeUpdated(aWasBlocked, false);
318   myEnd = anEndPointAttr->pnt();
319
320   // update the REVERSED flag
321   recalculateReversedFlagByEnd(aCircleForArc);
322 }
323
324 void SketchPlugin_MacroArc::recalculateReversedFlagByEnd(const GeomAPI_Circ2d& theCurrentCircular)
325 {
326   double aParameterNew = 0.0;
327   if(theCurrentCircular.parameter(myEnd, paramTolerance, aParameterNew)) {
328     if(myParamBefore <= PI / 2.0 && aParameterNew >= PI * 1.5) {
329       boolean(REVERSED_ID())->setValue(true);
330     } else if(myParamBefore >= PI * 1.5 && aParameterNew <= PI / 2.0) {
331       boolean(REVERSED_ID())->setValue(false);
332     }
333   }
334   myParamBefore = aParameterNew;
335 }
336
337 void SketchPlugin_MacroArc::fillByThreePassedPoints()
338 {
339   AttributePoint2DPtr aStartPointAttr =
340       std::dynamic_pointer_cast<GeomDataAPI_Point2D>(attribute(START_POINT_2_ID()));
341   if (!aStartPointAttr->isInitialized())
342     return;
343
344   AttributePoint2DPtr anEndPointAttr =
345       std::dynamic_pointer_cast<GeomDataAPI_Point2D>(attribute(END_POINT_2_ID()));
346   if (!anEndPointAttr->isInitialized())
347     return;
348
349   myStart = aStartPointAttr->pnt();
350   myEnd = anEndPointAttr->pnt();
351
352   AttributePoint2DPtr aPassedPointAttr =
353       std::dynamic_pointer_cast<GeomDataAPI_Point2D>(attribute(PASSED_POINT_ID()));
354   if (aPassedPointAttr->isInitialized()) {
355     std::shared_ptr<GeomAPI_Pnt2d> aPassedPnt;
356     std::shared_ptr<GeomAPI_Shape> aTangentCurve;
357     SketchPlugin_Tools::convertRefAttrToPointOrTangentCurve(
358         refattr(PASSED_POINT_REF_ID()), aPassedPointAttr, aTangentCurve, aPassedPnt);
359
360     std::shared_ptr<GeomAPI_Interface> aPassed;
361     if (aTangentCurve)
362       aPassed = aTangentCurve;
363     else
364       aPassed = aPassedPnt;
365
366     std::shared_ptr<GeomAPI_Ax3> anAxis = SketchPlugin_Sketch::plane(sketch());
367     GeomAPI_Circ2d aCircle(myStart, myEnd, aPassed, anAxis);
368     myCenter = aCircle.center();
369     aCircle = GeomAPI_Circ2d(myCenter, myStart);
370
371     recalculateReversedFlagByPassed(aCircle);
372   } else
373     myCenter.reset(new GeomAPI_Pnt2d(myStart->xy()->added(myEnd->xy())->multiplied(0.5)));
374 }
375
376 void SketchPlugin_MacroArc::recalculateReversedFlagByPassed(
377     const GeomAPI_Circ2d& theCurrentCircular)
378 {
379   AttributePoint2DPtr aPassedAttr =
380       std::dynamic_pointer_cast<GeomDataAPI_Point2D>(attribute(PASSED_POINT_ID()));
381   std::shared_ptr<GeomAPI_Pnt2d> aPassed = theCurrentCircular.project(aPassedAttr->pnt());
382
383   double aEndParam, aPassedParam;
384   theCurrentCircular.parameter(myEnd, paramTolerance, aEndParam);
385   theCurrentCircular.parameter(aPassed, paramTolerance, aPassedParam);
386
387   if(aPassedParam > aEndParam)
388     boolean(REVERSED_ID())->setValue(true);
389   else
390     boolean(REVERSED_ID())->setValue(false);
391
392   myParamBefore = aEndParam;
393 }
394
395 void SketchPlugin_MacroArc::fillByTangentEdge()
396 {
397   AttributeRefAttrPtr aTangentAttr = refattr(TANGENT_POINT_ID());
398   if (!aTangentAttr->isInitialized())
399     return;
400
401   AttributePoint2DPtr aTangentPointAttr =
402       std::dynamic_pointer_cast<GeomDataAPI_Point2D>(aTangentAttr->attr());
403   if (!aTangentPointAttr->isInitialized())
404     return;
405
406   AttributePoint2DPtr anEndPointAttr =
407       std::dynamic_pointer_cast<GeomDataAPI_Point2D>(attribute(END_POINT_3_ID()));
408   if (!anEndPointAttr->isInitialized())
409     return;
410
411   myStart = aTangentPointAttr->pnt();
412   myEnd = anEndPointAttr->pnt();
413   if (myStart->isEqual(myEnd))
414     return;
415
416   // obtain a shape the tangent point belongs to
417   FeaturePtr aTangentFeature = ModelAPI_Feature::feature(aTangentPointAttr->owner());
418   std::shared_ptr<GeomAPI_Shape> aTangentShape = aTangentFeature->lastResult()->shape();
419
420   std::shared_ptr<GeomAPI_Ax3> anAxis = SketchPlugin_Sketch::plane(sketch());
421   GeomAPI_Circ2d aCircle(myStart, myEnd, aTangentShape, anAxis);
422   myCenter = aCircle.center();
423
424   // rebuild circle to set start point equal to zero parameter
425   aCircle = GeomAPI_Circ2d(myCenter, myStart);
426   recalculateReversedFlagByEnd(aCircle);
427 }