0030878: Modeling Algorithms - BRepLib_MakeFace produces face with abnormal surface
[occt.git] / src / BRepLib / BRepLib_FindSurface.cxx
1 // Created on: 1994-07-22
2 // Created by: Remi LEQUETTE
3 // Copyright (c) 1994-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17
18 #include <BRep_Builder.hxx>
19 #include <BRep_Tool.hxx>
20 #include <BRepAdaptor_Curve.hxx>
21 #include <BRepAdaptor_Surface.hxx>
22 #include <BRepLib_FindSurface.hxx>
23 #include <BRepLib_MakeFace.hxx>
24 #include <BRepTools_WireExplorer.hxx>
25 #include <BRepTopAdaptor_FClass2d.hxx>
26 #include <Geom2d_Curve.hxx>
27 #include <Geom_BezierCurve.hxx>
28 #include <Geom_BSplineCurve.hxx>
29 #include <Geom_Plane.hxx>
30 #include <Geom_RectangularTrimmedSurface.hxx>
31 #include <Geom_Surface.hxx>
32 #include <GeomLib.hxx>
33 #include <gp_Ax2.hxx>
34 #include <gp_Ax3.hxx>
35 #include <gp_Circ.hxx>
36 #include <gp_Elips.hxx>
37 #include <gp_Hypr.hxx>
38 #include <gp_Lin.hxx>
39 #include <gp_Parab.hxx>
40 #include <gp_Vec.hxx>
41 #include <math_Jacobi.hxx>
42 #include <math_Matrix.hxx>
43 #include <math_Vector.hxx>
44 #include <Precision.hxx>
45 #include <Standard_ErrorHandler.hxx>
46 #include <Standard_NoSuchObject.hxx>
47 #include <TColgp_Array1OfPnt.hxx>
48 #include <TColgp_HArray1OfPnt.hxx>
49 #include <TColgp_SequenceOfPnt.hxx>
50 #include <TColStd_SequenceOfReal.hxx>
51 #include <TopExp.hxx>
52 #include <TopExp_Explorer.hxx>
53 #include <TopLoc_Location.hxx>
54 #include <TopoDS.hxx>
55 #include <TopoDS_Shape.hxx>
56 #include <TopoDS_Vertex.hxx>
57 #include <TopoDS_Wire.hxx>
58 #include <NCollection_Vector.hxx>
59
60 //=======================================================================
61 //function : Controle
62 //purpose  : 
63 //=======================================================================
64 static Standard_Real Controle(const TColgp_SequenceOfPnt& thePoints,
65                               const Handle(Geom_Plane)& thePlane)
66 {
67   Standard_Real dfMaxDist=0.;
68   Standard_Real a,b,c,d, dist;
69   Standard_Integer ii;
70   thePlane->Coefficients(a,b,c,d);
71   for (ii=1; ii<=thePoints.Length(); ii++) {
72     const gp_XYZ& xyz = thePoints(ii).XYZ();
73     dist = Abs(a*xyz.X() + b*xyz.Y() + c*xyz.Z() + d);
74     if (dist > dfMaxDist)
75       dfMaxDist = dist;
76   }
77
78   return dfMaxDist;
79 }
80 //=======================================================================
81 //function : Is2DConnected
82 //purpose  : Return true if the last vertex of theEdge1 coincides with
83 //           the first vertex of theEdge2 in parametric space of theFace
84 //=======================================================================
85 inline static Standard_Boolean Is2DConnected(const TopoDS_Edge& theEdge1,
86                                              const TopoDS_Edge& theEdge2,
87                                              const Handle(Geom_Surface)& theSurface,
88                                              const TopLoc_Location& theLocation)
89 {
90   Standard_Real f,l;
91   //TopLoc_Location aLoc;
92   Handle(Geom2d_Curve) aCurve;
93   gp_Pnt2d p1, p2;
94
95   // get 2D points
96   aCurve=BRep_Tool::CurveOnSurface(theEdge1, theSurface, theLocation, f, l);
97   p1       = aCurve->Value( theEdge1.Orientation() == TopAbs_FORWARD ? l : f );
98   aCurve=BRep_Tool::CurveOnSurface(theEdge2, theSurface, theLocation, f, l);
99   p2       = aCurve->Value(  theEdge2.Orientation() == TopAbs_FORWARD ? f : l );
100
101   // compare 2D points
102   GeomAdaptor_Surface aSurface( theSurface );
103   TopoDS_Vertex    aV = TopExp::FirstVertex( theEdge2, Standard_True );
104   Standard_Real tol3D = BRep_Tool::Tolerance( aV );
105   Standard_Real tol2D = aSurface.UResolution( tol3D ) + aSurface.VResolution( tol3D );
106   Standard_Real dist2 = p1.SquareDistance( p2 );
107   return dist2 < tol2D * tol2D;
108 }
109
110 //=======================================================================
111 //function : Is2DClosed
112 //purpose  : Return true if edges of theShape form a closed wire in
113 //           parametric space of theSurface
114 //=======================================================================
115
116 static Standard_Boolean Is2DClosed(const TopoDS_Shape&         theShape,
117                                    const Handle(Geom_Surface)& theSurface,
118                                    const TopLoc_Location& theLocation)
119 {
120   try
121   {
122     OCC_CATCH_SIGNALS
123     // get a wire theShape 
124     TopExp_Explorer aWireExp( theShape, TopAbs_WIRE );
125     if ( !aWireExp.More() ) {
126       return Standard_False;
127     }
128     TopoDS_Wire aWire = TopoDS::Wire( aWireExp.Current() );
129     // a tmp face
130     TopoDS_Face aTmpFace = BRepLib_MakeFace( theSurface, Precision::PConfusion() );
131
132     // check topological closeness using wire explorer, if the wire is not closed
133     // the 1st and the last vertices of wire are different
134     BRepTools_WireExplorer aWireExplorer( aWire, aTmpFace );
135     if ( !aWireExplorer.More()) {
136       return Standard_False;
137     }
138     // remember the 1st and the last edges of aWire
139     TopoDS_Edge aFisrtEdge = aWireExplorer.Current(), aLastEdge = aFisrtEdge;
140     // check if edges connected topologically (that is assured by BRepTools_WireExplorer)
141     // are connected in 2D
142     TopoDS_Edge aPrevEdge = aFisrtEdge;
143     for ( aWireExplorer.Next(); aWireExplorer.More(); aWireExplorer.Next() )    {
144       aLastEdge = aWireExplorer.Current();
145       if ( !Is2DConnected( aPrevEdge, aLastEdge, theSurface, theLocation)) { 
146         return false;
147       }
148       aPrevEdge = aLastEdge;
149     }
150     // wire is closed if ( 1st vertex of aFisrtEdge ) ==
151     // ( last vertex of aLastEdge ) in 2D
152     TopoDS_Vertex aV1 = TopExp::FirstVertex( aFisrtEdge, Standard_True );
153     TopoDS_Vertex aV2 = TopExp::LastVertex( aLastEdge, Standard_True );
154     return ( aV1.IsSame( aV2 ) && Is2DConnected( aLastEdge, aFisrtEdge, theSurface, theLocation));
155   }
156   catch (Standard_Failure const&)  {
157     return Standard_False;
158   }
159 }
160 //=======================================================================
161 //function : BRepLib_FindSurface
162 //purpose  : 
163 //=======================================================================
164 BRepLib_FindSurface::BRepLib_FindSurface() 
165 {
166 }
167 //=======================================================================
168 //function : BRepLib_FindSurface
169 //purpose  : 
170 //=======================================================================
171 BRepLib_FindSurface::BRepLib_FindSurface(const TopoDS_Shape&    S, 
172                                          const Standard_Real    Tol,
173                                          const Standard_Boolean OnlyPlane,
174                                          const Standard_Boolean OnlyClosed)
175 {
176   Init(S,Tol,OnlyPlane,OnlyClosed);
177 }
178
179 namespace
180 {
181 static void fillParams (const TColStd_Array1OfReal& theKnots,
182                         Standard_Integer theDegree,
183                         Standard_Real theParMin,
184                         Standard_Real theParMax,
185                         NCollection_Vector<Standard_Real>& theParams)
186 {
187   Standard_Real aPrevPar = theParMin;
188   theParams.Append (aPrevPar);
189
190   Standard_Integer aNbP = Max (theDegree, 1);
191
192   for (Standard_Integer i = 1;
193        (i < theKnots.Length()) && (theKnots (i) < (theParMax - Precision::PConfusion())); ++i)
194   {
195     if (theKnots (i + 1) < theParMin + Precision::PConfusion())
196       continue;
197
198     Standard_Real aStep = (theKnots (i + 1) - theKnots (i)) / aNbP;
199     for (Standard_Integer k = 1; k <= aNbP ; ++k)
200     {
201       Standard_Real aPar = theKnots (i) + k * aStep;
202       if (aPar > theParMax - Precision::PConfusion())
203         break;
204
205       if (aPar > aPrevPar + Precision::PConfusion())
206       {
207         theParams.Append (aPar);
208         aPrevPar = aPar;
209       }
210     }
211   }
212   theParams.Append (theParMax);
213 }
214
215 static void fillPoints (const BRepAdaptor_Curve& theCurve,
216                         const NCollection_Vector<Standard_Real> theParams,
217                         TColgp_SequenceOfPnt& thePoints,
218                         TColStd_SequenceOfReal& theWeights)
219 {
220   Standard_Real aDistPrev = 0., aDistNext;
221   gp_Pnt aPPrev (theCurve.Value (theParams (0))), aPNext;
222
223   for (Standard_Integer iP = 1; iP <= theParams.Length(); ++iP)
224   {
225     if (iP < theParams.Length())
226     {
227       Standard_Real aParam = theParams (iP);
228       aPNext = theCurve.Value (aParam);
229       aDistNext = aPPrev.Distance (aPNext);
230     }
231     else
232       aDistNext = 0.0;
233
234     thePoints.Append (aPPrev);
235     theWeights.Append (aDistPrev + aDistNext);
236     aDistPrev = aDistNext;
237     aPPrev = aPNext;
238   }
239 }
240
241 }
242 //=======================================================================
243 //function : Init
244 //purpose  : 
245 //=======================================================================
246 void BRepLib_FindSurface::Init(const TopoDS_Shape&    S, 
247                                                  const Standard_Real    Tol,
248                                                  const Standard_Boolean OnlyPlane,
249                                const Standard_Boolean OnlyClosed)
250 {
251   myTolerance = Tol;
252   myTolReached = 0.;
253   isExisted = Standard_False;
254   myLocation.Identity();
255   mySurface.Nullify();
256
257   // compute the tolerance
258   TopExp_Explorer ex;
259
260   for (ex.Init(S,TopAbs_EDGE); ex.More(); ex.Next()) {
261     Standard_Real t = BRep_Tool::Tolerance(TopoDS::Edge(ex.Current()));
262     if (t > myTolerance) myTolerance = t;
263   }
264
265   // search an existing surface
266   ex.Init(S,TopAbs_EDGE);
267   if (!ex.More()) return;    // no edges ....
268
269   TopoDS_Edge E = TopoDS::Edge(ex.Current());
270   Standard_Real f,l,ff,ll;
271   Handle(Geom2d_Curve) PC,aPPC;
272   Handle(Geom_Surface) SS;
273   TopLoc_Location L;
274   Standard_Integer i = 0,j;
275
276   // iterate on the surfaces of the first edge
277   for(;;) {
278     i++;
279     BRep_Tool::CurveOnSurface(E,PC,mySurface,myLocation,f,l,i);
280     if (mySurface.IsNull()) {
281       break;
282     }
283     // check the other edges
284     for (ex.Init(S,TopAbs_EDGE); ex.More(); ex.Next()) {
285       if (!E.IsSame(ex.Current())) {
286         j = 0;
287         for(;;) {
288           j++;
289           BRep_Tool::CurveOnSurface(TopoDS::Edge(ex.Current()),aPPC,SS,L,ff,ll,j);
290           if (SS.IsNull()) {
291             break;
292           }
293           if ((SS == mySurface) && (L.IsEqual(myLocation))) {
294             break;
295           }
296           SS.Nullify();
297         }
298
299         if (SS.IsNull()) {
300           mySurface.Nullify();
301           break;
302         }
303       }
304     }
305
306     // if OnlyPlane, eval if mySurface is a plane.
307     if ( OnlyPlane && !mySurface.IsNull() ) 
308     {
309       if ( mySurface->IsKind( STANDARD_TYPE(Geom_RectangularTrimmedSurface)))
310         mySurface = Handle(Geom_RectangularTrimmedSurface)::DownCast(mySurface)->BasisSurface();
311       mySurface = Handle(Geom_Plane)::DownCast(mySurface);
312     }
313
314     if (!mySurface.IsNull())
315       // if S is e.g. the bottom face of a cylinder, mySurface can be the
316       // lateral (cylindrical) face of the cylinder; reject an improper mySurface
317       if ( !OnlyClosed || Is2DClosed( S, mySurface, myLocation ))
318         break;
319   }
320
321   if (!mySurface.IsNull()) {
322     isExisted = Standard_True;
323     return;
324   }
325   //
326   // no existing surface, search a plane
327   // 07/02/02 akm vvv : (OCC157) changed algorithm
328   //                    1. Collect the points along all edges of the shape
329   //                       For each point calculate the WEIGHT = sum of
330   //                       distances from neighboring points (_only_ same edge)
331   //                    2. Minimizing the weighed sum of squared deviations
332   //                       compute coefficients of the sought plane.
333
334   TColgp_SequenceOfPnt aPoints;
335   TColStd_SequenceOfReal aWeight;
336
337   // ======================= Step #1
338   for (ex.Init(S,TopAbs_EDGE); ex.More(); ex.Next()) 
339   {
340     BRepAdaptor_Curve c(TopoDS::Edge(ex.Current()));
341
342     Standard_Real dfUf = c.FirstParameter();
343     Standard_Real dfUl = c.LastParameter();
344     if (IsEqual(dfUf,dfUl)) {
345       // Degenerate
346       continue;
347     }
348     Standard_Integer iNbPoints=0;
349
350     // Fill the parameters of the sampling points
351     NCollection_Vector<Standard_Real> aParams;
352     switch (c.GetType()) 
353     {
354       case GeomAbs_BezierCurve:
355       {
356         Handle(Geom_BezierCurve) GC = c.Bezier();
357         TColStd_Array1OfReal aKnots (1, 2);
358         aKnots.SetValue (1, GC->FirstParameter());
359         aKnots.SetValue (2, GC->LastParameter());
360
361         fillParams (aKnots, GC->Degree(), dfUf, dfUl, aParams);
362         break;
363       }
364       case GeomAbs_BSplineCurve:
365       {
366         Handle(Geom_BSplineCurve) GC = c.BSpline();
367         fillParams (GC->Knots(), GC->Degree(), dfUf, dfUl, aParams);
368         break;
369       }
370       case GeomAbs_Line:
371       {
372         // Two points on a straight segment
373         aParams.Append (dfUf);
374         aParams.Append (dfUl);
375         break;
376       }
377       case GeomAbs_Circle:
378       case GeomAbs_Ellipse:
379       case GeomAbs_Hyperbola:
380       case GeomAbs_Parabola:
381         // Four points on other analytical curves
382         iNbPoints = 4;
383         Standard_FALLTHROUGH
384       default:
385       { 
386         // Put some points on other curves
387         if (iNbPoints == 0)
388           iNbPoints = 15 + c.NbIntervals (GeomAbs_C3);
389
390         TColStd_Array1OfReal aBounds (1, 2);
391         aBounds.SetValue (1, dfUf);
392         aBounds.SetValue (2, dfUl);
393
394         fillParams (aBounds, iNbPoints - 1, dfUf, dfUl, aParams);
395       }
396     }
397
398     // Add the points with weights to the sequences
399     fillPoints (c, aParams, aPoints, aWeight);
400   }
401
402   if (aPoints.Length() < 3) {
403     return;
404   }
405
406   // ======================= Step #2
407   myLocation.Identity();
408   Standard_Integer iPoint;
409   math_Matrix aMat (1,3,1,3, 0.);
410   math_Vector aVec (1,3, 0.);
411   // Find the barycenter and normalize weights 
412   Standard_Real dfMaxWeight=0.;
413   gp_XYZ aBaryCenter(0.,0.,0.);
414   Standard_Real dfSumWeight=0.;
415   for (iPoint=1; iPoint<=aPoints.Length(); iPoint++)  {
416     Standard_Real dfW = aWeight(iPoint);
417     aBaryCenter += dfW*aPoints(iPoint).XYZ();
418     dfSumWeight += dfW;
419     if (dfW > dfMaxWeight) {
420       dfMaxWeight = dfW;
421     }
422   }
423   aBaryCenter /= dfSumWeight;
424
425   // Fill the matrix and the right vector
426   for (iPoint=1; iPoint<=aPoints.Length(); iPoint++)  {
427     gp_XYZ p=aPoints(iPoint).XYZ()-aBaryCenter;
428     Standard_Real w=aWeight(iPoint)/dfMaxWeight;
429     aMat(1,1)+=w*p.X()*p.X(); 
430     aMat(1,2)+=w*p.X()*p.Y(); 
431     aMat(1,3)+=w*p.X()*p.Z();
432     //  
433     aMat(2,2)+=w*p.Y()*p.Y();  
434     aMat(2,3)+=w*p.Y()*p.Z();
435     //  
436     aMat(3,3)+=w*p.Z()*p.Z();
437   }
438   aMat(2,1) = aMat(1,2);
439   aMat(3,1) = aMat(1,3);
440   aMat(3,2) = aMat(2,3);
441   //
442   math_Jacobi anEignval(aMat);
443   math_Vector anEVals(1,3);
444   Standard_Boolean isSolved = anEignval.IsDone();
445   Standard_Integer isol = 0;
446   if(isSolved)
447   {
448     anEVals = anEignval.Values();
449     //We need vector with eigenvalue ~ 0.
450     Standard_Real anEMin = RealLast();
451     Standard_Real anEMax = -anEMin;
452     for(i = 1; i <= 3; ++i)
453     {
454       Standard_Real anE = Abs(anEVals(i));
455       if(anEMin > anE)
456       {
457         anEMin = anE;
458         isol = i;
459       }
460       if(anEMax < anE)
461       {
462         anEMax = anE;
463       }
464     }
465     
466     if(isol == 0)
467     {
468       isSolved = Standard_False;
469     }
470     else
471     {
472       Standard_Real eps = Epsilon(anEMax);
473       if(anEMin <= eps)
474       {
475         anEignval.Vector(isol, aVec);
476       }
477       else
478       {
479         //try using vector product of other axes
480         Standard_Integer ind[2] = {0,0};
481         for(i = 1; i <= 3; ++i)
482         {
483           if(i == isol)
484           {
485             continue;
486           }
487           if(ind[0] == 0)
488           {
489             ind[0] = i;
490             continue;
491           }
492           if(ind[1] == 0)
493           {
494             ind[1] = i;
495             continue;
496           }
497         }
498         math_Vector aVec1(1, 3, 0.), aVec2(1, 3, 0.);
499         anEignval.Vector(ind[0], aVec1);
500         anEignval.Vector(ind[1], aVec2);
501         gp_Vec aV1(aVec1(1), aVec1(2), aVec1(3));
502         gp_Vec aV2(aVec2(1), aVec2(2), aVec2(3));
503         gp_Vec aN = aV1^ aV2;
504         aVec(1) = aN.X();
505         aVec(2) = aN.Y();
506         aVec(3) = aN.Z();
507       }
508       if (aVec.Norm2() < gp::Resolution()) {
509         isSolved = Standard_False;
510       }
511     }
512   }
513
514   if (!isSolved)
515     return;
516
517   gp_Vec aN (aVec (1), aVec (2), aVec (3));
518   Handle(Geom_Plane) aPlane = new Geom_Plane (aBaryCenter, aN);
519   myTolReached = Controle (aPoints, aPlane);
520   const Standard_Real aWeakness = 5.0;
521   if (myTolReached <= myTolerance || (Tol < 0 && myTolReached < myTolerance * aWeakness))
522   {
523     mySurface = aPlane;
524     //If S is wire, try to orient surface according to orientation of wire.
525     if (S.ShapeType() == TopAbs_WIRE && S.Closed())
526     {
527       TopoDS_Wire aW = TopoDS::Wire (S);
528       TopoDS_Face aTmpFace = BRepLib_MakeFace (mySurface, Precision::Confusion());
529       BRep_Builder BB;
530       BB.Add (aTmpFace, aW);
531       BRepTopAdaptor_FClass2d FClass (aTmpFace, 0.);
532       if (FClass.PerformInfinitePoint() == TopAbs_IN)
533       {
534         gp_Dir aNorm = aPlane->Position().Direction();
535         aNorm.Reverse();
536         mySurface = new Geom_Plane (aPlane->Position().Location(), aNorm);
537       }
538     }
539   }
540 }
541 //=======================================================================
542 //function : Found
543 //purpose  : 
544 //=======================================================================
545 Standard_Boolean BRepLib_FindSurface::Found() const 
546 {
547   return !mySurface.IsNull();
548 }
549 //=======================================================================
550 //function : Surface
551 //purpose  : 
552 //=======================================================================
553 Handle(Geom_Surface) BRepLib_FindSurface::Surface() const 
554 {
555   return mySurface;
556 }
557 //=======================================================================
558 //function : Tolerance
559 //purpose  : 
560 //=======================================================================
561 Standard_Real BRepLib_FindSurface::Tolerance() const 
562 {
563   return myTolerance;
564 }
565 //=======================================================================
566 //function : ToleranceReached
567 //purpose  : 
568 //=======================================================================
569 Standard_Real BRepLib_FindSurface::ToleranceReached() const 
570 {
571   return myTolReached;
572 }
573 //=======================================================================
574 //function : Existed
575 //purpose  : 
576 //=======================================================================
577 Standard_Boolean BRepLib_FindSurface::Existed() const 
578 {
579   return isExisted;
580 }
581 //=======================================================================
582 //function : Location
583 //purpose  : 
584 //=======================================================================
585 TopLoc_Location BRepLib_FindSurface::Location() const
586 {
587   return myLocation;
588 }
589