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