1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #include <FeaturesPlugin_CompositeSketch.h>
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>
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>
36 #include <GeomAPI_PlanarEdges.h>
37 #include <GeomAPI_ShapeExplorer.h>
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);
48 //=================================================================================================
49 void FeaturesPlugin_CompositeSketch::initCompositeSketchAttribtues(const int theInitFlags)
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());
57 // Initialize selection list.
58 if(theInitFlags & InitBaseObjectsList) {
59 data()->addAttribute(BASE_OBJECTS_ID(), ModelAPI_AttributeSelectionList::typeId());
63 //=================================================================================================
64 std::shared_ptr<ModelAPI_Feature> FeaturesPlugin_CompositeSketch::addFeature(std::string theID)
66 FeaturePtr aNew = document()->addFeature(theID, false);
68 data()->reference(SKETCH_ID())->setValue(aNew);
71 // Set as current also after it becomes sub to set correctly enabled for other sketch subs.
72 document()->setCurrentFeature(aNew, false);
76 //=================================================================================================
77 int FeaturesPlugin_CompositeSketch::numberOfSubs(bool forTree) const
79 ObjectPtr aObj = data()->reference(SKETCH_ID())->value();
80 return aObj.get() ? 1 : 0;
83 //=================================================================================================
84 std::shared_ptr<ModelAPI_Feature> FeaturesPlugin_CompositeSketch::subFeature(const int theIndex,
88 return std::dynamic_pointer_cast<ModelAPI_Feature>(data()->reference(SKETCH_ID())->value());
91 return std::shared_ptr<ModelAPI_Feature>();
94 //=================================================================================================
95 int FeaturesPlugin_CompositeSketch::subFeatureId(const int theIndex) const
99 std::dynamic_pointer_cast<ModelAPI_Feature>(data()->reference(SKETCH_ID())->value());
101 return aFeature->data()->featureId();
108 //=================================================================================================
109 bool FeaturesPlugin_CompositeSketch::isSub(ObjectPtr theObject) const
111 // Check is this feature of result
112 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
113 if(!aFeature.get()) {
117 ObjectPtr aSub = data()->reference(SKETCH_ID())->value();
118 return aSub == theObject;
121 //=================================================================================================
122 void FeaturesPlugin_CompositeSketch::removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature)
124 AttributeSelectionListPtr aBaseObjectsSelectionList = selectionList(BASE_OBJECTS_ID());
125 if(aBaseObjectsSelectionList.get() && aBaseObjectsSelectionList->size() > 0) {
126 aBaseObjectsSelectionList->clear();
129 reference(SKETCH_ID())->setValue(ObjectPtr());
132 //=================================================================================================
133 void FeaturesPlugin_CompositeSketch::getBaseShapes(ListOfShape& theBaseShapesList,
134 const bool theIsMakeShells)
136 theBaseShapesList.clear();
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.");
145 if(aBaseObjectsSelectionList->size() == 0) {
146 setError("Error: Base objects list is empty.");
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.");
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.");
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);
170 aST == GeomAPI_Shape::FACE ? aBaseFacesList.push_back(aBaseShape) :
171 theBaseShapesList.push_back(aBaseShape);
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.");
181 int aFacesNum = aConstruction->facesNum();
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.");
193 aST == GeomAPI_Shape::FACE ? aBaseFacesList.push_back(aBaseShape) :
194 theBaseShapesList.push_back(aBaseShape);
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.");
203 aBaseFacesList.push_back(aBaseFace);
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;
216 GeomAlgoAPI_ShapeTools::makeFacesWithHoles(aSketchPlanarEdges->origin(),
217 aSketchPlanarEdges->norm(),
220 aBaseFacesList.insert(aBaseFacesList.end(), aFaces.begin(), aFaces.end());
223 // Searching faces with common edges.
224 if(theIsMakeShells && aBaseFacesList.size() > 1) {
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());
233 theBaseShapesList.insert(theBaseShapesList.end(), aBaseFacesList.begin(),
234 aBaseFacesList.end());
238 //=================================================================================================
239 bool FeaturesPlugin_CompositeSketch::isMakeShapeValid(
240 const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape)
242 // Check that algo is done.
243 if(!theMakeShape->isDone()) {
244 setError("Error: " + getKind() + " algorithm failed.");
248 // Check if shape is not null.
249 if(!theMakeShape->shape().get() || theMakeShape->shape()->isNull()) {
250 setError("Error: Resulting shape is null.");
254 // Check that resulting shape is valid.
255 if(!theMakeShape->isValid()) {
256 setError("Error: Resulting shape is not valid.");
263 //=================================================================================================
264 void FeaturesPlugin_CompositeSketch::storeResult(const GeomShapePtr theBaseShape,
265 const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
268 // Create result body.
269 ResultBodyPtr aResultBody = document()->createBody(data(), theIndex);
271 // Store generated shape.
272 aResultBody->storeGenerated(theBaseShape, theMakeShape->shape());
274 // Store generated edges/faces.
275 storeGenerationHistory(aResultBody, theBaseShape, theMakeShape);
277 setResult(aResultBody, theIndex);
280 //=================================================================================================
281 void FeaturesPlugin_CompositeSketch::storeGenerationHistory(ResultBodyPtr theResultBody,
282 const GeomShapePtr theBaseShape,
283 const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape)
285 GeomAPI_Shape::ShapeType aBaseShapeType = theBaseShape->shapeType();
286 GeomAPI_Shape::ShapeType aShapeTypeToExplode = GeomAPI_Shape::SHAPE;
288 switch(aBaseShapeType) {
289 case GeomAPI_Shape::EDGE: {
290 aShapeTypeToExplode = GeomAPI_Shape::VERTEX;
293 case GeomAPI_Shape::WIRE: {
294 aShapeTypeToExplode = GeomAPI_Shape::COMPOUND;
297 case GeomAPI_Shape::FACE:
298 case GeomAPI_Shape::SHELL: {
299 aShapeTypeToExplode = GeomAPI_Shape::EDGE;
302 case GeomAPI_Shape::COMPOUND: {
303 aShapeTypeToExplode = GeomAPI_Shape::COMPOUND;
307 int aLateralIndex = 1;
308 int aBaseEdgeIndex = 1;
309 int aVertexIndex = 1;
310 int aBaseVertexIndex = 1;
312 if(aShapeTypeToExplode == GeomAPI_Shape::VERTEX ||
313 aShapeTypeToExplode == GeomAPI_Shape::COMPOUND) {
314 theResultBody->loadGeneratedShapes(theMakeShape, theBaseShape, GeomAPI_Shape::VERTEX);
316 if(aShapeTypeToExplode == GeomAPI_Shape::EDGE ||
317 aShapeTypeToExplode == GeomAPI_Shape::COMPOUND) {
318 theResultBody->loadGeneratedShapes(theMakeShape, theBaseShape, GeomAPI_Shape::EDGE);
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);
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);
334 aSweeps.push_back(aSweep);
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_");
344 storeShapes(theMakeShape, theResultBody, aBaseShapeType, (*aSweep)->toShapes(), "To_");
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)
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";
364 case GeomAPI_Shape::EDGE:
365 case GeomAPI_Shape::WIRE: {
366 aShapeTypeToExplore = GeomAPI_Shape::EDGE;
367 aShapeTypeStr = "Edge";
370 case GeomAPI_Shape::FACE:
371 case GeomAPI_Shape::SHELL: {
372 aShapeTypeToExplore = GeomAPI_Shape::FACE;
373 aShapeTypeStr = "Face";
376 case GeomAPI_Shape::COMPOUND: {
377 aShapeTypeToExplore = GeomAPI_Shape::COMPOUND;
383 for(ListOfShape::const_iterator anIt = theShapes.cbegin(); anIt != theShapes.cend(); ++anIt) {
384 GeomShapePtr aShape = *anIt;
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);
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);
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)
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);