src/SketchPlugin/SketchPlugin_MacroCircle.cpp

   1 // Copyright (C) 2014-2023  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #include "SketchPlugin_MacroCircle.h"
  21
  22 #include "SketchPlugin_Circle.h"
  23 #include "SketchPlugin_Point.h"
  24 #include "SketchPlugin_Tools.h"
  25 #include "SketchPlugin_MacroArcReentrantMessage.h"
  26
  27 #include <ModelAPI_AttributeDouble.h>
  28 #include <ModelAPI_AttributeRefAttr.h>
  29 #include <ModelAPI_AttributeString.h>
  30 #include <ModelAPI_Session.h>
  31 #include <ModelAPI_Validator.h>
  32 #include <ModelAPI_Events.h>
  33
  34 #include <GeomDataAPI_Dir.h>
  35 #include <GeomDataAPI_Point2D.h>
  36
  37 #include <GeomAPI_Circ2d.h>
  38 #include <GeomAPI_Pnt2d.h>
  39 #include <GeomAPI_Vertex.h>
  40
  41 #include <GeomAlgoAPI_Circ2dBuilder.h>
  42 #include <GeomAlgoAPI_CompoundBuilder.h>
  43 #include <GeomAlgoAPI_EdgeBuilder.h>
  44 #include <GeomAlgoAPI_PointBuilder.h>
  45
  46
  47 const double tolerance = 1e-7;
  48
  49 namespace {
  50   static const std::string& POINT_ID(int theIndex)
  51   {
  52     switch (theIndex) {
  53       case 1: return SketchPlugin_MacroCircle::FIRST_POINT_ID();
  54       case 2: return SketchPlugin_MacroCircle::SECOND_POINT_ID();
  55       case 3: return SketchPlugin_MacroCircle::THIRD_POINT_ID();
  56     }
  57
  58     static const std::string DUMMY;
  59     return DUMMY;
  60   }
  61 }
  62
  63
  64 SketchPlugin_MacroCircle::SketchPlugin_MacroCircle()
  65 : SketchPlugin_SketchEntity(),
  66   myRadius(0.0)
  67 {
  68 }
  69
  70 void SketchPlugin_MacroCircle::initAttributes()
  71 {
  72   data()->addAttribute(CIRCLE_TYPE(), ModelAPI_AttributeString::typeId());
  73   data()->addAttribute(EDIT_CIRCLE_TYPE(), ModelAPI_AttributeString::typeId());
  74
  75   data()->addAttribute(CENTER_POINT_ID(), GeomDataAPI_Point2D::typeId());
  76   data()->addAttribute(CENTER_POINT_REF_ID(), ModelAPI_AttributeRefAttr::typeId());
  77   data()->addAttribute(PASSED_POINT_ID(), GeomDataAPI_Point2D::typeId());
  78   data()->addAttribute(PASSED_POINT_REF_ID(), ModelAPI_AttributeRefAttr::typeId());
  79
  80   data()->addAttribute(FIRST_POINT_ID(), GeomDataAPI_Point2D::typeId());
  81   data()->addAttribute(SECOND_POINT_ID(), GeomDataAPI_Point2D::typeId());
  82   data()->addAttribute(THIRD_POINT_ID(), GeomDataAPI_Point2D::typeId());
  83   data()->addAttribute(FIRST_POINT_REF_ID(), ModelAPI_AttributeRefAttr::typeId());
  84   data()->addAttribute(SECOND_POINT_REF_ID(), ModelAPI_AttributeRefAttr::typeId());
  85   data()->addAttribute(THIRD_POINT_REF_ID(), ModelAPI_AttributeRefAttr::typeId());
  86
  87   data()->addAttribute(CIRCLE_RADIUS_ID(), ModelAPI_AttributeDouble::typeId());
  88   data()->addAttribute(AUXILIARY_ID(), ModelAPI_AttributeBoolean::typeId());
  89
  90   string(EDIT_CIRCLE_TYPE())->setValue("");
  91
  92   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), CENTER_POINT_REF_ID());
  93   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), PASSED_POINT_REF_ID());
  94   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), FIRST_POINT_REF_ID());
  95   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), SECOND_POINT_REF_ID());
  96   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), THIRD_POINT_REF_ID());
  97   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), EDIT_CIRCLE_TYPE());
  98 }
  99
 100 void SketchPlugin_MacroCircle::execute()
 101 {
 102   FeaturePtr aCircle = createCircleFeature();
 103
 104   std::string aType = string(CIRCLE_TYPE())->value();
 105   if (aType == CIRCLE_TYPE_BY_CENTER_AND_PASSED_POINTS())
 106     constraintsForCircleByCenterAndPassed(aCircle);
 107   else if (aType == CIRCLE_TYPE_BY_THREE_POINTS())
 108     constraintsForCircleByThreePoints(aCircle);
 109
 110   // message to init reentrant operation
 111   static Events_ID anId = SketchPlugin_MacroArcReentrantMessage::eventId();
 112   std::shared_ptr<SketchPlugin_MacroArcReentrantMessage> aMessage = std::shared_ptr
 113     <SketchPlugin_MacroArcReentrantMessage>(new SketchPlugin_MacroArcReentrantMessage(anId, this));
 114
 115   std::string anEditType = string(EDIT_CIRCLE_TYPE())->value();
 116   aMessage->setTypeOfCreation(!anEditType.empty() ? anEditType : aType);
 117   aMessage->setCreatedFeature(aCircle);
 118   Events_Loop::loop()->send(aMessage);
 119 }
 120
 121 // LCOV_EXCL_START
 122 std::string SketchPlugin_MacroCircle::processEvent(
 123                                               const std::shared_ptr<Events_Message>& theMessage)
 124 {
 125   std::string aFilledAttributeName;
 126   std::shared_ptr<SketchPlugin_MacroArcReentrantMessage> aReentrantMessage =
 127         std::dynamic_pointer_cast<SketchPlugin_MacroArcReentrantMessage>(theMessage);
 128   if (aReentrantMessage.get()) {
 129     std::string aCircleType = aReentrantMessage->typeOfCreation();
 130
 131     string(CIRCLE_TYPE())->setValue(aCircleType);
 132
 133     aFilledAttributeName = CIRCLE_TYPE();
 134     ObjectPtr anObject = aReentrantMessage->selectedObject();
 135     AttributePtr anAttribute = aReentrantMessage->selectedAttribute();
 136     std::shared_ptr<GeomAPI_Pnt2d> aClickedPoint = aReentrantMessage->clickedPoint();
 137
 138     if (aClickedPoint.get() && (anObject.get() || anAttribute.get())) {
 139       std::string aReferenceAttributeName;
 140       if (aCircleType == CIRCLE_TYPE_BY_CENTER_AND_PASSED_POINTS()) {
 141         aFilledAttributeName = CENTER_POINT_ID();
 142         aReferenceAttributeName = CENTER_POINT_REF_ID();
 143       }
 144       else {
 145         aFilledAttributeName = FIRST_POINT_ID();
 146         aReferenceAttributeName = FIRST_POINT_REF_ID();
 147       }
 148       // fill 2d point attribute
 149       AttributePoint2DPtr aPointAttr = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
 150                                                         attribute(aFilledAttributeName));
 151       aPointAttr->setValue(aClickedPoint);
 152       // fill reference attribute
 153       AttributeRefAttrPtr aRefAttr = std::dynamic_pointer_cast<ModelAPI_AttributeRefAttr>(
 154                                                         attribute(aReferenceAttributeName));
 155       if (aRefAttr.get()) {
 156         if (anAttribute.get()) {
 157           if (!anAttribute->owner().get() || !anAttribute->owner()->data()->isValid()) {
 158             FeaturePtr aCreatedFeature = aReentrantMessage->createdFeature();
 159             if (aCreatedFeature.get()) {
 160               std::string anID = anAttribute->id();
 161               std::string anArcID;
 162               if (anID == CENTER_POINT_ID())
 163                 anArcID = SketchPlugin_Circle::CENTER_ID();
 164               anAttribute = aCreatedFeature->attribute(anArcID);
 165             }
 166           }
 167           aRefAttr->setAttr(anAttribute);
 168         }
 169         else if (anObject.get()) {
 170           // if attribute is NULL, only object is defined, it should be processed outside
 171           // the feature because it might be an external feature, that will be
 172           // removed/created again after restart operation
 173           // #2468 - Crash when sketching circles successively on a repetition
 174           aFilledAttributeName = CIRCLE_TYPE();
 175         }
 176       }
 177     }
 178     Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
 179   }
 180   return aFilledAttributeName;
 181 }
 182 // LCOV_EXCL_STOP
 183
 184 void SketchPlugin_MacroCircle::constraintsForCircleByCenterAndPassed(FeaturePtr theCircleFeature)
 185 {
 186   // Create constraints.
 187   SketchPlugin_Tools::createCoincidenceOrTangency(
 188       this, CENTER_POINT_REF_ID(),
 189       theCircleFeature->attribute(SketchPlugin_Circle::CENTER_ID()),
 190       ObjectPtr(), false);
 191   SketchPlugin_Tools::createCoincidenceOrTangency(
 192       this, PASSED_POINT_REF_ID(), AttributePtr(),
 193       theCircleFeature->lastResult(), true);
 194 }
 195
 196 void SketchPlugin_MacroCircle::constraintsForCircleByThreePoints(FeaturePtr theCircleFeature)
 197 {
 198   std::string aPointRef[3] = { FIRST_POINT_REF_ID(),
 199                                SECOND_POINT_REF_ID(),
 200                                THIRD_POINT_REF_ID() };
 201
 202   // Create constraints.
 203   ResultPtr aCircleResult = theCircleFeature->lastResult();
 204   for (int i = 0; i < 3; ++i) {
 205     SketchPlugin_Tools::createCoincidenceOrTangency(
 206         this, aPointRef[i], AttributePtr(), aCircleResult, true);
 207   }
 208 }
 209
 210 FeaturePtr SketchPlugin_MacroCircle::createCircleFeature()
 211 {
 212   FeaturePtr aCircleFeature = sketch()->addFeature(SketchPlugin_Circle::ID());
 213   std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
 214       aCircleFeature->attribute(SketchPlugin_Circle::CENTER_ID()))->setValue(myCenter->x(),
 215                                                                              myCenter->y());
 216   aCircleFeature->real(SketchPlugin_Circle::RADIUS_ID())->setValue(myRadius);
 217   aCircleFeature->boolean(SketchPlugin_Circle::AUXILIARY_ID())
 218                 ->setValue(boolean(AUXILIARY_ID())->value());
 219   aCircleFeature->execute();
 220   return aCircleFeature;
 221 }
 222
 223 void SketchPlugin_MacroCircle::fillByCenterAndPassed()
 224 {
 225   AttributePtr aCenterAttr = attribute(CENTER_POINT_ID());
 226   AttributePtr aPassedAttr = attribute(PASSED_POINT_ID());
 227   if (!aCenterAttr->isInitialized() || !aPassedAttr->isInitialized())
 228     return;
 229
 230   // Calculate circle parameters
 231   AttributeRefAttrPtr aCenterRef = refattr(CENTER_POINT_REF_ID());
 232   std::shared_ptr<GeomAPI_Pnt2d> aCenter;
 233   std::shared_ptr<GeomAPI_Shape> aCurve;
 234   SketchPlugin_Tools::convertRefAttrToPointOrTangentCurve(
 235       aCenterRef, aCenterAttr, aCurve, aCenter);
 236   if (!aCenter)
 237     aCenter = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(aCenterAttr)->pnt();
 238   AttributeRefAttrPtr aPassedRef = refattr(PASSED_POINT_REF_ID());
 239   std::shared_ptr<GeomAPI_Pnt2d> aPassedPoint;
 240   std::shared_ptr<GeomAPI_Shape> aTangentCurve;
 241   SketchPlugin_Tools::convertRefAttrToPointOrTangentCurve(
 242       aPassedRef, aPassedAttr, aTangentCurve, aPassedPoint);
 243
 244   // Build a circle
 245   GeomAlgoAPI_Circ2dBuilder aCircBuilder(SketchPlugin_Sketch::plane(sketch()));
 246   aCircBuilder.setCenter(aCenter);
 247   if (aTangentCurve) {
 248     aCircBuilder.addTangentCurve(aTangentCurve);
 249
 250     AttributePoint2DPtr aPassedPntAttr =
 251         std::dynamic_pointer_cast<GeomDataAPI_Point2D>(aPassedAttr);
 252     if (aPassedPntAttr)
 253       aCircBuilder.setClosestPoint(aPassedPntAttr->pnt());
 254   } else
 255     aCircBuilder.addPassingPoint(aPassedPoint);
 256
 257   std::shared_ptr<GeomAPI_Circ2d> aCircle = aCircBuilder.circle();
 258   if (aCircle) {
 259     myCenter = aCircle->center();
 260     myRadius = aCircle->radius();
 261   }
 262 }
 263
 264 void SketchPlugin_MacroCircle::fillByThreePoints()
 265 {
 266   std::string aPointAttr[3] = { FIRST_POINT_ID(),
 267                                 SECOND_POINT_ID(),
 268                                 THIRD_POINT_ID() };
 269   std::string aPointRef[3] = { FIRST_POINT_REF_ID(),
 270                                SECOND_POINT_REF_ID(),
 271                                THIRD_POINT_REF_ID() };
 272
 273   GeomAlgoAPI_Circ2dBuilder aCircBuilder(SketchPlugin_Sketch::plane(sketch()));
 274
 275   for (int aPntIndex = 0; aPntIndex < 3; ++aPntIndex) {
 276     AttributePtr aPassedAttr = attribute(aPointAttr[aPntIndex]);
 277     if (!aPassedAttr->isInitialized())
 278       break;
 279
 280     AttributeRefAttrPtr aPassedRef = refattr(aPointRef[aPntIndex]);
 281     // calculate circle parameters
 282     std::shared_ptr<GeomAPI_Pnt2d> aPassedPoint;
 283     std::shared_ptr<GeomAPI_Shape> aTangentCurve;
 284     SketchPlugin_Tools::convertRefAttrToPointOrTangentCurve(
 285         aPassedRef, aPassedAttr, aTangentCurve, aPassedPoint);
 286
 287     if (aPassedPoint)
 288       aCircBuilder.addPassingPoint(aPassedPoint);
 289     else {
 290       aCircBuilder.addTangentCurve(aTangentCurve);
 291       AttributePoint2DPtr aPassedPointAttr =
 292           std::dynamic_pointer_cast<GeomDataAPI_Point2D>(aPassedAttr);
 293       if (aPassedPointAttr)
 294         aCircBuilder.setClosestPoint(aPassedPointAttr->pnt());
 295     }
 296   }
 297
 298   std::shared_ptr<GeomAPI_Circ2d> aCircle = aCircBuilder.circle();
 299   if (aCircle) {
 300     myCenter = aCircle->center();
 301     myRadius = aCircle->radius();
 302   }
 303 }
 304
 305 void SketchPlugin_MacroCircle::fillByTwoPassedPoints()
 306 {
 307   std::string aPointAttr[2] = { FIRST_POINT_ID(),
 308                                 SECOND_POINT_ID() };
 309   std::string aPointRef[2] = { FIRST_POINT_REF_ID(),
 310                                SECOND_POINT_REF_ID() };
 311
 312   GeomAlgoAPI_Circ2dBuilder aCircBuilder(SketchPlugin_Sketch::plane(sketch()));
 313
 314   std::shared_ptr<GeomAPI_Pnt2d> aPassedPoints[2]; // there is possible only two passed points
 315   bool hasTangentCurve = false;
 316   int aPntIndex = 0;
 317   for (; aPntIndex < 2; ++aPntIndex) {
 318     AttributePtr aPassedAttr = attribute(aPointAttr[aPntIndex]);
 319     if (!aPassedAttr->isInitialized())
 320       break;
 321
 322     AttributeRefAttrPtr aPassedRef = refattr(aPointRef[aPntIndex]);
 323     // calculate circle parameters
 324     std::shared_ptr<GeomAPI_Pnt2d> aPassedPoint;
 325     std::shared_ptr<GeomAPI_Shape> aTangentCurve;
 326     SketchPlugin_Tools::convertRefAttrToPointOrTangentCurve(
 327         aPassedRef, aPassedAttr, aTangentCurve, aPassedPoint);
 328
 329     if (aPassedPoint) {
 330       aCircBuilder.addPassingPoint(aPassedPoint);
 331       aPassedPoints[aPntIndex] = aPassedPoint;
 332     } else {
 333       hasTangentCurve = true;
 334       aCircBuilder.addTangentCurve(aTangentCurve);
 335       // if the circle is tangent to any curve,
 336       // the third point will be initialized by the tangent point
 337       aCircBuilder.addPassingPoint(
 338           std::dynamic_pointer_cast<GeomDataAPI_Point2D>(aPassedAttr)->pnt());
 339     }
 340   }
 341   if (aPntIndex <= 1)
 342     return;
 343
 344   std::shared_ptr<GeomAPI_Circ2d> aCircle;
 345
 346   if (hasTangentCurve)
 347     aCircle = aCircBuilder.circle();
 348   else {
 349     // the circle is defined by two points, calculate its parameters manually
 350     std::shared_ptr<GeomAPI_Pnt2d> aCenter(new GeomAPI_Pnt2d(
 351         (aPassedPoints[0]->x() + aPassedPoints[1]->x()) * 0.5,
 352         (aPassedPoints[0]->y() + aPassedPoints[1]->y()) * 0.5));
 353     aCircle = std::shared_ptr<GeomAPI_Circ2d>(new GeomAPI_Circ2d(aCenter, aPassedPoints[0]));
 354   }
 355
 356   if (aCircle) {
 357     myCenter = aCircle->center();
 358     myRadius = aCircle->radius();
 359   }
 360 }
 361
 362 AISObjectPtr SketchPlugin_MacroCircle::getAISObject(AISObjectPtr thePrevious)
 363 {
 364   SketchPlugin_Sketch* aSketch = sketch();
 365   if(!aSketch || !myCenter || myRadius == 0) {
 366     return AISObjectPtr();
 367   }
 368
 369   // Compute a circle in 3D view.
 370   std::shared_ptr<GeomAPI_Pnt> aCenter(aSketch->to3D(myCenter->x(), myCenter->y()));
 371   std::shared_ptr<GeomDataAPI_Dir> aNDir =
 372       std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 373           aSketch->data()->attribute(SketchPlugin_Sketch::NORM_ID()));
 374   std::shared_ptr<GeomAPI_Dir> aNormal = aNDir->dir();
 375   GeomShapePtr aCircleShape = GeomAlgoAPI_EdgeBuilder::lineCircle(aCenter, aNormal, myRadius);
 376   GeomShapePtr aCenterPointShape = GeomAlgoAPI_PointBuilder::vertex(aCenter);
 377   if(!aCircleShape.get() || !aCenterPointShape.get()) {
 378     return AISObjectPtr();
 379   }
 380
 381   std::list<std::shared_ptr<GeomAPI_Shape> > aShapes;
 382   aShapes.push_back(aCircleShape);
 383   aShapes.push_back(aCenterPointShape);
 384
 385   std::shared_ptr<GeomAPI_Shape> aCompound = GeomAlgoAPI_CompoundBuilder::compound(aShapes);
 386   AISObjectPtr anAIS = thePrevious;
 387   if(!anAIS.get()) {
 388     anAIS.reset(new GeomAPI_AISObject());
 389   }
 390   anAIS->createShape(aCompound);
 391
 392   // Modify attributes
 393   SketchPlugin_Tools::customizeFeaturePrs(anAIS, boolean(AUXILIARY_ID())->value());
 394
 395   return anAIS;
 396 }
 397
 398 void SketchPlugin_MacroCircle::attributeChanged(const std::string& theID) {
 399   // If circle type switched reset all attributes.
 400   if(theID == CIRCLE_TYPE()) {
 401     SketchPlugin_Tools::resetAttribute(this, CENTER_POINT_ID());
 402     SketchPlugin_Tools::resetAttribute(this, CENTER_POINT_REF_ID());
 403     SketchPlugin_Tools::resetAttribute(this, PASSED_POINT_ID());
 404     SketchPlugin_Tools::resetAttribute(this, PASSED_POINT_REF_ID());
 405     SketchPlugin_Tools::resetAttribute(this, FIRST_POINT_ID());
 406     SketchPlugin_Tools::resetAttribute(this, FIRST_POINT_REF_ID());
 407     SketchPlugin_Tools::resetAttribute(this, SECOND_POINT_ID());
 408     SketchPlugin_Tools::resetAttribute(this, SECOND_POINT_REF_ID());
 409     SketchPlugin_Tools::resetAttribute(this, THIRD_POINT_ID());
 410     SketchPlugin_Tools::resetAttribute(this, THIRD_POINT_REF_ID());
 411   } else if(theID == CENTER_POINT_ID() || theID == PASSED_POINT_ID() ||
 412             theID == CENTER_POINT_REF_ID() || theID == PASSED_POINT_REF_ID())
 413     fillByCenterAndPassed();
 414   else if(theID == FIRST_POINT_ID() || theID == FIRST_POINT_REF_ID() ||
 415           theID == SECOND_POINT_ID() || theID == SECOND_POINT_REF_ID() ||
 416           theID == THIRD_POINT_ID() || theID == THIRD_POINT_REF_ID()) {
 417     std::shared_ptr<GeomAPI_Pnt2d> aPoints[3];
 418     int aNbInitialized = 0;
 419     for(int i = 1; i <= 3; ++i) {
 420       std::shared_ptr<GeomDataAPI_Point2D> aCurPnt =
 421           std::dynamic_pointer_cast<GeomDataAPI_Point2D>(attribute(POINT_ID(i)));
 422       if(aCurPnt->isInitialized())
 423         aPoints[aNbInitialized++] = aCurPnt->pnt();
 424     }
 425
 426     if(aNbInitialized == 1)
 427       return;
 428     else if(aNbInitialized == 2)
 429       fillByTwoPassedPoints();
 430     else
 431       fillByThreePoints();
 432   }
 433
 434   AttributeDoublePtr aRadiusAttr = real(CIRCLE_RADIUS_ID());
 435   bool aWasBlocked = data()->blockSendAttributeUpdated(true);
 436   if(myCenter.get()) {
 437     // center attribute is used in processEvent() to set reference to reentrant arc
 438     std::dynamic_pointer_cast<GeomDataAPI_Point2D>(attribute(CENTER_POINT_ID()))
 439         ->setValue(myCenter);
 440   }
 441   aRadiusAttr->setValue(myRadius);
 442   data()->blockSendAttributeUpdated(aWasBlocked, false);
 443 }