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   if (aFeaturesPreview.empty()) {
 114     // no good features for generation of preview => erase result if exists
 115     if (firstResult().get() && !firstResult()->isDisabled())
 116       removeResults(0, false);
 117     return;
 118   }
 119
 120   // Collect all edges as one big wire
 121   std::shared_ptr<GeomAPI_PlanarEdges> aBigWire(new GeomAPI_PlanarEdges);
 122   std::list<std::shared_ptr<GeomAPI_Shape> >::const_iterator aShapeIt = aFeaturesPreview.begin();
 123   for (; aShapeIt != aFeaturesPreview.end(); ++aShapeIt) {
 124     aBigWire->addEdge(*aShapeIt);
 125   }
 126   aBigWire->setPlane(anOrigin->pnt(), aDirX->dir(), aNorm->dir());
 127   std::shared_ptr<ModelAPI_ResultConstruction> aConstr = document()->createConstruction(data());
 128   aConstr->setShape(aBigWire);
 129   setResult(aConstr);
 130 }
 131
 132 std::shared_ptr<ModelAPI_Feature> SketchPlugin_Sketch::addFeature(std::string theID)
 133 {
 134   std::shared_ptr<ModelAPI_Feature> aNew = document()->addFeature(theID, false);
 135   if (aNew) {
 136     std::dynamic_pointer_cast<SketchPlugin_Feature>(aNew)->setSketch(this);
 137     data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->append(aNew);
 138   }
 139    // set as current also after it becomes sub to set correctly enabled for other sketch subs
 140   document()->setCurrentFeature(aNew, false);
 141   return aNew;
 142 }
 143
 144 void SketchPlugin_Sketch::removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature)
 145 {
 146   if (!data()->isValid()) // sketch is already removed (case on undo of sketch), sync is not needed
 147     return;
 148   AttributeRefListPtr aList = reflist(SketchPlugin_Sketch::FEATURES_ID());
 149   // if the object is last, remove it from the list (needed to skip empty transaction on edit of sketch feature)
 150   if (aList->object(aList->size(true) - 1, true) == theFeature) {
 151     aList->remove(theFeature);
 152   } else {
 153     // to keep the persistent sub-elements indexing, do not remove elements from list,
 154     // but substitute by nulls
 155     aList->substitute(theFeature, ObjectPtr());
 156   }
 157 }
 158
 159 int SketchPlugin_Sketch::numberOfSubs(bool forTree) const
 160 {
 161   if (forTree)
 162     return 0;
 163   return data()->reflist(FEATURES_ID())->size(false);
 164 }
 165
 166 std::shared_ptr<ModelAPI_Feature> SketchPlugin_Sketch::subFeature(
 167   const int theIndex, bool forTree)
 168 {
 169   if (forTree)
 170     return FeaturePtr();
 171
 172   ObjectPtr anObj = data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->object(theIndex, false);
 173   FeaturePtr aRes = std::dynamic_pointer_cast<ModelAPI_Feature>(anObj);
 174   return aRes;
 175 }
 176
 177 int SketchPlugin_Sketch::subFeatureId(const int theIndex) const
 178 {
 179   std::shared_ptr<ModelAPI_AttributeRefList> aRefList = std::dynamic_pointer_cast<
 180       ModelAPI_AttributeRefList>(data()->attribute(SketchPlugin_Sketch::FEATURES_ID()));
 181   std::list<ObjectPtr> aFeatures = aRefList->list();
 182   std::list<ObjectPtr>::const_iterator anIt = aFeatures.begin();
 183   int aResultIndex = 1; // number of the counted (created) features, started from 1
 184   int aFeatureIndex = -1; // number of the not-empty features in the list
 185   for (; anIt != aFeatures.end(); anIt++) {
 186     if (anIt->get())
 187       aFeatureIndex++;
 188     if (aFeatureIndex == theIndex)
 189       break;
 190     aResultIndex++;
 191   }
 192   return aResultIndex;
 193 }
 194
 195 bool SketchPlugin_Sketch::isSub(ObjectPtr theObject) const
 196 {
 197   // check is this feature of result
 198   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
 199   if (!aFeature) {
 200     ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
 201     if (aRes)
 202       aFeature = document()->feature(aRes);
 203   }
 204   if (aFeature) {
 205     return data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->isInList(aFeature);
 206   }
 207   return false;
 208 }
 209
 210
 211 void SketchPlugin_Sketch::erase()
 212 {
 213   std::shared_ptr<ModelAPI_AttributeRefList> aRefList = std::dynamic_pointer_cast<
 214       ModelAPI_AttributeRefList>(data()->attribute(SketchPlugin_Sketch::FEATURES_ID()));
 215   std::list<ObjectPtr> aFeatures = aRefList->list();
 216   std::list<ObjectPtr>::const_iterator anIt = aFeatures.begin();
 217   for (; anIt != aFeatures.end(); anIt++) {
 218     FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
 219     if (aFeature) {
 220       // subs are referenced from sketch, but must be removed for sure, so not checkings
 221       document()->removeFeature(aFeature);
 222     }
 223   }
 224   ModelAPI_CompositeFeature::erase();
 225 }
 226
 227 void SketchPlugin_Sketch::attributeChanged(const std::string& theID) {
 228   if (theID == SketchPlugin_SketchEntity::EXTERNAL_ID()) {
 229     std::shared_ptr<GeomAPI_Shape> aSelection =
 230       data()->selection(SketchPlugin_SketchEntity::EXTERNAL_ID())->value();
 231     if (aSelection) { // update arguments due to the selection value
 232       // update the sketch plane
 233       std::shared_ptr<GeomAPI_Pln> aPlane = GeomAlgoAPI_FaceBuilder::plane(aSelection);
 234       if (aPlane) {
 235         double anA, aB, aC, aD;
 236         aPlane->coefficients(anA, aB, aC, aD);
 237
 238         // calculate attributes of the sketch
 239         std::shared_ptr<GeomAPI_Dir> aNormDir(new GeomAPI_Dir(anA, aB, aC));
 240         std::shared_ptr<GeomAPI_XYZ> aCoords = aNormDir->xyz();
 241         std::shared_ptr<GeomAPI_XYZ> aZero(new GeomAPI_XYZ(0, 0, 0));
 242         aCoords = aCoords->multiplied(-aD * aCoords->distance(aZero));
 243         std::shared_ptr<GeomAPI_Pnt> anOrigPnt(new GeomAPI_Pnt(aCoords));
 244         // X axis is preferable to be dirX on the sketch
 245         static const double tol = 0.1; // here can not be very small value to avoid very close to X normal axis (issue 595)
 246         bool isX = fabs(anA) - 1.0 < tol && fabs(aB) < tol && fabs(aC) < tol;
 247         std::shared_ptr<GeomAPI_Dir> aTempDir(
 248           isX ? new GeomAPI_Dir(0, 1, 0) : new GeomAPI_Dir(1, 0, 0));
 249         std::shared_ptr<GeomAPI_Dir> aYDir(new GeomAPI_Dir(aNormDir->cross(aTempDir)));
 250         std::shared_ptr<GeomAPI_Dir> aXDir(new GeomAPI_Dir(aYDir->cross(aNormDir)));
 251
 252         // update position of the sketch
 253         std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast
 254           <GeomDataAPI_Point>(data()->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
 255         anOrigin->setValue(anOrigPnt);
 256         std::shared_ptr<GeomDataAPI_Dir> aNormal = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 257           data()->attribute(SketchPlugin_Sketch::NORM_ID()));
 258         aNormal->setValue(aNormDir);
 259         std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 260           data()->attribute(SketchPlugin_Sketch::DIRX_ID()));
 261         aDirX->setValue(aXDir);
 262         std::shared_ptr<GeomAPI_Dir> aDir = aPlane->direction();
 263       }
 264     }
 265   } else if (theID == SketchPlugin_Sketch::NORM_ID() || theID == SketchPlugin_Sketch::DIRX_ID()) {
 266     // send all sub-elements are also updated: all entities become created on different plane
 267     static Events_ID anUpdateEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
 268     std::list<ObjectPtr> aSubs = data()->reflist(SketchPlugin_Sketch::FEATURES_ID())->list();
 269     std::list<ObjectPtr>::iterator aSub = aSubs.begin();
 270     for(; aSub != aSubs.end(); aSub++) {
 271       if (aSub->get())
 272         ModelAPI_EventCreator::get()->sendUpdated(*aSub, anUpdateEvent);
 273     }
 274   }
 275 }
 276
 277 void SketchPlugin_Sketch::createPoint2DResult(ModelAPI_Feature* theFeature,
 278                                               SketchPlugin_Sketch* theSketch,
 279                                               const std::string& theAttributeID, const int theIndex)
 280 {
 281   std::shared_ptr<GeomDataAPI_Point2D> aPoint = std::dynamic_pointer_cast<GeomDataAPI_Point2D>(
 282     theFeature->attribute(theAttributeID));
 283
 284   if (!aPoint || !aPoint->isInitialized())
 285     return;
 286
 287   std::shared_ptr<GeomAPI_Pnt> aCenter(theSketch->to3D(aPoint->x(), aPoint->y()));
 288   //std::cout<<"Execute circle "<<aCenter->x()<<" "<<aCenter->y()<<" "<<aCenter->z()<<std::endl;
 289   // make a visible point
 290   std::shared_ptr<GeomAPI_Shape> aCenterPointShape = GeomAlgoAPI_PointBuilder::point(aCenter);
 291   std::shared_ptr<ModelAPI_ResultConstruction> aResult = theFeature->document()->createConstruction(
 292                      theFeature->data(), theIndex);
 293   aResult->setShape(aCenterPointShape);
 294   aResult->setIsInHistory(false);
 295
 296   theFeature->setResult(aResult, theIndex);
 297 }
 298
 299 FeaturePtr SketchPlugin_Sketch::addUniqueNamedCopiedFeature(FeaturePtr theFeature,
 300                                                             SketchPlugin_Sketch* theSketch)
 301 {
 302   FeaturePtr aNewFeature = theSketch->addFeature(theFeature->getKind());
 303   // addFeature generates a unique name for the feature, it caches the name
 304   std::string aUniqueFeatureName = aNewFeature->data()->name();
 305   // all attribute values are copied\pasted to the new feature, name is not an exception
 306   theFeature->data()->copyTo(aNewFeature->data());
 307   // as a name for the feature, the generated unique name is set
 308   aNewFeature->data()->setName(aUniqueFeatureName);
 309   // text expressions could block setValue of some attributes
 310   SketchPlugin_Tools::clearExpressions(aNewFeature);
 311
 312   return aNewFeature;
 313 }
 314
 315 std::shared_ptr<GeomAPI_Ax3> SketchPlugin_Sketch::plane(SketchPlugin_Sketch* theSketch)
 316 {
 317   std::shared_ptr<ModelAPI_Data> aData = theSketch->data();
 318
 319   std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast<GeomDataAPI_Point>(
 320       aData->attribute(SketchPlugin_Sketch::ORIGIN_ID()));
 321   std::shared_ptr<GeomDataAPI_Dir> aDirX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 322       aData->attribute(SketchPlugin_Sketch::DIRX_ID()));
 323   std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 324       aData->attribute(SketchPlugin_Sketch::NORM_ID()));
 325
 326   return std::shared_ptr<GeomAPI_Ax3>(new GeomAPI_Ax3(anOrigin->pnt(), aDirX->dir(), aNorm->dir()));
 327 }
 328
 329 void SketchPlugin_Sketch::exchangeIDs(
 330   std::shared_ptr<ModelAPI_Feature> theFeature1, std::shared_ptr<ModelAPI_Feature> theFeature2)
 331 {
 332   reflist(SketchPlugin_Sketch::FEATURES_ID())->exchange(theFeature1, theFeature2);
 333 }