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>
42 #include <TopExp_Explorer.hxx>
43 #include <TopoDS_Compound.hxx>
44 #include <TopoDS_Iterator.hxx>
45 #include <TopTools_MapOfShape.hxx>
46 #include <TopTools_ListOfShape.hxx>
47 #include <TopTools_ListIteratorOfListOfShape.hxx>
49 #include <TColStd_IndexedDataMapOfTransientTransient.hxx>
51 #include <Precision.hxx>
53 #include <Standard_ConstructionError.hxx>
54 #include <StdFail_NotDone.hxx>
56 // Depth of self-intersection check (see BOPAlgo_CheckerSI::SetLevelOfCheck() for more details)
57 // Default value for BOPAlgo_CheckerSI gives very long computation when checking face-to-face intersections;
58 // here check level is decreased to more appropriate value to avoid problems with performance).
59 #define BOP_SELF_INTERSECTIONS_LEVEL 4
62 * This function performs extra edges removal.
64 * \param theShape the shape to be processed.
65 * \return the modified shape or null shape in case of failure.
67 static TopoDS_Shape RemoveExtraEdges(const TopoDS_Shape &theShape)
71 if (!theShape.IsNull()) {
72 BlockFix_BlockFixAPI aTool;
74 aTool.OptimumNbFaces() = 0;
75 aTool.SetShape(theShape);
77 TopoDS_Shape aShape = aTool.Shape();
79 if (GEOMUtils::CheckShape(aShape)) {
84 ShHealOper_ShapeProcess aHealer;
85 aHealer.Perform(aShape, aFixed);
86 if (aHealer.isDone() && GEOMUtils::CheckShape(aFixed))
94 //=======================================================================
97 //=======================================================================
98 const Standard_GUID& GEOMImpl_BooleanDriver::GetID()
100 static Standard_GUID aBooleanDriver("FF1BBB21-5D14-4df2-980B-3A668264EA16");
101 return aBooleanDriver;
104 //=======================================================================
105 //function : GEOMImpl_BooleanDriver
107 //=======================================================================
108 GEOMImpl_BooleanDriver::GEOMImpl_BooleanDriver()
112 //=======================================================================
115 //=======================================================================
116 Standard_Integer GEOMImpl_BooleanDriver::Execute(LOGBOOK& log) const
118 if (Label().IsNull()) return 0;
119 Handle(GEOM_Function) aFunction = GEOM_Function::GetFunction(Label());
121 GEOMImpl_IBoolean aCI (aFunction);
122 Standard_Integer aType = aFunction->GetType();
123 const Standard_Boolean isCheckSelfInte = aCI.GetCheckSelfIntersection();
124 const Standard_Boolean isRmExtraEdges = aCI.GetRmExtraEdges();
132 case BOOLEAN_SECTION:
134 Handle(GEOM_Function) aRefShape1 = aCI.GetShape1();
135 Handle(GEOM_Function) aRefShape2 = aCI.GetShape2();
136 TopoDS_Shape aShape1 = aRefShape1->GetValue();
137 TopoDS_Shape aShape2 = aRefShape2->GetValue();
139 if (!aShape1.IsNull() && !aShape2.IsNull()) {
140 // check arguments for Mantis issue 0021019
141 if (!GEOMUtils::CheckShape(aShape1, true) || !GEOMUtils::CheckShape(aShape2, true))
142 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is not valid");
144 if (isCheckSelfInte) {
145 BOPAlgo_CheckerSI aCSI; // checker of self-interferences
146 aCSI.SetLevelOfCheck(BOP_SELF_INTERSECTIONS_LEVEL);
147 BOPCol_ListOfShape aList1, aList2;
148 aList1.Append(aShape1);
149 aList2.Append(aShape2);
150 aCSI.SetArguments(aList1);
152 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0)
153 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
154 aCSI.SetArguments(aList2);
156 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0)
157 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
160 // Make a copy to prevent the original shape changes.
161 TopoDS_Shape aShapeCopy1;
162 TopoDS_Shape aShapeCopy2;
163 TColStd_IndexedDataMapOfTransientTransient aMapTShapes;
164 TNaming_CopyShape::CopyTool(aShape1, aMapTShapes, aShapeCopy1);
165 TNaming_CopyShape::CopyTool(aShape2, aMapTShapes, aShapeCopy2);
167 aShape = performOperation (aShapeCopy1, aShapeCopy2, aType);
169 if (isRmExtraEdges) {
170 aShape = RemoveExtraEdges(aShape);
173 if (aShape.IsNull()) {
179 case BOOLEAN_COMMON_LIST:
180 case BOOLEAN_FUSE_LIST:
182 Handle(TColStd_HSequenceOfTransient) aShapes = aCI.GetShapes();
183 const Standard_Integer nbShapes = aShapes->Length();
185 Handle(GEOM_Function) aRefShape;
186 TopoDS_Shape aShape2;
187 Standard_Integer aSimpleType =
188 (aType == BOOLEAN_FUSE_LIST ? BOOLEAN_FUSE : BOOLEAN_COMMON);
191 aRefShape = Handle(GEOM_Function)::DownCast(aShapes->Value(1));
192 aShape = aRefShape->GetValue();
194 if (!aShape.IsNull()) {
195 // check arguments for Mantis issue 0021019
196 if (!GEOMUtils::CheckShape(aShape, true))
197 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is not valid");
199 BOPAlgo_CheckerSI aCSI; // checker of self-interferences
201 if (isCheckSelfInte) {
202 aCSI.SetLevelOfCheck(BOP_SELF_INTERSECTIONS_LEVEL);
203 BOPCol_ListOfShape aList1;
204 aList1.Append(aShape);
205 aCSI.SetArguments(aList1);
207 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0) {
208 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
213 TopoDS_Shape aShapeCopy;
214 TColStd_IndexedDataMapOfTransientTransient aMapTShapes;
216 TNaming_CopyShape::CopyTool(aShape, aMapTShapes, aShapeCopy);
219 for (i = 2; i <= nbShapes; i++) {
220 aRefShape = Handle(GEOM_Function)::DownCast(aShapes->Value(i));
221 aShape2 = aRefShape->GetValue();
223 if (!GEOMUtils::CheckShape(aShape2, true))
224 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is not valid");
226 if (isCheckSelfInte) {
227 BOPCol_ListOfShape aList2;
228 aList2.Append(aShape2);
229 aCSI.SetArguments(aList2);
231 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0) {
232 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
237 aShapeCopy.Nullify();
238 TNaming_CopyShape::CopyTool(aShape2, aMapTShapes, aShapeCopy);
239 aShape = performOperation (aShape, aShapeCopy, aSimpleType);
241 if (isRmExtraEdges) {
242 aShape = RemoveExtraEdges(aShape);
245 if (aShape.IsNull()) {
253 case BOOLEAN_CUT_LIST:
255 Handle(GEOM_Function) aRefObject = aCI.GetShape1();
257 aShape = aRefObject->GetValue();
259 if (!aShape.IsNull()) {
260 // check arguments for Mantis issue 0021019
261 if (!GEOMUtils::CheckShape(aShape, true))
262 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is not valid");
264 BOPAlgo_CheckerSI aCSI; // checker of self-interferences
266 if (isCheckSelfInte) {
267 aCSI.SetLevelOfCheck(BOP_SELF_INTERSECTIONS_LEVEL);
268 BOPCol_ListOfShape aList1;
269 aList1.Append(aShape);
270 aCSI.SetArguments(aList1);
272 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0) {
273 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
278 TopoDS_Shape aShapeCopy;
279 TColStd_IndexedDataMapOfTransientTransient aMapTShapes;
281 TNaming_CopyShape::CopyTool(aShape, aMapTShapes, aShapeCopy);
284 Handle(TColStd_HSequenceOfTransient) aTools = aCI.GetShapes();
285 const Standard_Integer nbShapes = aTools->Length();
287 Handle(GEOM_Function) aRefTool;
290 for (i = 1; i <= nbShapes; i++) {
291 aRefTool = Handle(GEOM_Function)::DownCast(aTools->Value(i));
292 aTool = aRefTool->GetValue();
294 if (!GEOMUtils::CheckShape(aTool, true))
295 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is not valid");
297 if (isCheckSelfInte) {
298 BOPCol_ListOfShape aList2;
299 aList2.Append(aTool);
300 aCSI.SetArguments(aList2);
302 if (aCSI.ErrorStatus() || aCSI.DS().Interferences().Extent() > 0) {
303 StdFail_NotDone::Raise("Boolean operation will not be performed, because argument shape is self-intersected");
308 aShapeCopy.Nullify();
309 TNaming_CopyShape::CopyTool(aTool, aMapTShapes, aShapeCopy);
310 aShape = performOperation (aShape, aShapeCopy, BOOLEAN_CUT);
312 if (aShape.IsNull()) {
323 aFunction->SetValue(aShape);
325 #if OCC_VERSION_MAJOR < 7
326 log.SetTouched(Label());
328 log->SetTouched(Label());
334 //=======================================================================
335 //function : performOperation
337 //=======================================================================
338 TopoDS_Shape GEOMImpl_BooleanDriver::performOperation
339 (const TopoDS_Shape theShape1,
340 const TopoDS_Shape theShape2,
341 const Standard_Integer theType)const
345 // perform COMMON operation
346 if (theType == BOOLEAN_COMMON) {
351 TopTools_ListOfShape listShape1, listShape2;
352 GEOMUtils::AddSimpleShapes(theShape1, listShape1);
353 GEOMUtils::AddSimpleShapes(theShape2, listShape2);
355 Standard_Boolean isCompound =
356 (listShape1.Extent() > 1 || listShape2.Extent() > 1);
358 TopTools_ListIteratorOfListOfShape itSub1 (listShape1);
359 for (; itSub1.More(); itSub1.Next()) {
360 TopoDS_Shape aValue1 = itSub1.Value();
361 TopTools_ListIteratorOfListOfShape itSub2 (listShape2);
362 for (; itSub2.More(); itSub2.Next()) {
363 TopoDS_Shape aValue2 = itSub2.Value();
364 BRepAlgoAPI_Common BO (aValue1, aValue2);
366 StdFail_NotDone::Raise("Common operation can not be performed on the given shapes");
369 TopoDS_Shape aStepResult = BO.Shape();
371 // check result of this step: if it is a compound (boolean operations
372 // allways return a compound), we add all sub-shapes of it.
373 // This allows to avoid adding empty compounds,
374 // resulting from COMMON on two non-intersecting shapes.
375 if (aStepResult.ShapeType() == TopAbs_COMPOUND) {
376 TopoDS_Iterator aCompIter (aStepResult);
377 for (; aCompIter.More(); aCompIter.Next()) {
378 // add shape in a result
379 B.Add(C, aCompIter.Value());
383 // add shape in a result
384 B.Add(C, aStepResult);
393 // As GlueFaces has been improved to keep all kind of shapes
394 TopExp_Explorer anExp (C, TopAbs_VERTEX);
396 aShape = GEOMImpl_GlueDriver::GlueFaces(C, Precision::Confusion(), Standard_True);
402 // perform CUT operation
403 else if (theType == BOOLEAN_CUT) {
408 TopTools_ListOfShape listShapes, listTools;
409 GEOMUtils::AddSimpleShapes(theShape1, listShapes);
410 GEOMUtils::AddSimpleShapes(theShape2, listTools);
412 Standard_Boolean isCompound = (listShapes.Extent() > 1);
414 TopTools_ListIteratorOfListOfShape itSub1 (listShapes);
415 for (; itSub1.More(); itSub1.Next()) {
416 TopoDS_Shape aCut = itSub1.Value();
418 TopTools_ListIteratorOfListOfShape itSub2 (listTools);
419 for (; itSub2.More(); itSub2.Next()) {
420 TopoDS_Shape aTool = itSub2.Value();
421 BRepAlgoAPI_Cut BO (aCut, aTool);
423 StdFail_NotDone::Raise("Cut operation can not be performed on the given shapes");
428 // check result of this step: if it is a compound (boolean operations
429 // allways return a compound), we add all sub-shapes of it.
430 // This allows to avoid adding empty compounds,
431 // resulting from CUT of parts
432 if (aCut.ShapeType() == TopAbs_COMPOUND) {
433 TopoDS_Iterator aCompIter (aCut);
434 for (; aCompIter.More(); aCompIter.Next()) {
435 // add shape in a result
436 B.Add(C, aCompIter.Value());
440 // add shape in a result
449 // As GlueFaces has been improved to keep all kind of shapes
450 TopExp_Explorer anExp (C, TopAbs_VERTEX);
452 aShape = GEOMImpl_GlueDriver::GlueFaces(C, Precision::Confusion(), Standard_True);
458 // perform FUSE operation
459 else if (theType == BOOLEAN_FUSE) {
461 BRepAlgoAPI_Fuse BO (theShape1, theShape2);
463 StdFail_NotDone::Raise("Fuse operation can not be performed on the given shapes");
468 // perform SECTION operation
469 else if (theType == BOOLEAN_SECTION) {
474 TopTools_ListOfShape listShape1, listShape2;
475 GEOMUtils::AddSimpleShapes(theShape1, listShape1);
476 GEOMUtils::AddSimpleShapes(theShape2, listShape2);
478 Standard_Boolean isCompound =
479 (listShape1.Extent() > 1 || listShape2.Extent() > 1);
481 TopTools_ListIteratorOfListOfShape itSub1 (listShape1);
482 for (; itSub1.More(); itSub1.Next()) {
483 TopoDS_Shape aValue1 = itSub1.Value();
484 TopTools_ListIteratorOfListOfShape itSub2 (listShape2);
485 for (; itSub2.More(); itSub2.Next()) {
486 TopoDS_Shape aValue2 = itSub2.Value();
487 BRepAlgoAPI_Section BO (aValue1, aValue2, Standard_False);
488 // Set approximation to have an attached 3D BSpline geometry to each edge,
489 // where analytic curve is not possible. Without this flag in some cases
490 // we obtain BSpline curve of degree 1 (C0), which is slowly
491 // processed by some algorithms (Partition for example).
492 BO.Approximation(Standard_True);
493 //modified by NIZNHY-PKV Tue Oct 18 14:34:16 2011f
494 BO.ComputePCurveOn1(Standard_True);
495 BO.ComputePCurveOn2(Standard_True);
496 //modified by NIZNHY-PKV Tue Oct 18 14:34:18 2011t
500 StdFail_NotDone::Raise("Section operation can not be performed on the given shapes");
503 TopoDS_Shape aStepResult = BO.Shape();
505 // check result of this step: if it is a compound (boolean operations
506 // allways return a compound), we add all sub-shapes of it.
507 // This allows to avoid adding empty compounds,
508 // resulting from SECTION on two non-intersecting shapes.
509 if (aStepResult.ShapeType() == TopAbs_COMPOUND) {
510 TopoDS_Iterator aCompIter (aStepResult);
511 for (; aCompIter.More(); aCompIter.Next()) {
512 // add shape in a result
513 B.Add(C, aCompIter.Value());
517 // add shape in a result
518 B.Add(C, aStepResult);
527 // As GlueFaces has been improved to keep all kind of shapes
528 TopExp_Explorer anExp (C, TopAbs_VERTEX);
530 aShape = GEOMImpl_GlueDriver::GlueFaces(C, Precision::Confusion(), Standard_True);
540 if (aShape.IsNull()) return aShape;
542 // as boolean operations always produce compound, lets simplify it
543 // for the case, if it contains only one sub-shape
544 TopTools_ListOfShape listShapeRes;
545 GEOMUtils::AddSimpleShapes(aShape, listShapeRes);
546 if (listShapeRes.Extent() == 1) {
547 aShape = listShapeRes.First();
548 if (aShape.IsNull()) return aShape;
551 // 08.07.2008 skl for bug 19761 from Mantis
552 if ( !GEOMUtils::CheckShape(aShape, true) && !GEOMUtils::FixShapeTolerance(aShape) )
553 Standard_ConstructionError::Raise("Boolean operation aborted : non valid shape result");
558 //================================================================================
560 * \brief Returns a name of creation operation and names and values of creation parameters
562 //================================================================================
564 bool GEOMImpl_BooleanDriver::
565 GetCreationInformation(std::string& theOperationName,
566 std::vector<GEOM_Param>& theParams)
568 if (Label().IsNull()) return 0;
569 Handle(GEOM_Function) function = GEOM_Function::GetFunction(Label());
571 GEOMImpl_IBoolean aCI (function);
572 Standard_Integer aType = function->GetType();
573 Standard_Boolean isCheckSelfInte = aCI.GetCheckSelfIntersection();
577 theOperationName = "COMMON";
578 AddParam( theParams, "Object 1", aCI.GetShape1() );
579 AddParam( theParams, "Object 2", aCI.GetShape2() );
580 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
583 theOperationName = "CUT";
584 AddParam( theParams, "Main Object", aCI.GetShape1() );
585 AddParam( theParams, "Tool Object", aCI.GetShape2() );
586 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
589 theOperationName = "FUSE";
590 AddParam( theParams, "Object 1", aCI.GetShape1() );
591 AddParam( theParams, "Object 2", aCI.GetShape2() );
592 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
593 AddParam( theParams, "Remove extra edges", aCI.GetRmExtraEdges() );
595 case BOOLEAN_SECTION:
596 theOperationName = "SECTION";
597 AddParam( theParams, "Object 1", aCI.GetShape1() );
598 AddParam( theParams, "Object 2", aCI.GetShape2() );
599 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
601 case BOOLEAN_COMMON_LIST:
602 theOperationName = "COMMON";
603 AddParam( theParams, "Selected objects", aCI.GetShapes() );
604 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
606 case BOOLEAN_FUSE_LIST:
607 theOperationName = "FUSE";
608 AddParam( theParams, "Selected objects", aCI.GetShapes() );
609 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
610 AddParam( theParams, "Remove extra edges", aCI.GetRmExtraEdges() );
612 case BOOLEAN_CUT_LIST:
613 theOperationName = "CUT";
614 AddParam( theParams, "Main Object", aCI.GetShape1() );
615 AddParam( theParams, "Tool Objects", aCI.GetShapes() );
616 AddParam( theParams, "Check self-intersections", isCheckSelfInte );
625 OCCT_IMPLEMENT_STANDARD_RTTIEXT (GEOMImpl_BooleanDriver,GEOM_BaseDriver);