src/FeaturesPlugin/FeaturesPlugin_CompositeSketch.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 <FeaturesPlugin_CompositeSketch.h>
  22
  23 #include <ModelAPI_AttributeSelectionList.h>
  24 #include <ModelAPI_AttributeReference.h>
  25 #include <ModelAPI_BodyBuilder.h>
  26 #include <ModelAPI_ResultConstruction.h>
  27 #include <ModelAPI_Session.h>
  28 #include <ModelAPI_Validator.h>
  29
  30 #include <GeomAlgoAPI_CompoundBuilder.h>
  31 #include <GeomAlgoAPI_Prism.h>
  32 #include <GeomAlgoAPI_Revolution.h>
  33 #include <GeomAlgoAPI_ShapeTools.h>
  34 #include <GeomAlgoAPI_SketchBuilder.h>
  35
  36 #include <GeomAPI_PlanarEdges.h>
  37 #include <GeomAPI_ShapeExplorer.h>
  38
  39 #include <map>
  40 #include <sstream>
  41
  42 static void storeSubShape(const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
  43                           ResultBodyPtr theResultBody,
  44                           const GeomShapePtr theShape,
  45                           const GeomAPI_Shape::ShapeType theType,
  46                           const std::string& theName);
  47
  48 //=================================================================================================
  49 void FeaturesPlugin_CompositeSketch::initCompositeSketchAttribtues(const int theInitFlags)
  50 {
  51   // Initialize sketch launcher.
  52   if(theInitFlags & InitSketchLauncher) {
  53     data()->addAttribute(SKETCH_ID(), ModelAPI_AttributeReference::typeId());
  54     ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), SKETCH_ID());
  55   }
  56
  57   // Initialize selection list.
  58   if(theInitFlags & InitBaseObjectsList) {
  59     data()->addAttribute(BASE_OBJECTS_ID(), ModelAPI_AttributeSelectionList::typeId());
  60   }
  61 }
  62
  63 //=================================================================================================
  64 std::shared_ptr<ModelAPI_Feature> FeaturesPlugin_CompositeSketch::addFeature(std::string theID)
  65 {
  66   FeaturePtr aNew = document()->addFeature(theID, false);
  67   if(aNew) {
  68     data()->reference(SKETCH_ID())->setValue(aNew);
  69   }
  70
  71   // Set as current also after it becomes sub to set correctly enabled for other sketch subs.
  72   document()->setCurrentFeature(aNew, false);
  73   return aNew;
  74 }
  75
  76 //=================================================================================================
  77 int FeaturesPlugin_CompositeSketch::numberOfSubs(bool forTree) const
  78 {
  79   ObjectPtr aObj = data()->reference(SKETCH_ID())->value();
  80   return aObj.get() ? 1 : 0;
  81 }
  82
  83 //=================================================================================================
  84 std::shared_ptr<ModelAPI_Feature> FeaturesPlugin_CompositeSketch::subFeature(const int theIndex,
  85                                                                              bool forTree)
  86 {
  87   if(theIndex == 0) {
  88     return std::dynamic_pointer_cast<ModelAPI_Feature>(data()->reference(SKETCH_ID())->value());
  89   }
  90
  91   return std::shared_ptr<ModelAPI_Feature>();
  92 }
  93
  94 //=================================================================================================
  95 int FeaturesPlugin_CompositeSketch::subFeatureId(const int theIndex) const
  96 {
  97   if(theIndex == 0) {
  98     FeaturePtr aFeature =
  99       std::dynamic_pointer_cast<ModelAPI_Feature>(data()->reference(SKETCH_ID())->value());
 100     if(aFeature.get()) {
 101       return aFeature->data()->featureId();
 102     }
 103   }
 104
 105   return -1;
 106 }
 107
 108 //=================================================================================================
 109 bool FeaturesPlugin_CompositeSketch::isSub(ObjectPtr theObject) const
 110 {
 111   // Check is this feature of result
 112   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
 113   if(!aFeature.get()) {
 114     return false;
 115   }
 116
 117   ObjectPtr aSub = data()->reference(SKETCH_ID())->value();
 118   return aSub == theObject;
 119 }
 120
 121 //=================================================================================================
 122 void FeaturesPlugin_CompositeSketch::removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature)
 123 {
 124   AttributeSelectionListPtr aBaseObjectsSelectionList = selectionList(BASE_OBJECTS_ID());
 125   if(aBaseObjectsSelectionList.get() && aBaseObjectsSelectionList->size() > 0) {
 126     aBaseObjectsSelectionList->clear();
 127   }
 128
 129   reference(SKETCH_ID())->setValue(ObjectPtr());
 130 }
 131
 132 //=================================================================================================
 133 void FeaturesPlugin_CompositeSketch::getBaseShapes(ListOfShape& theBaseShapesList,
 134                                                    const bool theIsMakeShells)
 135 {
 136   theBaseShapesList.clear();
 137
 138   ListOfShape aBaseFacesList;
 139   std::map<ResultConstructionPtr, ListOfShape> aSketchWiresMap;
 140   AttributeSelectionListPtr aBaseObjectsSelectionList = selectionList(BASE_OBJECTS_ID());
 141   if(!aBaseObjectsSelectionList.get()) {
 142     setError("Error: Could not get base objects selection list.");
 143     return;
 144   }
 145   if(aBaseObjectsSelectionList->size() == 0) {
 146     setError("Error: Base objects list is empty.");
 147     return;
 148   }
 149   for(int anIndex = 0; anIndex < aBaseObjectsSelectionList->size(); anIndex++) {
 150     AttributeSelectionPtr aBaseObjectSelection = aBaseObjectsSelectionList->value(anIndex);
 151     if(!aBaseObjectSelection.get()) {
 152       setError("Error: Selected base object is empty.");
 153       return;
 154     }
 155     GeomShapePtr aBaseShape = aBaseObjectSelection->value();
 156     if(aBaseShape.get() && !aBaseShape->isNull()) {
 157       GeomAPI_Shape::ShapeType aST = aBaseShape->shapeType();
 158       if(aST == GeomAPI_Shape::SOLID || aST == GeomAPI_Shape::COMPSOLID) {
 159         setError("Error: Selected shapes has unsupported type.");
 160         return;
 161       }
 162       ResultConstructionPtr aConstruction =
 163         std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(aBaseObjectSelection->context());
 164       if(aConstruction.get() && !aBaseShape->isEqual(aConstruction->shape()) &&
 165           aST == GeomAPI_Shape::WIRE) {
 166         // It is a wire on the sketch, store it to make face later.
 167         aSketchWiresMap[aConstruction].push_back(aBaseShape);
 168         continue;
 169       } else {
 170       aST == GeomAPI_Shape::FACE ? aBaseFacesList.push_back(aBaseShape) :
 171                                    theBaseShapesList.push_back(aBaseShape);
 172       }
 173     } else {
 174       // This may be the whole sketch result selected, check and get faces.
 175       ResultConstructionPtr aConstruction =
 176         std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(aBaseObjectSelection->context());
 177       if(!aConstruction.get()) {
 178         setError("Error: Selected sketches does not have results.");
 179         return;
 180       }
 181       int aFacesNum = aConstruction->facesNum();
 182       if(aFacesNum == 0) {
 183         // Probably it can be construction.
 184         aBaseShape = aConstruction->shape();
 185         if(aBaseShape.get() && !aBaseShape->isNull()) {
 186           GeomAPI_Shape::ShapeType aST = aBaseShape->shapeType();
 187           if(aST != GeomAPI_Shape::VERTEX && aST != GeomAPI_Shape::EDGE &&
 188              aST != GeomAPI_Shape::WIRE &&
 189              aST != GeomAPI_Shape::FACE && aST != GeomAPI_Shape::SHELL) {
 190             setError("Error: Selected shapes has unsupported type.");
 191             return;
 192           }
 193           aST == GeomAPI_Shape::FACE ? aBaseFacesList.push_back(aBaseShape) :
 194                                        theBaseShapesList.push_back(aBaseShape);
 195         }
 196       } else {
 197         for(int aFaceIndex = 0; aFaceIndex < aFacesNum; aFaceIndex++) {
 198           GeomShapePtr aBaseFace = aConstruction->face(aFaceIndex);
 199           if(!aBaseFace.get() || aBaseFace->isNull()) {
 200             setError("Error: One of the faces on selected sketch is null.");
 201             return;
 202           }
 203           aBaseFacesList.push_back(aBaseFace);
 204         }
 205       }
 206     }
 207   }
 208
 209   // Make faces from sketch wires.
 210   for(std::map<ResultConstructionPtr, ListOfShape>::const_iterator anIt = aSketchWiresMap.cbegin();
 211       anIt != aSketchWiresMap.cend(); ++anIt) {
 212     const std::shared_ptr<GeomAPI_PlanarEdges> aSketchPlanarEdges =
 213       std::dynamic_pointer_cast<GeomAPI_PlanarEdges>((*anIt).first->shape());
 214     const ListOfShape& aWiresList = (*anIt).second;
 215     ListOfShape aFaces;
 216     GeomAlgoAPI_ShapeTools::makeFacesWithHoles(aSketchPlanarEdges->origin(),
 217                                                aSketchPlanarEdges->norm(),
 218                                                aWiresList,
 219                                                aFaces);
 220     aBaseFacesList.insert(aBaseFacesList.end(), aFaces.begin(), aFaces.end());
 221   }
 222
 223   // Searching faces with common edges.
 224   if(theIsMakeShells && aBaseFacesList.size() > 1) {
 225     ListOfShape aShells;
 226     ListOfShape aFreeFaces;
 227     GeomShapePtr aFacesCompound = GeomAlgoAPI_CompoundBuilder::compound(aBaseFacesList);
 228     GeomAlgoAPI_ShapeTools::combineShapes(aFacesCompound, GeomAPI_Shape::SHELL,
 229                                           aShells, aFreeFaces);
 230     theBaseShapesList.insert(theBaseShapesList.end(), aFreeFaces.begin(), aFreeFaces.end());
 231     theBaseShapesList.insert(theBaseShapesList.end(), aShells.begin(), aShells.end());
 232   } else {
 233     theBaseShapesList.insert(theBaseShapesList.end(), aBaseFacesList.begin(),
 234                              aBaseFacesList.end());
 235   }
 236 }
 237
 238 //=================================================================================================
 239 bool FeaturesPlugin_CompositeSketch::isMakeShapeValid(
 240   const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape)
 241 {
 242   // Check that algo is done.
 243   if(!theMakeShape->isDone()) {
 244     setError("Error: " + getKind() + " algorithm failed.");
 245     return false;
 246   }
 247
 248   // Check if shape is not null.
 249   if(!theMakeShape->shape().get() || theMakeShape->shape()->isNull()) {
 250     setError("Error: Resulting shape is null.");
 251     return false;
 252   }
 253
 254   // Check that resulting shape is valid.
 255   if(!theMakeShape->isValid()) {
 256     setError("Error: Resulting shape is not valid.");
 257     return false;
 258   }
 259
 260   return true;
 261 }
 262
 263 //=================================================================================================
 264 void FeaturesPlugin_CompositeSketch::storeResult(const GeomShapePtr theBaseShape,
 265                                         const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
 266                                         const int theIndex)
 267 {
 268   // Create result body.
 269   ResultBodyPtr aResultBody = document()->createBody(data(), theIndex);
 270
 271   // Store generated shape.
 272   aResultBody->storeGenerated(theBaseShape, theMakeShape->shape());
 273
 274   // Store generated edges/faces.
 275   storeGenerationHistory(aResultBody, theBaseShape, theMakeShape);
 276
 277   setResult(aResultBody, theIndex);
 278 }
 279
 280 //=================================================================================================
 281 void FeaturesPlugin_CompositeSketch::storeGenerationHistory(ResultBodyPtr theResultBody,
 282                                         const GeomShapePtr theBaseShape,
 283                                         const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape)
 284 {
 285   GeomAPI_Shape::ShapeType aBaseShapeType = theBaseShape->shapeType();
 286   GeomAPI_Shape::ShapeType aShapeTypeToExplode = GeomAPI_Shape::SHAPE;
 287
 288   switch(aBaseShapeType) {
 289     case GeomAPI_Shape::EDGE: {
 290             aShapeTypeToExplode = GeomAPI_Shape::VERTEX;
 291       break;
 292     }
 293     case GeomAPI_Shape::WIRE: {
 294       aShapeTypeToExplode = GeomAPI_Shape::COMPOUND;
 295       break;
 296     }
 297     case GeomAPI_Shape::FACE:
 298     case GeomAPI_Shape::SHELL: {
 299       aShapeTypeToExplode = GeomAPI_Shape::EDGE;
 300       break;
 301     }
 302     case GeomAPI_Shape::COMPOUND: {
 303       aShapeTypeToExplode = GeomAPI_Shape::COMPOUND;
 304     }
 305   }
 306
 307   int aLateralIndex = 1;
 308   int aBaseEdgeIndex = 1;
 309   int aVertexIndex = 1;
 310   int aBaseVertexIndex = 1;
 311
 312   if(aShapeTypeToExplode == GeomAPI_Shape::VERTEX ||
 313       aShapeTypeToExplode == GeomAPI_Shape::COMPOUND) {
 314     theResultBody->loadGeneratedShapes(theMakeShape, theBaseShape, GeomAPI_Shape::VERTEX);
 315   }
 316   if(aShapeTypeToExplode == GeomAPI_Shape::EDGE ||
 317       aShapeTypeToExplode == GeomAPI_Shape::COMPOUND) {
 318     theResultBody->loadGeneratedShapes(theMakeShape, theBaseShape, GeomAPI_Shape::EDGE);
 319   }
 320   std::list<std::shared_ptr<GeomAlgoAPI_MakeSweep> > aSweeps; // all sweeps collected
 321   std::shared_ptr<GeomAlgoAPI_MakeSweep> aMakeSweep =
 322     std::dynamic_pointer_cast<GeomAlgoAPI_MakeSweep>(theMakeShape);
 323   if(aMakeSweep.get()) {
 324     aSweeps.push_back(aMakeSweep);
 325   } else {
 326     std::shared_ptr<GeomAlgoAPI_MakeShapeList> aMakeList =
 327       std::dynamic_pointer_cast<GeomAlgoAPI_MakeShapeList>(theMakeShape);
 328     if (aMakeList.get()) {
 329       ListOfMakeShape::const_iterator anIter = aMakeList->list().cbegin();
 330       for(; anIter != aMakeList->list().cend(); anIter++) {
 331         std::shared_ptr<GeomAlgoAPI_MakeSweep> aSweep =
 332           std::dynamic_pointer_cast<GeomAlgoAPI_MakeSweep>(*anIter);
 333         if (aSweep.get())
 334           aSweeps.push_back(aSweep);
 335       }
 336     }
 337   }
 338   std::list<std::shared_ptr<GeomAlgoAPI_MakeSweep> >::iterator aSweep = aSweeps.begin();
 339   for(; aSweep != aSweeps.end(); aSweep++) {
 340     // Store from shapes.
 341     storeShapes(theMakeShape, theResultBody, aBaseShapeType, (*aSweep)->fromShapes(), "From_");
 342
 343     // Store to shapes.
 344     storeShapes(theMakeShape, theResultBody, aBaseShapeType, (*aSweep)->toShapes(), "To_");
 345   }
 346 }
 347
 348 //=================================================================================================
 349 void FeaturesPlugin_CompositeSketch::storeShapes(
 350   const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
 351   ResultBodyPtr theResultBody,
 352   const GeomAPI_Shape::ShapeType theBaseShapeType,
 353   const ListOfShape& theShapes,
 354   const std::string theName)
 355 {
 356   GeomAPI_Shape::ShapeType aShapeTypeToExplore = GeomAPI_Shape::FACE;
 357   std::string aShapeTypeStr = "Face";
 358   switch(theBaseShapeType) {
 359     case GeomAPI_Shape::VERTEX: {
 360       aShapeTypeToExplore = GeomAPI_Shape::VERTEX;
 361       aShapeTypeStr = "Vertex";
 362       break;
 363     }
 364     case GeomAPI_Shape::EDGE:
 365     case GeomAPI_Shape::WIRE: {
 366       aShapeTypeToExplore = GeomAPI_Shape::EDGE;
 367       aShapeTypeStr = "Edge";
 368       break;
 369     }
 370     case GeomAPI_Shape::FACE:
 371     case GeomAPI_Shape::SHELL: {
 372       aShapeTypeToExplore = GeomAPI_Shape::FACE;
 373       aShapeTypeStr = "Face";
 374       break;
 375     }
 376     case GeomAPI_Shape::COMPOUND: {
 377       aShapeTypeToExplore = GeomAPI_Shape::COMPOUND;
 378       break;
 379     }
 380   }
 381
 382   // Store shapes.
 383   for(ListOfShape::const_iterator anIt = theShapes.cbegin(); anIt != theShapes.cend(); ++anIt) {
 384     GeomShapePtr aShape = *anIt;
 385
 386     if(aShapeTypeToExplore == GeomAPI_Shape::COMPOUND) {
 387       std::string aName = theName + (aShape->shapeType() == GeomAPI_Shape::EDGE ? "Edge" : "Face");
 388       storeSubShape(theMakeShape, theResultBody, aShape, aShape->shapeType(), aName);
 389     } else {
 390       std::string aName = theName + aShapeTypeStr;
 391       storeSubShape(theMakeShape, theResultBody, aShape, aShapeTypeToExplore, aName);
 392       if (theBaseShapeType == GeomAPI_Shape::WIRE) { // issue 2289: special names also for vertices
 393         aName = theName + "Vertex";
 394         storeSubShape(theMakeShape, theResultBody, aShape, GeomAPI_Shape::VERTEX, aName);
 395       }
 396     }
 397   }
 398 }
 399
 400 void storeSubShape(
 401   const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
 402   ResultBodyPtr theResultBody,
 403   const GeomShapePtr theShape,
 404   const GeomAPI_Shape::ShapeType theType,
 405   const std::string& theName)
 406 {
 407   for(GeomAPI_ShapeExplorer anExp(theShape, theType); anExp.more(); anExp.next()) {
 408     GeomShapePtr aSubShape = anExp.current();
 409     if (!theResultBody->generated(aSubShape, theName)) {
 410       // store from/to shapes as primitives and then store modification of them by the boolean
 411       theResultBody->generated(aSubShape, theName, false);
 412       theResultBody->loadModifiedShapes(theMakeShape, aSubShape, theType);
 413     }
 414   }
 415 }