1 // Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #include <GEOMImpl_BooleanDriver.hxx>
24 #include <GEOMImpl_IBoolean.hxx>
25 #include <GEOMImpl_Types.hxx>
26 #include <GEOMImpl_GlueDriver.hxx>
27 #include <GEOM_Function.hxx>
28 #include <GEOMUtils.hxx>
29 #include <BlockFix_BlockFixAPI.hxx>
30 #include <ShHealOper_ShapeProcess.hxx>
32 #include <TNaming_CopyShape.hxx>
34 #include <BRep_Builder.hxx>
35 #include <BRepAlgoAPI_Common.hxx>
36 #include <BRepAlgoAPI_Cut.hxx>
37 #include <BRepAlgoAPI_Fuse.hxx>
38 #include <BRepAlgoAPI_Section.hxx>
39 #include <BOPAlgo_CheckerSI.hxx>
40 #include <BOPDS_DS.hxx>
41 #include <BOPTools_AlgoTools.hxx>
43 #include <TopExp_Explorer.hxx>
44 #include <TopoDS_Compound.hxx>
45 #include <TopoDS_Iterator.hxx>
46 #include <TopTools_MapOfShape.hxx>
47 #include <TopTools_ListOfShape.hxx>
48 #include <TopTools_ListIteratorOfListOfShape.hxx>
50 #include <TColStd_IndexedDataMapOfTransientTransient.hxx>
52 #include <Precision.hxx>
54 #include <Standard_ConstructionError.hxx>
55 #include <StdFail_NotDone.hxx>
57 // Depth of self-intersection check (see BOPAlgo_CheckerSI::SetLevelOfCheck() for more details)
58 // Default value for BOPAlgo_CheckerSI gives very long computation when checking face-to-face intersections;
59 // here check level is decreased to more appropriate value to avoid problems with performance).
60 #define BOP_SELF_INTERSECTIONS_LEVEL 4
63 * This function performs extra edges removal.
65 * \param theShape the shape to be processed.
66 * \return the modified shape or null shape in case of failure.
68 static TopoDS_Shape RemoveExtraEdges(const TopoDS_Shape &theShape)
72 if (!theShape.IsNull()) {
73 BlockFix_BlockFixAPI aTool;
75 aTool.OptimumNbFaces() = 0;
76 aTool.SetShape(theShape);
78 TopoDS_Shape aShape = aTool.Shape();
80 if (GEOMUtils::CheckShape(aShape)) {
85 ShHealOper_ShapeProcess aHealer;
86 aHealer.Perform(aShape, aFixed);
87 if (aHealer.isDone() && GEOMUtils::CheckShape(aFixed))
95 //=======================================================================
98 //=======================================================================
99 const Standard_GUID& GEOMImpl_BooleanDriver::GetID()
101 static Standard_GUID aBooleanDriver("FF1BBB21-5D14-4df2-980B-3A668264EA16");
102 return aBooleanDriver;
105 //=======================================================================
106 //function : GEOMImpl_BooleanDriver
108 //=======================================================================
109 GEOMImpl_BooleanDriver::GEOMImpl_BooleanDriver()
113 //=======================================================================
116 //=======================================================================
117 Standard_Integer GEOMImpl_BooleanDriver::Execute(LOGBOOK& log) const
119 if (Label().IsNull()) return 0;
120 Handle(GEOM_Function) aFunction = GEOM_Function::GetFunction(Label());
122 GEOMImpl_IBoolean aCI (aFunction);
123 Standard_Integer aType = aFunction->GetType();
124 const Standard_Boolean isCheckSelfInte = aCI.GetCheckSelfIntersection();
125 const Standard_Boolean isRmExtraEdges = aCI.GetRmExtraEdges();
133 case BOOLEAN_SECTION:
135 Handle(GEOM_Function) aRefShape1 = aCI.GetShape1();
136 Handle(GEOM_Function) aRefShape2 = aCI.GetShape2();
137 TopoDS_Shape aShape1 = aRefShape1->GetValue();
138 TopoDS_Shape aShape2 = aRefShape2->GetValue();
140 if (!aShape1.IsNull() && !aShape2.IsNull()) {
141 // check arguments for Mantis issue 0021019
142 if (!GEOMUtils::CheckShape(aShape1, true) || !GEOMUtils::CheckShape(aShape2, true))
143 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is not valid");
145 if (isCheckSelfInte) {
146 BOPAlgo_CheckerSI aCSI; // checker of self-interferences
147 aCSI.SetLevelOfCheck(BOP_SELF_INTERSECTIONS_LEVEL);
148 BOPCol_ListOfShape aList1, aList2;
149 aList1.Append(aShape1);
150 aList2.Append(aShape2);
151 aCSI.SetArguments(aList1);
153 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0)
154 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
155 aCSI.SetArguments(aList2);
157 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0)
158 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
161 // Make a copy to prevent the original shape changes.
162 TopoDS_Shape aShapeCopy1;
163 TopoDS_Shape aShapeCopy2;
164 TColStd_IndexedDataMapOfTransientTransient aMapTShapes;
165 TNaming_CopyShape::CopyTool(aShape1, aMapTShapes, aShapeCopy1);
166 TNaming_CopyShape::CopyTool(aShape2, aMapTShapes, aShapeCopy2);
168 aShape = performOperation (aShapeCopy1, aShapeCopy2, aType);
170 if (isRmExtraEdges) {
171 aShape = RemoveExtraEdges(aShape);
174 if (aShape.IsNull()) {
180 case BOOLEAN_COMMON_LIST:
181 case BOOLEAN_FUSE_LIST:
183 Handle(TColStd_HSequenceOfTransient) aShapes = aCI.GetShapes();
184 const Standard_Integer nbShapes = aShapes->Length();
186 Handle(GEOM_Function) aRefShape;
187 TopoDS_Shape aShape2;
188 Standard_Integer aSimpleType =
189 (aType == BOOLEAN_FUSE_LIST ? BOOLEAN_FUSE : BOOLEAN_COMMON);
192 aRefShape = Handle(GEOM_Function)::DownCast(aShapes->Value(1));
193 aShape = aRefShape->GetValue();
195 if (!aShape.IsNull()) {
196 // check arguments for Mantis issue 0021019
197 if (!GEOMUtils::CheckShape(aShape, true))
198 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is not valid");
200 BOPAlgo_CheckerSI aCSI; // checker of self-interferences
202 if (isCheckSelfInte) {
203 aCSI.SetLevelOfCheck(BOP_SELF_INTERSECTIONS_LEVEL);
204 BOPCol_ListOfShape aList1;
205 aList1.Append(aShape);
206 aCSI.SetArguments(aList1);
208 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0) {
209 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
214 TopoDS_Shape aShapeCopy;
215 TColStd_IndexedDataMapOfTransientTransient aMapTShapes;
217 TNaming_CopyShape::CopyTool(aShape, aMapTShapes, aShapeCopy);
220 for (i = 2; i <= nbShapes; i++) {
221 aRefShape = Handle(GEOM_Function)::DownCast(aShapes->Value(i));
222 aShape2 = aRefShape->GetValue();
224 if (!GEOMUtils::CheckShape(aShape2, true))
225 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is not valid");
227 if (isCheckSelfInte) {
228 BOPCol_ListOfShape aList2;
229 aList2.Append(aShape2);
230 aCSI.SetArguments(aList2);
232 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0) {
233 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
238 aShapeCopy.Nullify();
239 TNaming_CopyShape::CopyTool(aShape2, aMapTShapes, aShapeCopy);
240 aShape = performOperation (aShape, aShapeCopy, aSimpleType);
242 if (isRmExtraEdges) {
243 aShape = RemoveExtraEdges(aShape);
246 if (aShape.IsNull()) {
254 case BOOLEAN_CUT_LIST:
256 Handle(GEOM_Function) aRefObject = aCI.GetShape1();
258 aShape = aRefObject->GetValue();
260 if (!aShape.IsNull()) {
261 // check arguments for Mantis issue 0021019
262 if (!GEOMUtils::CheckShape(aShape, true))
263 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is not valid");
265 BOPAlgo_CheckerSI aCSI; // checker of self-interferences
267 if (isCheckSelfInte) {
268 aCSI.SetLevelOfCheck(BOP_SELF_INTERSECTIONS_LEVEL);
269 BOPCol_ListOfShape aList1;
270 aList1.Append(aShape);
271 aCSI.SetArguments(aList1);
273 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0) {
274 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
279 TopoDS_Shape aShapeCopy;
280 TColStd_IndexedDataMapOfTransientTransient aMapTShapes;
282 TNaming_CopyShape::CopyTool(aShape, aMapTShapes, aShapeCopy);
285 Handle(TColStd_HSequenceOfTransient) aTools = aCI.GetShapes();
286 const Standard_Integer nbShapes = aTools->Length();
288 Handle(GEOM_Function) aRefTool;
291 for (i = 1; i <= nbShapes; i++) {
292 aRefTool = Handle(GEOM_Function)::DownCast(aTools->Value(i));
293 aTool = aRefTool->GetValue();
295 if (!GEOMUtils::CheckShape(aTool, true))
296 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is not valid");
298 if (isCheckSelfInte) {
299 BOPCol_ListOfShape aList2;
300 aList2.Append(aTool);
301 aCSI.SetArguments(aList2);
303 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0) {
304 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
309 aShapeCopy.Nullify();
310 TNaming_CopyShape::CopyTool(aTool, aMapTShapes, aShapeCopy);
311 aShape = performOperation (aShape, aShapeCopy, BOOLEAN_CUT);
313 if (aShape.IsNull()) {
324 aFunction->SetValue(aShape);
326 #if OCC_VERSION_MAJOR < 7
327 log.SetTouched(Label());
329 log->SetTouched(Label());
335 //=======================================================================
336 //function : makeCompoundShellFromFaces
338 //=======================================================================
339 TopoDS_Shape GEOMImpl_BooleanDriver::makeCompoundShellFromFaces
340 (const TopoDS_Shape theShape)const
342 if (theShape.ShapeType() != TopAbs_COMPOUND)
345 BOPCol_ListOfShape aListShapes;
346 BOPTools_AlgoTools::MakeConnexityBlocks(theShape, TopAbs_EDGE, TopAbs_FACE, aListShapes);
348 if (aListShapes.IsEmpty())
351 TopoDS_Compound aResult;
353 B.MakeCompound(aResult);
354 TopExp_Explorer aExp;
355 BOPCol_ListIteratorOfListOfShape anIter(aListShapes);
357 for (; anIter.More(); anIter.Next()) {
360 TopoDS_Shape aShapeFromFaces = anIter.Value();
361 aExp.Init(aShapeFromFaces, TopAbs_FACE);
362 for (; aExp.More(); aExp.Next()) {
363 const TopoDS_Shape& aFace = aExp.Current();
364 B.Add(aShell, aFace);
366 if (!aShell.IsNull()) {
367 BOPTools_AlgoTools::OrientFacesOnShell(aShell);
368 B.Add(aResult, aShell);
371 B.Add(aResult, aShapeFromFaces);
376 //=======================================================================
377 //function : performOperation
379 //=======================================================================
380 TopoDS_Shape GEOMImpl_BooleanDriver::performOperation
381 (const TopoDS_Shape theShape1,
382 const TopoDS_Shape theShape2,
383 const Standard_Integer theType)const
387 // perform COMMON operation
388 if (theType == BOOLEAN_COMMON) {
393 TopTools_ListOfShape listShape1, listShape2;
394 GEOMUtils::AddSimpleShapes(theShape1, listShape1);
395 GEOMUtils::AddSimpleShapes(theShape2, listShape2);
397 Standard_Boolean isCompound =
398 (listShape1.Extent() > 1 || listShape2.Extent() > 1);
400 TopTools_ListIteratorOfListOfShape itSub1 (listShape1);
401 for (; itSub1.More(); itSub1.Next()) {
402 TopoDS_Shape aValue1 = itSub1.Value();
403 TopTools_ListIteratorOfListOfShape itSub2 (listShape2);
404 for (; itSub2.More(); itSub2.Next()) {
405 TopoDS_Shape aValue2 = itSub2.Value();
406 BRepAlgoAPI_Common BO (aValue1, aValue2);
408 StdFail_NotDone::Raise("Common operation can not be performed on the given shapes");
411 TopoDS_Shape aStepResult = BO.Shape();
413 // check result of this step: if it is a compound (boolean operations
414 // allways return a compound), we add all sub-shapes of it.
415 // This allows to avoid adding empty compounds,
416 // resulting from COMMON on two non-intersecting shapes.
417 if (aStepResult.ShapeType() == TopAbs_COMPOUND) {
418 #if OCC_VERSION_MAJOR >= 7
419 if (aValue1.ShapeType() == TopAbs_FACE && aValue2.ShapeType() == TopAbs_FACE) {
420 aStepResult = makeCompoundShellFromFaces(aStepResult);
423 TopoDS_Iterator aCompIter (aStepResult);
424 for (; aCompIter.More(); aCompIter.Next()) {
425 // add shape in a result
426 B.Add(C, aCompIter.Value());
430 // add shape in a result
431 B.Add(C, aStepResult);
440 // As GlueFaces has been improved to keep all kind of shapes
441 TopExp_Explorer anExp (C, TopAbs_VERTEX);
443 aShape = GEOMImpl_GlueDriver::GlueFaces(C, Precision::Confusion(), Standard_True);
449 // perform CUT operation
450 else if (theType == BOOLEAN_CUT) {
455 TopTools_ListOfShape listShapes, listTools;
456 GEOMUtils::AddSimpleShapes(theShape1, listShapes);
457 GEOMUtils::AddSimpleShapes(theShape2, listTools);
459 Standard_Boolean isCompound = (listShapes.Extent() > 1);
461 TopTools_ListIteratorOfListOfShape itSub1 (listShapes);
462 for (; itSub1.More(); itSub1.Next()) {
463 TopoDS_Shape aCut = itSub1.Value();
465 TopTools_ListIteratorOfListOfShape itSub2 (listTools);
466 for (; itSub2.More(); itSub2.Next()) {
467 TopoDS_Shape aTool = itSub2.Value();
468 BRepAlgoAPI_Cut BO (aCut, aTool);
470 StdFail_NotDone::Raise("Cut operation can not be performed on the given shapes");
475 // check result of this step: if it is a compound (boolean operations
476 // allways return a compound), we add all sub-shapes of it.
477 // This allows to avoid adding empty compounds,
478 // resulting from CUT of parts
479 if (aCut.ShapeType() == TopAbs_COMPOUND) {
480 #if OCC_VERSION_MAJOR >= 7
481 if (itSub1.Value().ShapeType() == TopAbs_FACE) {
482 aCut = makeCompoundShellFromFaces(aCut);
485 TopoDS_Iterator aCompIter (aCut);
486 for (; aCompIter.More(); aCompIter.Next()) {
487 // add shape in a result
488 B.Add(C, aCompIter.Value());
492 // add shape in a result
501 // As GlueFaces has been improved to keep all kind of shapes
502 TopExp_Explorer anExp (C, TopAbs_VERTEX);
504 aShape = GEOMImpl_GlueDriver::GlueFaces(C, Precision::Confusion(), Standard_True);
510 // perform FUSE operation
511 else if (theType == BOOLEAN_FUSE) {
512 #if OCC_VERSION_MAJOR >= 7
513 Standard_Boolean isFaces = Standard_False;
514 TopTools_ListOfShape listShape1, listShape2;
515 GEOMUtils::AddSimpleShapes(theShape1, listShape1);
516 GEOMUtils::AddSimpleShapes(theShape2, listShape2);
518 TopTools_ListIteratorOfListOfShape itSub1 (listShape1);
519 for (; itSub1.More(); itSub1.Next()) {
520 TopoDS_Shape aValue1 = itSub1.Value();
521 TopTools_ListIteratorOfListOfShape itSub2 (listShape2);
522 for (; itSub2.More(); itSub2.Next()) {
523 TopoDS_Shape aValue2 = itSub2.Value();
524 if (aValue1.ShapeType() == TopAbs_FACE && aValue2.ShapeType() == TopAbs_FACE) {
525 isFaces = Standard_True;
532 BRepAlgoAPI_Fuse BO (theShape1, theShape2);
534 StdFail_NotDone::Raise("Fuse operation can not be performed on the given shapes");
537 #if OCC_VERSION_MAJOR >= 7
539 aShape = makeCompoundShellFromFaces(aShape);
543 // perform SECTION operation
544 else if (theType == BOOLEAN_SECTION) {
549 TopTools_ListOfShape listShape1, listShape2;
550 GEOMUtils::AddSimpleShapes(theShape1, listShape1);
551 GEOMUtils::AddSimpleShapes(theShape2, listShape2);
553 Standard_Boolean isCompound =
554 (listShape1.Extent() > 1 || listShape2.Extent() > 1);
556 TopTools_ListIteratorOfListOfShape itSub1 (listShape1);
557 for (; itSub1.More(); itSub1.Next()) {
558 TopoDS_Shape aValue1 = itSub1.Value();
559 TopTools_ListIteratorOfListOfShape itSub2 (listShape2);
560 for (; itSub2.More(); itSub2.Next()) {
561 TopoDS_Shape aValue2 = itSub2.Value();
562 BRepAlgoAPI_Section BO (aValue1, aValue2, Standard_False);
563 // Set approximation to have an attached 3D BSpline geometry to each edge,
564 // where analytic curve is not possible. Without this flag in some cases
565 // we obtain BSpline curve of degree 1 (C0), which is slowly
566 // processed by some algorithms (Partition for example).
567 BO.Approximation(Standard_True);
568 //modified by NIZNHY-PKV Tue Oct 18 14:34:16 2011f
569 BO.ComputePCurveOn1(Standard_True);
570 BO.ComputePCurveOn2(Standard_True);
571 //modified by NIZNHY-PKV Tue Oct 18 14:34:18 2011t
575 StdFail_NotDone::Raise("Section operation can not be performed on the given shapes");
578 TopoDS_Shape aStepResult = BO.Shape();
580 // check result of this step: if it is a compound (boolean operations
581 // allways return a compound), we add all sub-shapes of it.
582 // This allows to avoid adding empty compounds,
583 // resulting from SECTION on two non-intersecting shapes.
584 if (aStepResult.ShapeType() == TopAbs_COMPOUND) {
585 TopoDS_Iterator aCompIter (aStepResult);
586 for (; aCompIter.More(); aCompIter.Next()) {
587 // add shape in a result
588 B.Add(C, aCompIter.Value());
592 // add shape in a result
593 B.Add(C, aStepResult);
602 // As GlueFaces has been improved to keep all kind of shapes
603 TopExp_Explorer anExp (C, TopAbs_VERTEX);
605 aShape = GEOMImpl_GlueDriver::GlueFaces(C, Precision::Confusion(), Standard_True);
615 if (aShape.IsNull()) return aShape;
617 // as boolean operations always produce compound, lets simplify it
618 // for the case, if it contains only one sub-shape
619 TopTools_ListOfShape listShapeRes;
620 GEOMUtils::AddSimpleShapes(aShape, listShapeRes);
621 if (listShapeRes.Extent() == 1) {
622 aShape = listShapeRes.First();
623 if (aShape.IsNull()) return aShape;
626 // 08.07.2008 skl for bug 19761 from Mantis
627 if ( !GEOMUtils::CheckShape(aShape, true) && !GEOMUtils::FixShapeTolerance(aShape) )
628 Standard_ConstructionError::Raise("Boolean operation aborted : non valid shape result");
633 //================================================================================
635 * \brief Returns a name of creation operation and names and values of creation parameters
637 //================================================================================
639 bool GEOMImpl_BooleanDriver::
640 GetCreationInformation(std::string& theOperationName,
641 std::vector<GEOM_Param>& theParams)
643 if (Label().IsNull()) return 0;
644 Handle(GEOM_Function) function = GEOM_Function::GetFunction(Label());
646 GEOMImpl_IBoolean aCI (function);
647 Standard_Integer aType = function->GetType();
648 Standard_Boolean isCheckSelfInte = aCI.GetCheckSelfIntersection();
652 theOperationName = "COMMON";
653 AddParam( theParams, "Object 1", aCI.GetShape1() );
654 AddParam( theParams, "Object 2", aCI.GetShape2() );
655 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
658 theOperationName = "CUT";
659 AddParam( theParams, "Main Object", aCI.GetShape1() );
660 AddParam( theParams, "Tool Object", aCI.GetShape2() );
661 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
664 theOperationName = "FUSE";
665 AddParam( theParams, "Object 1", aCI.GetShape1() );
666 AddParam( theParams, "Object 2", aCI.GetShape2() );
667 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
668 AddParam( theParams, "Remove extra edges", aCI.GetRmExtraEdges() );
670 case BOOLEAN_SECTION:
671 theOperationName = "SECTION";
672 AddParam( theParams, "Object 1", aCI.GetShape1() );
673 AddParam( theParams, "Object 2", aCI.GetShape2() );
674 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
676 case BOOLEAN_COMMON_LIST:
677 theOperationName = "COMMON";
678 AddParam( theParams, "Selected objects", aCI.GetShapes() );
679 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
681 case BOOLEAN_FUSE_LIST:
682 theOperationName = "FUSE";
683 AddParam( theParams, "Selected objects", aCI.GetShapes() );
684 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
685 AddParam( theParams, "Remove extra edges", aCI.GetRmExtraEdges() );
687 case BOOLEAN_CUT_LIST:
688 theOperationName = "CUT";
689 AddParam( theParams, "Main Object", aCI.GetShape1() );
690 AddParam( theParams, "Tool Objects", aCI.GetShapes() );
691 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
700 OCCT_IMPLEMENT_STANDARD_RTTIEXT (GEOMImpl_BooleanDriver,GEOM_BaseDriver);