src/SketchPlugin/SketchPlugin_Sketch.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        SketchPlugin_Sketch.cxx
   4 // Created:     27 Mar 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #include <Config_PropManager.h>
   8
   9 #include <GeomAlgoAPI_CompoundBuilder.h>
  10 #include <GeomAlgoAPI_FaceBuilder.h>
  11
  12 #include <GeomAPI_AISObject.h>
  13 #include <GeomAPI_Dir.h>
  14 #include <GeomAPI_PlanarEdges.h>
  15
  16 #include <GeomAlgoAPI_FaceBuilder.h>
  17
  18 #include <GeomDataAPI_Point2D.h>
  19 #include <GeomAlgoAPI_PointBuilder.h>
  20
  21 #include <ModelAPI_AttributeRefList.h>
  22 #include <ModelAPI_Data.h>
  23 #include <ModelAPI_Document.h>
  24 #include <ModelAPI_Feature.h>
  25 #include <ModelAPI_Object.h>
  26 #include <ModelAPI_ResultConstruction.h>
  27 #include <ModelAPI_Validator.h>
  28 #include <ModelAPI_Session.h>
  29 #include <ModelAPI_Events.h>
  30
  31 #include <SketchPlugin_Sketch.h>
  32 #include <SketchPlugin_Feature.h>
  33 #include <SketchPlugin_SketchEntity.h>
  34 #include <SketchPlugin_Tools.h>
  35
  36 #include <Events_Loop.h>
  37
  38 #include <memory>
  39
  40 #include <math.h>
  41 #include <vector>
  42
  43 using namespace std;
  44
  45 SketchPlugin_Sketch::SketchPlugin_Sketch()
  46 {
  47 }
  48
  49 void SketchPlugin_Sketch::initAttributes()
  50 {
  51   data()->addAttribute(SketchPlugin_Sketch::ORIGIN_ID(), GeomDataAPI_Point::typeId());
  52   data()->addAttribute(SketchPlugin_Sketch::DIRX_ID(), GeomDataAPI_Dir::typeId());
  53   data()->addAttribute(SketchPlugin_Sketch::NORM_ID(), GeomDataAPI_Dir::typeId());
  54   data()->addAttribute(SketchPlugin_Sketch::FEATURES_ID(), ModelAPI_AttributeRefList::typeId());
  55   // the selected face, base for the sketcher plane, not obligatory
  56   data()->addAttribute(SketchPlugin_SketchEntity::EXTERNAL_ID(), ModelAPI_AttributeSelection::typeId());
  57   ModelAPI_Session::get()->validators()->registerNotObligatory(
  58     getKind(), SketchPlugin_SketchEntity::EXTERNAL_ID());
  59 }
  60
  61 void SketchPlugin_Sketch::execute()
  62 {
  63   if (!data()->isValid())
  64     return;
  65   std::shared_ptr<ModelAPI_AttributeRefList> aRefList = std::dynamic_pointer_cast<
  66       ModelAPI_AttributeRefList>(data()->attribute(SketchPlugin_Sketch::FEATURES_ID()));
  67
  68   std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast<GeomDataAPI_Point>(
  69       data()->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
  70   std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
  71       data()->attribute(SketchPlugin_Sketch::DIRX_ID()));
  72   std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
  73       data()->attribute(SketchPlugin_Sketch::NORM_ID()));
  74
  75   std::list<ObjectPtr> aFeatures = aRefList->list();
  76   if (aFeatures.empty())
  77     return;
  78
  79   std::list<ObjectPtr>::const_iterator anIt = aFeatures.begin(), aLast = aFeatures.end();
  80   std::shared_ptr<SketchPlugin_Feature> aFeature;
  81   std::list<std::shared_ptr<GeomAPI_Shape> > aFeaturesPreview;
  82   for (; anIt != aLast; anIt++) {
  83     aFeature = std::dynamic_pointer_cast<SketchPlugin_Feature>(*anIt);
  84     if (aFeature) {
  85       if (!aFeature->sketch()) // on load document the back references are missed
  86         aFeature->setSketch(this);
  87       // do not include the external edges into the result
  88       if (aFeature->data()->attribute(SketchPlugin_SketchEntity::EXTERNAL_ID())) {
  89         if (aFeature->data()->selection(SketchPlugin_SketchEntity::EXTERNAL_ID())->value())
  90           continue;
  91       }
  92       // do not include the construction entities in the result
  93       if (aFeature->data()->attribute(SketchPlugin_SketchEntity::AUXILIARY_ID())) {
  94         if (aFeature->data()->boolean(SketchPlugin_SketchEntity::AUXILIARY_ID())->value())
  95           continue;
  96       }
  97
  98       const std::list<std::shared_ptr<ModelAPI_Result> >& aRes = aFeature->results();
  99       std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aResIter = aRes.cbegin();
 100       for (; aResIter != aRes.cend(); aResIter++) {
 101         std::shared_ptr<ModelAPI_ResultConstruction> aConstr = std::dynamic_pointer_cast<
 102             ModelAPI_ResultConstruction>(*aResIter);
 103         if (aConstr) {
 104           std::shared_ptr<GeomAPI_Shape> aShape = aConstr->shape();
 105           if (aShape)
 106             aFeaturesPreview.push_back(aShape);
 107         }
 108       }
 109     }
 110   }
 111
 112   if (aFeaturesPreview.empty())
 113     return;
 114
 115   // Collect all edges as one big wire
 116   std::shared_ptr<GeomAPI_PlanarEdges> aBigWire(new GeomAPI_PlanarEdges);
 117   std::list<std::shared_ptr<GeomAPI_Shape> >::const_iterator aShapeIt = aFeaturesPreview.begin();
 118   for (; aShapeIt != aFeaturesPreview.end(); ++aShapeIt) {
 119     aBigWire->addEdge(*aShapeIt);
 120   }
 121   aBigWire->setPlane(anOrigin->pnt(), aDirX->dir(), aNorm->dir());
 122   std::shared_ptr<ModelAPI_ResultConstruction> aConstr = document()->createConstruction(data());
 123   aConstr->setShape(aBigWire);
 124   setResult(aConstr);
 125 }
 126
 127 std::shared_ptr<ModelAPI_Feature> SketchPlugin_Sketch::addFeature(std::string theID)
 128 {
 129   std::shared_ptr<ModelAPI_Feature> aNew = document()->addFeature(theID, false);
 130   if (aNew) {
 131     std::dynamic_pointer_cast<SketchPlugin_Feature>(aNew)->setSketch(this);
 132     data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->append(aNew);
 133   }
 134    // set as current also after it becomes sub to set correctly enabled for other sketch subs
 135   document()->setCurrentFeature(aNew, false);
 136   return aNew;
 137 }
 138
 139 void SketchPlugin_Sketch::removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature)
 140 {
 141   if (!data()->isValid()) // sketch is already removed (case on undo of sketch), sync is not needed
 142     return;
 143   // to keep the persistent sub-elements indexing, do not remove elements from list,
 144   // but substitute by nulls
 145   reflist(SketchPlugin_Sketch::FEATURES_ID())->substitute(theFeature, ObjectPtr());
 146   /*
 147   list<ObjectPtr> aSubs = data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->list();
 148   list<ObjectPtr>::iterator aSubIt = aSubs.begin(), aLastIt = aSubs.end();
 149   bool isRemoved = false;
 150   bool aHasEmtpyFeature = false;
 151   for(; aSubIt != aLastIt && !isRemoved; aSubIt++) {
 152     std::shared_ptr<ModelAPI_Feature> aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*aSubIt);
 153     if (aFeature.get() != NULL && aFeature == theFeature) {
 154       data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->remove(aFeature);
 155       isRemoved = true;
 156     }
 157     else if (aFeature.get() == NULL)
 158       aHasEmtpyFeature = true;
 159   }
 160   // if the object is not found in the sketch sub-elements, that means that the object is removed already.
 161   // Find the first empty element and remove it
 162   if (!isRemoved && aHasEmtpyFeature)
 163     data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->remove(ObjectPtr());
 164   */
 165 }
 166
 167 int SketchPlugin_Sketch::numberOfSubs(bool forTree) const
 168 {
 169   if (forTree)
 170     return 0;
 171   return data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->size(false);
 172 }
 173
 174 std::shared_ptr<ModelAPI_Feature> SketchPlugin_Sketch::subFeature(
 175   const int theIndex, bool forTree) const
 176 {
 177   if (forTree)
 178     return FeaturePtr();
 179
 180   ObjectPtr anObj = data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->object(theIndex, false);
 181   return std::dynamic_pointer_cast<ModelAPI_Feature>(anObj);
 182 }
 183
 184 int SketchPlugin_Sketch::subFeatureId(const int theIndex) const
 185 {
 186   std::shared_ptr<ModelAPI_AttributeRefList> aRefList = std::dynamic_pointer_cast<
 187       ModelAPI_AttributeRefList>(data()->attribute(SketchPlugin_Sketch::FEATURES_ID()));
 188   std::list<ObjectPtr> aFeatures = aRefList->list();
 189   std::list<ObjectPtr>::const_iterator anIt = aFeatures.begin();
 190   int aResultIndex = 1; // number of the counted (created) features, started from 1
 191   int aFeatureIndex = -1; // number of the not-empty features in the list
 192   for (; anIt != aFeatures.end(); anIt++) {
 193     if (anIt->get())
 194       aFeatureIndex++;
 195     if (aFeatureIndex == theIndex)
 196       break;
 197     aResultIndex++;
 198   }
 199   return aResultIndex;
 200 }
 201
 202 bool SketchPlugin_Sketch::isSub(ObjectPtr theObject) const
 203 {
 204   // check is this feature of result
 205   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
 206   if (!aFeature) {
 207     ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
 208     if (aRes)
 209       aFeature = document()->feature(aRes);
 210   }
 211   if (aFeature) {
 212     return data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->isInList(aFeature);
 213   }
 214   return false;
 215 }
 216
 217
 218 void SketchPlugin_Sketch::erase()
 219 {
 220   std::shared_ptr<ModelAPI_AttributeRefList> aRefList = std::dynamic_pointer_cast<
 221       ModelAPI_AttributeRefList>(data()->attribute(SketchPlugin_Sketch::FEATURES_ID()));
 222   std::list<ObjectPtr> aFeatures = aRefList->list();
 223   std::list<ObjectPtr>::const_iterator anIt = aFeatures.begin();
 224   for (; anIt != aFeatures.end(); anIt++) {
 225     FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
 226     if (aFeature) {
 227       // subs are referenced from sketch, but must be removed for sure, so not checkings
 228       document()->removeFeature(aFeature);
 229     }
 230   }
 231   ModelAPI_CompositeFeature::erase();
 232 }
 233
 234 void SketchPlugin_Sketch::attributeChanged(const std::string& theID) {
 235   if (theID == SketchPlugin_SketchEntity::EXTERNAL_ID()) {
 236     std::shared_ptr<GeomAPI_Shape> aSelection =
 237       data()->selection(SketchPlugin_SketchEntity::EXTERNAL_ID())->value();
 238     if (aSelection) { // update arguments due to the selection value
 239       // update the sketch plane
 240       std::shared_ptr<GeomAPI_Pln> aPlane = GeomAlgoAPI_FaceBuilder::plane(aSelection);
 241       if (aPlane) {
 242         double anA, aB, aC, aD;
 243         aPlane->coefficients(anA, aB, aC, aD);
 244
 245         // calculate attributes of the sketch
 246         std::shared_ptr<GeomAPI_Dir> aNormDir(new GeomAPI_Dir(anA, aB, aC));
 247         std::shared_ptr<GeomAPI_XYZ> aCoords = aNormDir->xyz();
 248         std::shared_ptr<GeomAPI_XYZ> aZero(new GeomAPI_XYZ(0, 0, 0));
 249         aCoords = aCoords->multiplied(-aD * aCoords->distance(aZero));
 250         std::shared_ptr<GeomAPI_Pnt> anOrigPnt(new GeomAPI_Pnt(aCoords));
 251         // X axis is preferable to be dirX on the sketch
 252         static const double tol = 0.1; // here can not be very small value to avoid very close to X normal axis (issue 595)
 253         bool isX = fabs(anA) - 1.0 < tol && fabs(aB) < tol && fabs(aC) < tol;
 254         std::shared_ptr<GeomAPI_Dir> aTempDir(
 255           isX ? new GeomAPI_Dir(0, 1, 0) : new GeomAPI_Dir(1, 0, 0));
 256         std::shared_ptr<GeomAPI_Dir> aYDir(new GeomAPI_Dir(aNormDir->cross(aTempDir)));
 257         std::shared_ptr<GeomAPI_Dir> aXDir(new GeomAPI_Dir(aYDir->cross(aNormDir)));
 258
 259         // update position of the sketch
 260         std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast
 261           <GeomDataAPI_Point>(data()->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
 262         anOrigin->setValue(anOrigPnt);
 263         std::shared_ptr<GeomDataAPI_Dir> aNormal = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 264           data()->attribute(SketchPlugin_Sketch::NORM_ID()));
 265         aNormal->setValue(aNormDir);
 266         std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 267           data()->attribute(SketchPlugin_Sketch::DIRX_ID()));
 268         aDirX->setValue(aXDir);
 269         std::shared_ptr<GeomAPI_Dir> aDir = aPlane->direction();
 270       }
 271     }
 272   } else if (theID == SketchPlugin_Sketch::NORM_ID() || theID == SketchPlugin_Sketch::DIRX_ID()) {
 273     // send all sub-elements are also updated: all entities become created on different plane
 274     static Events_ID anUpdateEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
 275     std::list<ObjectPtr> aSubs = data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->list();
 276     std::list<ObjectPtr>::iterator aSub = aSubs.begin();
 277     for(; aSub != aSubs.end(); aSub++) {
 278       if (aSub->get())
 279         ModelAPI_EventCreator::get()->sendUpdated(*aSub, anUpdateEvent);
 280     }
 281   }
 282 }
 283
 284 void SketchPlugin_Sketch::createPoint2DResult(ModelAPI_Feature* theFeature,
 285                                               SketchPlugin_Sketch* theSketch,
 286                                               const std::string& theAttributeID, const int theIndex)
 287 {
 288   std::shared_ptr<GeomDataAPI_Point2D> aPoint = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
 289     theFeature->attribute(theAttributeID));
 290
 291   if (!aPoint || !aPoint->isInitialized())
 292     return;
 293
 294   std::shared_ptr<GeomAPI_Pnt> aCenter(theSketch->to3D(aPoint->x(), aPoint->y()));
 295   //std::cout<<"Execute circle "<<aCenter->x()<<" "<<aCenter->y()<<" "<<aCenter->z()<<std::endl;
 296   // make a visible point
 297   std::shared_ptr<GeomAPI_Shape> aCenterPointShape = GeomAlgoAPI_PointBuilder::point(aCenter);
 298   std::shared_ptr<ModelAPI_ResultConstruction> aResult = theFeature->document()->createConstruction(
 299                      theFeature->data(), theIndex);
 300   aResult->setShape(aCenterPointShape);
 301   aResult->setIsInHistory(false);
 302
 303   theFeature->setResult(aResult, theIndex);
 304 }
 305
 306 FeaturePtr SketchPlugin_Sketch::addUniqueNamedCopiedFeature(FeaturePtr theFeature,
 307                                                             SketchPlugin_Sketch* theSketch)
 308 {
 309   FeaturePtr aNewFeature = theSketch->addFeature(theFeature->getKind());
 310   // addFeature generates a unique name for the feature, it caches the name
 311   std::string aUniqueFeatureName = aNewFeature->data()->name();
 312   // all attribute values are copied\pasted to the new feature, name is not an exception
 313   theFeature->data()->copyTo(aNewFeature->data());
 314   // as a name for the feature, the generated unique name is set
 315   aNewFeature->data()->setName(aUniqueFeatureName);
 316   // text expressions could block setValue of some attributes
 317   clearExpressions(aNewFeature);
 318
 319   return aNewFeature;
 320 }
 321
 322 std::shared_ptr<GeomAPI_Ax3> SketchPlugin_Sketch::plane(SketchPlugin_Sketch* theSketch)
 323 {
 324   std::shared_ptr<ModelAPI_Data> aData = theSketch->data();
 325
 326   std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast<GeomDataAPI_Point>(
 327       aData->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
 328   std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 329       aData->attribute(SketchPlugin_Sketch::DIRX_ID()));
 330   std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 331       aData->attribute(SketchPlugin_Sketch::NORM_ID()));
 332
 333   return std::shared_ptr<GeomAPI_Ax3>(new GeomAPI_Ax3(anOrigin->pnt(), aDirX->dir(), aNorm->dir()));
 334 }