0026106: BRepMesh - revision of data model
[occt.git] / src / BRepMesh / BRepMesh_ModelHealer.hxx
1 // Created on: 2016-06-23
2 // Copyright (c) 2016 OPEN CASCADE SAS
3 // Created by: Oleg AGASHIN
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _BRepMesh_ModelHealer_HeaderFile
17 #define _BRepMesh_ModelHealer_HeaderFile
18
19 #include <IMeshTools_ModelAlgo.hxx>
20 #include <IMeshTools_Parameters.hxx>
21 #include <IMeshData_Types.hxx>
22 #include <IMeshData_Model.hxx>
23 #include <TopoDS_Vertex.hxx>
24
25 //! Class implements functionality of model healer tool.
26 //! Iterates over model's faces and checks consistency of their wires, 
27 //! i.e.whether wires are closed and do not contain self - intersections.
28 //! In case if wire contains disconnected parts, ends of adjacent edges 
29 //! forming the gaps are connected in parametric space forcibly. The notion 
30 //! of this operation is to create correct discrete model defined relatively 
31 //! parametric space of target face taking into account connectivity and 
32 //! tolerances of 3D space only. This means that there are no specific 
33 //! computations are made for the sake of determination of U and V tolerance.
34 //! Registers intersections on edges forming the face¬ís shape and tries to 
35 //! amplify discrete represenation by decreasing of deflection for the target edge. 
36 //! Checks can be performed in parallel mode.
37 class BRepMesh_ModelHealer : public IMeshTools_ModelAlgo
38 {
39 public:
40
41   //! Constructor.
42   Standard_EXPORT BRepMesh_ModelHealer();
43
44   //! Destructor.
45   Standard_EXPORT virtual ~BRepMesh_ModelHealer();
46
47   //! Performs processing of edges of the given model.
48   Standard_EXPORT virtual Standard_Boolean Perform(
49     const Handle(IMeshData_Model)& theModel,
50     const IMeshTools_Parameters&   theParameters) Standard_OVERRIDE;
51
52   //! Functor API to discretize the given edge.
53   inline void operator() (const Standard_Integer theEdgeIndex) const {
54     process(theEdgeIndex);
55   }
56
57   //! Functor API to discretize the given edge.
58   inline void operator() (const IMeshData::IFaceHandle& theDFace) const {
59     process(theDFace);
60   }
61
62   DEFINE_STANDARD_RTTI_INLINE(BRepMesh_ModelHealer, IMeshTools_ModelAlgo)
63
64 private:
65
66   //! Checks existing discretization of the face and updates data model.
67   inline void process(const Standard_Integer theFaceIndex) const
68   {
69     const IMeshData::IFaceHandle& aDFace = myModel->GetFace(theFaceIndex);
70     process(aDFace);
71   }
72
73   //! Checks existing discretization of the face and updates data model.
74   void process(const IMeshData::IFaceHandle& theDFace) const;
75
76   //! Amplifies discretization of edges in case if self-intersection problem has been found.
77   void amplifyEdges();
78
79   //! Returns common vertex of two edges or null ptr in case if there is no such vertex.
80   TopoDS_Vertex getCommonVertex(
81     const IMeshData::IEdgeHandle& theEdge1,
82     const IMeshData::IEdgeHandle& theEdge2) const;
83
84   //! Connects pcurves of previous and current edge on the specified face 
85   //! according to topological connectivity. Uses next edge in order to
86   //! identify closest point in case of signle vertex shared between both
87   //! ends of edge (degenerative edge)
88   Standard_Boolean connectClosestPoints(
89     const IMeshData::IPCurveHandle& thePrevDEdge,
90     const IMeshData::IPCurveHandle& theCurrDEdge,
91     const IMeshData::IPCurveHandle& theNextDEdge) const;
92
93   //! Chooses the most closest point to reference one from the given pair.
94   //! Returns square distance between reference point and closest one as 
95   //! well as pointer to closest point.
96   inline Standard_Real closestPoint(
97     gp_Pnt2d&  theRefPnt,
98     gp_Pnt2d&  theFristPnt,
99     gp_Pnt2d&  theSecondPnt,
100     gp_Pnt2d*& theClosestPnt) const
101   {
102     // Find the most closest end-points.
103     const Standard_Real aSqDist1 = theRefPnt.SquareDistance(theFristPnt);
104     const Standard_Real aSqDist2 = theRefPnt.SquareDistance(theSecondPnt);
105     if (aSqDist1 < aSqDist2)
106     {
107       theClosestPnt = &theFristPnt;
108       return aSqDist1;
109     }
110
111     theClosestPnt = &theSecondPnt;
112     return aSqDist2;
113   }
114
115   //! Chooses the most closest points among the given to reference one from the given pair.
116   //! Returns square distance between reference point and closest one as 
117   //! well as pointer to closest point.
118   inline Standard_Real closestPoints(
119     gp_Pnt2d&  theFirstPnt1,
120     gp_Pnt2d&  theSecondPnt1,
121     gp_Pnt2d&  theFirstPnt2,
122     gp_Pnt2d&  theSecondPnt2,
123     gp_Pnt2d*& theClosestPnt1,
124     gp_Pnt2d*& theClosestPnt2) const
125   {
126     gp_Pnt2d *aCurrPrevUV1 = NULL, *aCurrPrevUV2 = NULL;
127     const Standard_Real aSqDist1 = closestPoint(theFirstPnt1,  theFirstPnt2, theSecondPnt2, aCurrPrevUV1);
128     const Standard_Real aSqDist2 = closestPoint(theSecondPnt1, theFirstPnt2, theSecondPnt2, aCurrPrevUV2);
129     if (aSqDist1 - aSqDist2 < gp::Resolution())
130     {
131       theClosestPnt1 = &theFirstPnt1;
132       theClosestPnt2 = aCurrPrevUV1;
133       return aSqDist1;
134     }
135
136     theClosestPnt1 = &theSecondPnt1;
137     theClosestPnt2 = aCurrPrevUV2;
138     return aSqDist2;
139   }
140
141   //! Adjusts the given pair of points supposed to be the same.
142   //! In addition, adjusts another end-point of an edge in order
143   //! to perform correct matching in case of gap.
144   inline void adjustSamePoints(
145     gp_Pnt2d*& theMajorSamePnt1,
146     gp_Pnt2d*& theMinorSamePnt1,
147     gp_Pnt2d*& theMajorSamePnt2,
148     gp_Pnt2d*& theMinorSamePnt2,
149     gp_Pnt2d&  theMajorFirstPnt,
150     gp_Pnt2d&  theMajorLastPnt,
151     gp_Pnt2d&  theMinorFirstPnt,
152     gp_Pnt2d&  theMinorLastPnt) const
153   {
154     if (theMajorSamePnt2 == theMajorSamePnt1)
155     {
156       theMajorSamePnt2 = (theMajorSamePnt2 == &theMajorFirstPnt) ? &theMajorLastPnt : &theMajorFirstPnt;
157       closestPoint(*theMajorSamePnt2, theMinorFirstPnt, theMinorLastPnt, theMinorSamePnt2);
158     }
159
160     *theMajorSamePnt1 = *theMinorSamePnt1;
161     *theMajorSamePnt2 = *theMinorSamePnt2;
162   }
163
164   //! Connects ends of pcurves of face's wires according to topological coherency.
165   void fixFaceBoundaries(const IMeshData::IFaceHandle& theDFace) const;
166
167   //! Returns True if check can be done in parallel.
168   inline Standard_Boolean isParallel() const
169   {
170     return (myParameters.InParallel && myModel->FacesNb() > 1);
171   }
172
173   //! Collects unique edges to be updated from face map. Clears data stored in face map.
174   Standard_Boolean popEdgesToUpdate(IMeshData::MapOfIEdgePtr& theEdgesToUpdate);
175
176 private:
177
178   Handle(IMeshData_Model)                           myModel;
179   IMeshTools_Parameters                             myParameters;
180   Handle(IMeshData::DMapOfIFacePtrsMapOfIEdgePtrs)  myFaceIntersectingEdges;
181 };
182
183 #endif