Salome HOME
0021893: EDF 2133 SMESH : Improvement of 3D extrusion algorithm
[modules/smesh.git] / src / StdMeshers / StdMeshers_FaceSide.hxx
1 // Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
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.
10 //
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.
15 //
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
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 // File      : StdMeshers_FaceSide.hxx
24 // Created   : Wed Jan 31 18:41:25 2007
25 // Author    : Edward AGAPOV (eap)
26 // Module    : SMESH
27 //
28 #ifndef StdMeshers_FaceSide_HeaderFile
29 #define StdMeshers_FaceSide_HeaderFile
30
31 #include "SMESH_StdMeshers.hxx"
32
33 #include "SMESH_ProxyMesh.hxx"
34
35 #include <Geom2d_Curve.hxx>
36 #include <GeomAdaptor_Curve.hxx>
37 #include <TopoDS_Edge.hxx>
38 #include <TopoDS_Vertex.hxx>
39 #include <gp_Pnt2d.hxx>
40
41 #include <vector>
42 #include <list>
43 #include <boost/shared_ptr.hpp>
44
45 class SMDS_MeshNode;
46 class SMESH_Mesh;
47 class Adaptor2d_Curve2d;
48 class Adaptor3d_Curve;
49 class BRepAdaptor_CompCurve;
50 class TopoDS_Face;
51 struct SMESH_ComputeError;
52 class StdMeshers_FaceSide;
53
54 typedef boost::shared_ptr< SMESH_ComputeError >  TError;
55 typedef boost::shared_ptr< StdMeshers_FaceSide > StdMeshers_FaceSidePtr;
56 typedef std::vector< StdMeshers_FaceSidePtr >    TSideVector;
57
58 //================================================================================
59 /*!
60  * \brief Represents a side of a quasi quadrilateral face.
61  * It can be composed of several edges. Gives access to geometry and 1D mesh of a side.
62  */
63 //================================================================================
64
65 class STDMESHERS_EXPORT StdMeshers_FaceSide
66 {
67 public:
68   /*!
69    * \brief Wrap one edge
70    */
71   StdMeshers_FaceSide(const TopoDS_Face&   theFace,
72                       const TopoDS_Edge&   theEdge,
73                       SMESH_Mesh*          theMesh,
74                       const bool           theIsForward,
75                       const bool           theIgnoreMediumNodes,
76                       SMESH_ProxyMesh::Ptr theProxyMesh = SMESH_ProxyMesh::Ptr());
77   /*!
78    * \brief Wrap several edges. Edges must be properly ordered and oriented.
79    */
80   StdMeshers_FaceSide(const TopoDS_Face&      theFace,
81                       std::list<TopoDS_Edge>& theEdges,
82                       SMESH_Mesh*             theMesh,
83                       const bool              theIsForward,
84                       const bool              theIgnoreMediumNodes,
85                       SMESH_ProxyMesh::Ptr    theProxyMesh = SMESH_ProxyMesh::Ptr());
86   /*!
87    * \brief Simulate a side from a vertex using data from other FaceSide
88    */
89   StdMeshers_FaceSide(const SMDS_MeshNode*       theNode,
90                       const gp_Pnt2d             thePnt2d,
91                       const StdMeshers_FaceSide* theSide);
92   /*!
93    * \brief Return wires of a face as StdMeshers_FaceSide's
94    */
95   static TSideVector GetFaceWires(const TopoDS_Face&   theFace,
96                                   SMESH_Mesh &         theMesh,
97                                   const bool           theIgnoreMediumNodes,
98                                   TError &             theError,
99                                   SMESH_ProxyMesh::Ptr theProxyMesh = SMESH_ProxyMesh::Ptr());
100   /*!
101    * \brief Change orientation of side geometry
102    */
103   void Reverse();
104   /*!
105    * \brief Return nb nodes on edges and vertices (+1 to be == GetUVPtStruct().size() ).
106    *        Call it with update == true if mesh of this side can be recomputed
107    *        since creation of this side
108    */
109   int NbPoints(const bool update = false) const;
110   /*!
111    * \brief Return nb edges
112    *        Call it with update == true if mesh of this side can be recomputed
113    *        since creation of this side
114    */
115   int NbSegments(const bool update = false) const;
116   /*!
117    * \brief Return mesh
118    */
119   SMESH_Mesh* GetMesh() const { return myProxyMesh->GetMesh(); }
120   /*!
121    * \brief Return true if there are vertices without nodes
122    */
123   bool MissVertexNode() const { return myMissingVertexNodes; }
124   /*!
125    * \brief Return detailed data on nodes
126     * \param isXConst - true if normalized parameter X is constant
127     * \param constValue - constant parameter value
128     *
129     * Missing nodes are allowed only on internal vertices.
130     * For a closed side, the 1st point repeats at end
131    */
132   const UVPtStructVec& GetUVPtStruct(bool isXConst =0, double constValue =0) const;
133   /*!
134    * \brief Simulates detailed data on nodes
135     * \param isXConst - true if normalized parameter X is constant
136     * \param constValue - constant parameter value
137    */
138   const UVPtStructVec& SimulateUVPtStruct(int    nbSeg,
139                                           bool   isXConst   = 0,
140                                           double constValue = 0) const;
141   /*!
142    * \brief Return nodes in the order they encounter while walking along the side.
143     * For a closed side, the 1st point repeats at end
144    */
145   std::vector<const SMDS_MeshNode*> GetOrderedNodes() const;
146   /*!
147    * \brief Return edge and parameter on edge by normalized parameter
148    */
149   inline double Parameter(double U, TopoDS_Edge & edge) const;
150   /*!
151    * \brief Return UV by normalized parameter
152    */
153   gp_Pnt2d Value2d(double U) const;
154   /*!
155    * \brief Return XYZ by normalized parameter
156    */
157   gp_Pnt   Value3d(double U) const;
158   /*!
159    * \brief Creates a Adaptor2d_Curve2d to be used in SMESH_Block
160    */
161   Adaptor2d_Curve2d* GetCurve2d() const;
162   /*!
163    * \brief Creates a fully functional Adaptor_Curve
164    */
165   BRepAdaptor_CompCurve* GetCurve3d() const;
166   /*!
167    * \brief Return nb of wrapped edges
168    */
169   int NbEdges() const { return myEdge.size(); }
170   /*!
171    * \brief Return i-th wrapped edge (count starts from zero)
172    */
173   const TopoDS_Edge& Edge(int i) const { return myEdge[i]; }
174   /*!
175    * \brief Return all edges
176    */
177   const std::vector<TopoDS_Edge>& Edges() const { return myEdge; }
178   /*!
179    * \brief Return 1st vertex of the i-the edge (count starts from zero)
180    */
181   TopoDS_Vertex FirstVertex(int i=0) const;
182   /*!
183    * \brief Return last vertex of the i-the edge (count starts from zero)
184    */
185   TopoDS_Vertex LastVertex(int i=-1) const;
186   /*!
187    * \brief Return side length
188    */
189   double Length() const { return myLength; }
190   /*!
191    * \brief Return edge index corresponding to normalized parameter
192    */
193   inline int EdgeIndex( double U ) const;
194
195   //virtual gp_Pnt Value(double U) const;
196   
197   void dump(const char* msg=0) const;
198   
199   /*!
200    * \brief Return ID of i-th wrapped edge (count starts from zero)
201    */
202   inline int EdgeID(int i) const;
203   /*!
204    * \brief Return p-curve of i-th wrapped edge (count starts from zero)
205    */
206   inline Handle(Geom2d_Curve) Curve2d(int i) const;
207   /*!
208    * \brief Return first normalized parameter of the i-the edge (count starts from zero)
209    */
210   inline double FirstParameter(int i) const;
211   /*!
212    * \brief Return last normalized parameter of the i-the edge (count starts from zero)
213    */
214   inline double LastParameter(int i) const;
215   /*!
216    * \brief Return first parameter of the i-the edge (count starts from zero).
217    *        EDGE orientation is taken into account
218    */
219   inline double FirstU(int i) const;
220   /*!
221    * \brief Return last parameter of the i-the edge (count starts from zero).
222    *        EDGE orientation is taken into account
223    */
224   inline double LastU(int i) const;
225   /*!
226    * \brief Return length of i-th wrapped edge (count starts from zero)
227    */
228   inline double EdgeLength(int i) const;
229   /*!
230    * \brief Return orientation of i-th wrapped edge (count starts from zero)
231    */
232   inline bool IsReversed(int i) const;
233
234 protected:
235
236   void reverseProxySubmesh( const TopoDS_Edge& E );
237
238   // DON't FORGET to update Reverse() when adding one more vector!
239   std::vector<uvPtStruct>           myPoints, myFalsePoints;
240   std::vector<TopoDS_Edge>          myEdge;
241   std::vector<int>                  myEdgeID;
242   std::vector<Handle(Geom2d_Curve)> myC2d;
243   std::vector<GeomAdaptor_Curve>    myC3dAdaptor;
244   std::vector<double>               myFirst, myLast;
245   std::vector<double>               myNormPar;
246   std::vector<double>               myEdgeLength;
247   std::vector<double>               myIsUniform;
248   double                            myLength;
249   int                               myNbPonits, myNbSegments;
250   SMESH_ProxyMesh::Ptr              myProxyMesh;
251   bool                              myMissingVertexNodes, myIgnoreMediumNodes;
252   gp_Pnt2d                          myDefaultPnt2d;
253 };
254
255
256 //================================================================================
257 /*!
258  * \brief Return edge index corresponding to normalized parameter
259   * \param U - the parameter
260   * \retval int - index
261  */
262 //================================================================================
263
264 inline int StdMeshers_FaceSide::EdgeIndex( double U ) const
265 {
266   int i = myNormPar.size() - 1;
267   while ( i > 0 && U < myNormPar[ i-1 ] ) --i;
268   return i;
269 }
270
271 //================================================================================
272 /*!
273  * \brief Return edge and parameter on edge by normalized parameter
274   * \param U - the parameter
275   * \retval double - pameter on a curve
276  */
277 //================================================================================
278
279 inline double StdMeshers_FaceSide::Parameter(double U, TopoDS_Edge & edge) const
280 {
281   int i = EdgeIndex( U );
282   edge = myEdge[ i ];
283   double prevU = i ? myNormPar[ i-1 ] : 0;
284   double r = ( U - prevU )/ ( myNormPar[ i ] - prevU );
285   return myFirst[i] * ( 1 - r ) + myLast[i] * r;
286 }
287
288 //================================================================================
289 /*!
290  * \brief Return first normalized parameter of the i-the edge
291  */
292 //================================================================================
293
294 inline double StdMeshers_FaceSide::FirstParameter(int i) const
295 {
296   return i==0 ? 0. : i<(int)myNormPar.size() ? myNormPar[i-1] : 1.;
297 }
298
299 //================================================================================
300 /*!
301  * \brief Return ast normalized parameter of the i-the edge
302  */
303 //================================================================================
304
305 inline double StdMeshers_FaceSide::LastParameter(int i) const
306 {
307   return i < (int)myNormPar.size() ? myNormPar[i] : 1;
308 }
309
310 //================================================================================
311 /*!
312  * \brief Return first parameter of the i-the edge
313  */
314 //================================================================================
315
316 inline double StdMeshers_FaceSide::FirstU(int i) const
317 {
318   return myFirst[ i % myFirst.size() ];
319 }
320
321 //================================================================================
322 /*!
323  * \brief Return last parameter of the i-the edge
324  */
325 //================================================================================
326
327 inline double StdMeshers_FaceSide::LastU(int i) const
328 {
329   return myLast[ i % myLast.size() ];
330 }
331
332 //================================================================================
333   /*!
334    * \brief Return ID of i-th wrapped edge (count starts from zero)
335    */
336 //================================================================================
337
338 inline int StdMeshers_FaceSide::EdgeID(int i) const
339 {
340   return myEdgeID[ i % myEdgeID.size() ];
341 }
342
343 //================================================================================
344 /*!
345    * \brief Return p-curve of i-th wrapped edge (count starts from zero)
346    */
347 //================================================================================
348
349 inline Handle(Geom2d_Curve) StdMeshers_FaceSide::Curve2d(int i) const
350 {
351   return myC2d[ i % myC2d.size() ];
352 }
353
354 //================================================================================
355 /*!
356  * \brief Return length of i-th wrapped edge (count starts from zero)
357  */
358  //================================================================================
359
360 inline double StdMeshers_FaceSide::EdgeLength(int i) const
361 {
362   return myEdgeLength[ i % myEdgeLength.size() ];
363 }
364
365 //================================================================================
366 /*!
367  * \brief Return orientation of i-th wrapped edge (count starts from zero)
368  */
369  //================================================================================
370
371 inline bool StdMeshers_FaceSide::IsReversed(int i) const
372 {
373   return myFirst[i] > myLast[i];
374 }
375
376 #endif