Salome HOME
updated copyright message
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_CompositeSketch.cpp
index 3d8ce83ef4473825baaffd406a6ac879419bf2cd..3d5b66c2ad879c391dd64ee0a8abb2a4f099982f 100644 (file)
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        FeaturesPlugin_CompositeSketch.cpp
-// Created:     11 September 2015
-// Author:      Dmitry Bobylev
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #include <FeaturesPlugin_CompositeSketch.h>
+#include <FeaturesPlugin_Tools.h>
 
 #include <ModelAPI_AttributeSelectionList.h>
 #include <ModelAPI_AttributeReference.h>
 #include <ModelAPI_BodyBuilder.h>
-#include <ModelAPI_ResultBody.h>
 #include <ModelAPI_ResultConstruction.h>
 #include <ModelAPI_Session.h>
 #include <ModelAPI_Validator.h>
 
-#include <GeomAlgoAPI_CompoundBuilder.h>
-#include <GeomAlgoAPI_Prism.h>
 #include <GeomAlgoAPI_Revolution.h>
-#include <GeomAlgoAPI_ShapeTools.h>
 
-#include <sstream>
+#include <GeomAPI_ShapeExplorer.h>
+
+
+static const std::string COMPOSITESKETCH_VERSION_1("v9.6");
+
+static void storeSubShape(const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
+                          ResultBodyPtr theResultBody,
+                          const GeomShapePtr theShape,
+                          const GeomAPI_Shape::ShapeType theType,
+                          const std::string& theName);
 
 //=================================================================================================
-void FeaturesPlugin_CompositeSketch::initAttributes()
+void FeaturesPlugin_CompositeSketch::initCompositeSketchAttribtues(const int theInitFlags)
 {
-  data()->addAttribute(SKETCH_OBJECT_ID(), ModelAPI_AttributeReference::typeId());
-  data()->addAttribute(SKETCH_SELECTION_ID(), ModelAPI_AttributeSelection::typeId());
-  ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), SKETCH_SELECTION_ID());
+  // Initialize sketch launcher.
+  if(theInitFlags & InitSketchLauncher) {
+    data()->addAttribute(SKETCH_ID(), ModelAPI_AttributeReference::typeId());
+    ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), SKETCH_ID());
+  }
 
-  //initMakeSolidsAttributes();
+  // Initialize selection list.
+  if(theInitFlags & InitBaseObjectsList) {
+    AttributeSelectionListPtr anObjectsAttr =
+        std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(
+        data()->addAttribute(BASE_OBJECTS_ID(), ModelAPI_AttributeSelectionList::typeId()));
+    myCurrentSelectionType = selectionList(BASE_OBJECTS_ID())->selectionType();
+    anObjectsAttr->setWholeResultAllowed(true);
+    if (!anObjectsAttr->isInitialized()) {
+      // new feature, specify the version
+      data()->setVersion(COMPOSITESKETCH_VERSION_1);
+    }
+  }
 }
 
 //=================================================================================================
 std::shared_ptr<ModelAPI_Feature> FeaturesPlugin_CompositeSketch::addFeature(std::string theID)
 {
-  std::shared_ptr<ModelAPI_Feature> aNew = document()->addFeature(theID, false);
-  if (aNew) {
-    data()->reference(SKETCH_OBJECT_ID())->setValue(aNew);
+  FeaturePtr aNew = document()->addFeature(theID, false);
+  if(aNew) {
+    data()->reference(SKETCH_ID())->setValue(aNew);
   }
-  // set as current also after it becomes sub to set correctly enabled for other sketch subs
+
+  // Set as current also after it becomes sub to set correctly enabled for other sketch subs.
   document()->setCurrentFeature(aNew, false);
   return aNew;
 }
 
 //=================================================================================================
-int FeaturesPlugin_CompositeSketch::numberOfSubs(bool forTree) const
+int FeaturesPlugin_CompositeSketch::numberOfSubs(bool /*forTree*/) const
 {
-  ObjectPtr aObj = data()->reference(SKETCH_OBJECT_ID())->value();
-  return aObj.get()? 1 : 0;
+  ObjectPtr aObj = data()->reference(SKETCH_ID())->value();
+  return aObj.get() ? 1 : 0;
 }
 
 //=================================================================================================
-std::shared_ptr<ModelAPI_Feature> FeaturesPlugin_CompositeSketch::subFeature(const int theIndex, bool forTree)
+std::shared_ptr<ModelAPI_Feature> FeaturesPlugin_CompositeSketch::subFeature(const int theIndex,
+                                                                             bool /*forTree*/)
 {
-  if (theIndex == 0)
-    return std::dynamic_pointer_cast<ModelAPI_Feature>(data()->reference(SKETCH_OBJECT_ID())->value());
-  return std::shared_ptr<ModelAPI_Feature>();
+  FeaturePtr aSubFeature;
+  if(theIndex == 0) {
+    aSubFeature =
+        std::dynamic_pointer_cast<ModelAPI_Feature>(data()->reference(SKETCH_ID())->value());
+  }
+  return aSubFeature;
 }
 
 //=================================================================================================
 int FeaturesPlugin_CompositeSketch::subFeatureId(const int theIndex) const
 {
-  if (theIndex == 0) {
-    FeaturePtr aFeature = 
-      std::dynamic_pointer_cast<ModelAPI_Feature>(data()->reference(SKETCH_OBJECT_ID())->value());
-    if (aFeature.get())
+  if(theIndex == 0) {
+    FeaturePtr aFeature =
+      std::dynamic_pointer_cast<ModelAPI_Feature>(data()->reference(SKETCH_ID())->value());
+    if(aFeature.get()) {
       return aFeature->data()->featureId();
+    }
   }
+
   return -1;
 }
 
 //=================================================================================================
 bool FeaturesPlugin_CompositeSketch::isSub(ObjectPtr theObject) const
 {
-  // check is this feature of result
+  bool isSubFeature = false;
+  // Check is this feature of result
   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
-  if (!aFeature)
-    return false;
-  ObjectPtr aSub = data()->reference(SKETCH_OBJECT_ID())->value();
-  return aSub == theObject;
+  if (aFeature.get()) {
+    ObjectPtr aSub = data()->reference(SKETCH_ID())->value();
+    isSubFeature = aSub == theObject;
+  }
+  return isSubFeature;
 }
 
 //=================================================================================================
 void FeaturesPlugin_CompositeSketch::removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature)
 {
-  AttributeSelectionListPtr aFacesSelectionList = selectionList(LIST_ID());
-  if (aFacesSelectionList.get() && aFacesSelectionList->size() > 0)
-    aFacesSelectionList->clear();
+  AttributeSelectionListPtr aBaseObjectsSelectionList = selectionList(BASE_OBJECTS_ID());
+  if(aBaseObjectsSelectionList.get() && aBaseObjectsSelectionList->size() > 0) {
+    aBaseObjectsSelectionList->clear();
+  }
+
+  reference(SKETCH_ID())->setValue(ObjectPtr());
 }
 
 //=================================================================================================
-void FeaturesPlugin_CompositeSketch::erase()
+void FeaturesPlugin_CompositeSketch::getBaseShapes(ListOfShape& theBaseShapesList,
+                                                   const bool theIsMakeShells)
 {
-  if (data().get() && data()->isValid()) { // on abort of sketch of this composite it may be invalid
-    FeaturePtr aSketch =
-      std::dynamic_pointer_cast<ModelAPI_Feature>(data()->reference(SKETCH_OBJECT_ID())->value());
-    if (aSketch.get() && aSketch->data()->isValid()) {
-      document()->removeFeature(aSketch);
-    }
-  }
-  ModelAPI_CompositeFeature::erase();
+  AttributeSelectionListPtr aBaseObjectsSelectionList = selectionList(BASE_OBJECTS_ID());
+  std::string anError;
+  bool isOk = FeaturesPlugin_Tools::getShape(
+      aBaseObjectsSelectionList, theIsMakeShells, theBaseShapesList, anError);
+  if (!isOk)
+    setError(anError);
 }
 
+//=================================================================================================
+void FeaturesPlugin_CompositeSketch::storeResult(const GeomShapePtr theBaseShape,
+                                        const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
+                                        const int theIndex)
+{
+  // Create result body.
+  ResultBodyPtr aResultBody = document()->createBody(data(), theIndex);
+
+  // Store generated shape.
+  aResultBody->storeGenerated(theBaseShape, theMakeShape->shape());
+
+  // Store generated edges/faces.
+  storeGenerationHistory(aResultBody, theBaseShape, theMakeShape);
+
+  setResult(aResultBody, theIndex);
+}
 
 //=================================================================================================
-void FeaturesPlugin_CompositeSketch::execute()
+void FeaturesPlugin_CompositeSketch::storeGenerationHistory(ResultBodyPtr theResultBody,
+                                        const GeomShapePtr theBaseShape,
+                                        const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape)
 {
-  // Getting faces to create solids.
-  std::shared_ptr<ModelAPI_Feature> aSketchFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
-                                                     reference(SKETCH_OBJECT_ID())->value());
-  if(!aSketchFeature || aSketchFeature->results().empty()) {
-    return;
-  }
-  ResultPtr aSketchRes = aSketchFeature->results().front();
-  ResultConstructionPtr aConstruction = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(aSketchRes);
-  if(!aConstruction.get()) {
-    return;
-  }
+  GeomAPI_Shape::ShapeType aBaseShapeType = theBaseShape->shapeType();
+  GeomAPI_Shape::ShapeType aShapeTypeToExplode = GeomAPI_Shape::SHAPE;
 
-  /// feature extrusion does not have the next attribute
-  if (data()->attribute(SKETCH_SELECTION_ID()).get()) {
-    if (!selection(SKETCH_SELECTION_ID())->isInitialized() || selection(SKETCH_SELECTION_ID())->context() != aSketchRes) {
-      selection(SKETCH_SELECTION_ID())->setValue(aSketchRes, std::shared_ptr<GeomAPI_Shape>());
+  switch(aBaseShapeType) {
+    case GeomAPI_Shape::EDGE: {
+            aShapeTypeToExplode = GeomAPI_Shape::VERTEX;
+      break;
+    }
+    case GeomAPI_Shape::WIRE: {
+      aShapeTypeToExplode = GeomAPI_Shape::COMPOUND;
+      break;
     }
+    case GeomAPI_Shape::FACE:
+    case GeomAPI_Shape::SHELL: {
+      aShapeTypeToExplode = GeomAPI_Shape::EDGE;
+      break;
+    }
+    case GeomAPI_Shape::COMPOUND: {
+      aShapeTypeToExplode = GeomAPI_Shape::COMPOUND;
+    }
+    default: // [to avoid compilation warnings]
+      break;
   }
-  int aSketchFacesNum = aConstruction->facesNum();
-  if(aSketchFacesNum == 0) {
-    return;
+
+  if(aShapeTypeToExplode == GeomAPI_Shape::VERTEX ||
+      aShapeTypeToExplode == GeomAPI_Shape::COMPOUND) {
+    theResultBody->loadGeneratedShapes(theMakeShape, theBaseShape, GeomAPI_Shape::VERTEX);
   }
-  ListOfShape aFacesList;
-  for(int aFaceIndex = 0; aFaceIndex < aSketchFacesNum; aFaceIndex++) {
-    std::shared_ptr<GeomAPI_Shape> aFace = std::dynamic_pointer_cast<GeomAPI_Shape>(aConstruction->face(aFaceIndex));
-    aFacesList.push_back(aFace);
+  if(aShapeTypeToExplode == GeomAPI_Shape::EDGE ||
+      aShapeTypeToExplode == GeomAPI_Shape::COMPOUND) {
+    theResultBody->loadGeneratedShapes(theMakeShape, theBaseShape, GeomAPI_Shape::EDGE);
   }
-
-  // Searching faces with common edges.
-  ListOfShape aShells;
-  ListOfShape aFreeFaces;
-  std::shared_ptr<GeomAPI_Shape> aFacesCompound = GeomAlgoAPI_CompoundBuilder::compound(aFacesList);
-  GeomAlgoAPI_ShapeTools::combineShapes(aFacesCompound, GeomAPI_Shape::SHELL, aShells, aFreeFaces);
-  aShells.insert(aShells.end(), aFreeFaces.begin(), aFreeFaces.end());
-
-  // Generating result for each shell and face.
-  int aErrorsNum = 0;
-  int aResultIndex = 0;
-  for(ListOfShape::const_iterator anIter = aShells.cbegin(); anIter != aShells.cend(); anIter++) {
-    std::shared_ptr<GeomAlgoAPI_MakeShape> aMakeShape;
-
-    std::shared_ptr<GeomAPI_Shape> aBaseFace = *anIter;
-    makeSolid(aBaseFace, aMakeShape);
-    if(!aMakeShape.get()) {
-      aErrorsNum++;
-      continue;
+  std::list<std::shared_ptr<GeomAlgoAPI_MakeSweep> > aSweeps; // all sweeps collected
+  std::shared_ptr<GeomAlgoAPI_MakeSweep> aMakeSweep =
+    std::dynamic_pointer_cast<GeomAlgoAPI_MakeSweep>(theMakeShape);
+  if(aMakeSweep.get()) {
+    aSweeps.push_back(aMakeSweep);
+  } else {
+    std::shared_ptr<GeomAlgoAPI_MakeShapeList> aMakeList =
+      std::dynamic_pointer_cast<GeomAlgoAPI_MakeShapeList>(theMakeShape);
+    if (aMakeList.get()) {
+      ListOfMakeShape::const_iterator anIter = aMakeList->list().cbegin();
+      for(; anIter != aMakeList->list().cend(); anIter++) {
+        std::shared_ptr<GeomAlgoAPI_MakeSweep> aSweep =
+          std::dynamic_pointer_cast<GeomAlgoAPI_MakeSweep>(*anIter);
+        if (aSweep.get())
+          aSweeps.push_back(aSweep);
+      }
     }
-
-    ResultBodyPtr aResultBody = document()->createBody(data(), aResultIndex);
-    loadNamingDS(aResultBody, aBaseFace, aMakeShape);
-    setResult(aResultBody, aResultIndex);
-    aResultIndex++;
   }
+  std::list<std::shared_ptr<GeomAlgoAPI_MakeSweep> >::iterator aSweep = aSweeps.begin();
+  for(; aSweep != aSweeps.end(); aSweep++) {
+    // Store from shapes.
+    storeShapes(theMakeShape, theResultBody, aBaseShapeType, (*aSweep)->fromShapes(), "From_");
 
-  if(aErrorsNum > 0) {
-    std::ostringstream aStringStream;
-    aStringStream << "Error: Could not create solid(s) from " << aErrorsNum << " face(s).";
-    setError(aStringStream.str());
+    // Store to shapes.
+    storeShapes(theMakeShape, theResultBody, aBaseShapeType, (*aSweep)->toShapes(), "To_");
   }
-
-  // Remove the rest results if there were produced in the previous pass.
-  removeResults(aResultIndex);
 }
 
 //=================================================================================================
-void FeaturesPlugin_CompositeSketch::loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
-                                                  const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
-                                                  const std::shared_ptr<GeomAlgoAPI_MakeShape>& theMakeShape)
+void FeaturesPlugin_CompositeSketch::storeShapes(
+  const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
+  ResultBodyPtr theResultBody,
+  const GeomAPI_Shape::ShapeType theBaseShapeType,
+  const ListOfShape& theShapes,
+  const std::string theName)
 {
-  //load result
-  theResultBody->storeGenerated(theBaseShape, theMakeShape->shape());
-
-  //Insert lateral face : Face from Edge
-  const std::string aLatName = "LateralFace";
-  const int aLatTag = 1;
-  std::shared_ptr<GeomAPI_DataMapOfShapeShape> aDataMap = theMakeShape->mapOfSubShapes();
-  theResultBody->loadAndOrientGeneratedShapes(theMakeShape.get(), theBaseShape, GeomAPI_Shape::EDGE, aLatTag, aLatName, *aDataMap.get());
-
-  std::shared_ptr<GeomAlgoAPI_MakeSweep> aSweepAlgo = std::dynamic_pointer_cast<GeomAlgoAPI_MakeSweep>(theMakeShape);
-  if(aSweepAlgo.get()) {
-    //Insert to faces
-    int aToFaceIndex = 1;
-    const std::string aToName = "ToFace";
-    int aToTag = 2;
-    const ListOfShape& aToFaces = aSweepAlgo->toShapes();
-    for(ListOfShape::const_iterator anIt = aToFaces.cbegin(); anIt != aToFaces.cend(); anIt++) {
-      std::shared_ptr<GeomAPI_Shape> aToFace = *anIt;
-      if(aDataMap->isBound(aToFace)) {
-        aToFace = aDataMap->find(aToFace);
-      }
-      std::ostringstream aStr;
-      aStr << aToName << "_" << aToFaceIndex++;
-      theResultBody->generated(aToFace, aStr.str(), aToTag++);
+  GeomAPI_Shape::ShapeType aShapeTypeToExplore = GeomAPI_Shape::FACE;
+  std::string aShapeTypeStr = "Face";
+  switch(theBaseShapeType) {
+    case GeomAPI_Shape::VERTEX: {
+      aShapeTypeToExplore = GeomAPI_Shape::VERTEX;
+      aShapeTypeStr = "Vertex";
+      break;
     }
+    case GeomAPI_Shape::EDGE:
+    case GeomAPI_Shape::WIRE: {
+      aShapeTypeToExplore = GeomAPI_Shape::EDGE;
+      aShapeTypeStr = "Edge";
+      break;
+    }
+    case GeomAPI_Shape::FACE:
+    case GeomAPI_Shape::SHELL: {
+      aShapeTypeToExplore = GeomAPI_Shape::FACE;
+      aShapeTypeStr = "Face";
+      break;
+    }
+    case GeomAPI_Shape::COMPOUND: {
+      aShapeTypeToExplore = GeomAPI_Shape::COMPOUND;
+      break;
+    }
+    default: // [to avoid compilation warnings]
+      break;
+  }
+
+  // Store shapes.
+  for(ListOfShape::const_iterator anIt = theShapes.cbegin(); anIt != theShapes.cend(); ++anIt) {
+    GeomShapePtr aShape = *anIt;
 
-    //Insert from faces
-    int aFromFaceIndex = 1;
-    const std::string aFromName = "FromFace";
-    int aFromTag = aToTag > 10000 ? aToTag : 10000;
-    const ListOfShape& aFromFaces = aSweepAlgo->fromShapes();
-    for(ListOfShape::const_iterator anIt = aFromFaces.cbegin(); anIt != aFromFaces.cend(); anIt++) {
-      std::shared_ptr<GeomAPI_Shape> aFromFace = *anIt;
-      if(aDataMap->isBound(aFromFace)) {
-        aFromFace = aDataMap->find(aFromFace);
+    if(aShapeTypeToExplore == GeomAPI_Shape::COMPOUND) {
+      std::string aName = theName + (aShape->shapeType() == GeomAPI_Shape::EDGE ? "Edge" : "Face");
+      storeSubShape(theMakeShape, theResultBody, aShape, aShape->shapeType(), aName);
+    } else {
+      std::string aName = theName + aShapeTypeStr;
+      storeSubShape(theMakeShape, theResultBody, aShape, aShapeTypeToExplore, aName);
+      if (theBaseShapeType == GeomAPI_Shape::WIRE) { // issue 2289: special names also for vertices
+        aName = theName + "Vertex";
+        storeSubShape(theMakeShape, theResultBody, aShape, GeomAPI_Shape::VERTEX, aName);
       }
-      std::ostringstream aStr;
-      aStr << aFromName << "_" << aFromFaceIndex++;
-      theResultBody->generated(aFromFace, aStr.str(), aFromTag++);
     }
   }
 }
-//=================================================================================================
-void FeaturesPlugin_CompositeSketch::setSketchObjectToList()
+
+void storeSubShape(
+  const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
+  ResultBodyPtr theResultBody,
+  const GeomShapePtr theShape,
+  const GeomAPI_Shape::ShapeType theType,
+  const std::string& theName)
 {
-  std::shared_ptr<ModelAPI_Feature> aSketchFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
-                                                       reference(SKETCH_OBJECT_ID())->value());
-
-  if(aSketchFeature.get() && !aSketchFeature->results().empty()) {
-    ResultPtr aSketchRes = aSketchFeature->results().front();
-    ResultConstructionPtr aConstruction = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(aSketchRes);
-    if(aConstruction.get()) {
-      AttributeSelectionListPtr aFacesSelectionList = selectionList(LIST_ID());
-      if (aFacesSelectionList.get() && aFacesSelectionList->size() == 0)
-        aFacesSelectionList->append(aSketchRes, std::shared_ptr<GeomAPI_Shape>());
+  for(GeomAPI_ShapeExplorer anExp(theShape, theType); anExp.more(); anExp.next()) {
+    GeomShapePtr aSubShape = anExp.current();
+    if (!theResultBody->generated(aSubShape, theName)) {
+      int aNbSubs = theResultBody->numberOfSubs();
+      if (aNbSubs > 0) {
+        // check the modified shape is in the result body, don't store it if not
+        ListOfShape aNewShapes;
+        theMakeShape->modified(aSubShape, aNewShapes);
+        for (int i = 0; i < aNbSubs; ++i) {
+          ResultBodyPtr aSubRes = theResultBody->subResult(i);
+          GeomShapePtr aShape = aSubRes->shape();
+          ListOfShape::iterator aNewIt = aNewShapes.begin();
+          for (; aNewIt != aNewShapes.end(); ++aNewIt)
+            if (aShape->isSubShape(*aNewIt, false))
+              break;
+          if (aNewIt != aNewShapes.end()) {
+            // store from/to shapes as primitives and then store modification of them by the boolean
+            aSubRes->generated(aSubShape, theName, false);
+            aSubRes->loadModifiedShapes(theMakeShape, aSubShape, theType);
+          }
+        }
+      }
+      else {
+        // store from/to shapes as primitives and then store modification of them by the boolean
+        theResultBody->generated(aSubShape, theName, false);
+        theResultBody->loadModifiedShapes(theMakeShape, aSubShape, theType);
+      }
     }
   }
 }
-