src/SketchPlugin/SketchPlugin_Sketch.cpp

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