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