Salome HOME
Merge from V6_main 01/04/2013
[modules/smesh.git] / src / StdMeshers / StdMeshers_FaceSide.hxx
1 // Copyright (C) 2007-2013  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 Make ignore medium nodes
106    */
107   void SetIgnoreMediumNodes(bool toIgnore);
108
109   /*!
110    * \brief Return nb nodes on edges and vertices (+1 to be == GetUVPtStruct().size() ).
111    *        Call it with update == true if mesh of this side can be recomputed
112    *        since creation of this side
113    */
114   int NbPoints(const bool update = false) const;
115   /*!
116    * \brief Return nb edges
117    *        Call it with update == true if mesh of this side can be recomputed
118    *        since creation of this side
119    */
120   int NbSegments(const bool update = false) const;
121   /*!
122    * \brief Return mesh
123    */
124   SMESH_Mesh* GetMesh() const { return myProxyMesh->GetMesh(); }
125   /*!
126    * \brief Return true if there are vertices without nodes
127    */
128   bool MissVertexNode() const { return myMissingVertexNodes; }
129
130   /*!
131    * \brief Return detailed data on nodes
132     * \param isXConst - true if normalized parameter X is constant
133     * \param constValue - constant parameter value
134     *
135     * Missing nodes are allowed only on internal vertices.
136     * For a closed side, the 1st point repeats at end
137    */
138   const UVPtStructVec& GetUVPtStruct(bool isXConst =0, double constValue =0) const;
139   /*!
140    * \brief Simulates detailed data on nodes
141     * \param isXConst - true if normalized parameter X is constant
142     * \param constValue - constant parameter value
143    */
144   const UVPtStructVec& SimulateUVPtStruct(int    nbSeg,
145                                           bool   isXConst   = 0,
146                                           double constValue = 0) const;
147   /*!
148    * \brief Return nodes in the order they encounter while walking along the side.
149     * For a closed side, the 1st point repeats at end
150    */
151   std::vector<const SMDS_MeshNode*> GetOrderedNodes() const;
152
153   /*!
154    * \brief Return edge and parameter on edge by normalized parameter
155    */
156   inline double Parameter(double U, TopoDS_Edge & edge) const;
157   /*!
158    * \brief Return UV by normalized parameter
159    */
160   gp_Pnt2d Value2d(double U) const;
161   /*!
162    * \brief Return XYZ by normalized parameter
163    */
164   gp_Pnt   Value3d(double U) const;
165   /*!
166    * \brief Creates a Adaptor2d_Curve2d to be used in SMESH_Block
167    */
168   Adaptor2d_Curve2d* GetCurve2d() const;
169   /*!
170    * \brief Creates a fully functional Adaptor_Curve
171    */
172   BRepAdaptor_CompCurve* GetCurve3d() const;
173   /*!
174    * \brief Return nb of wrapped edges
175    */
176   int NbEdges() const { return myEdge.size(); }
177   /*!
178    * \brief Return i-th wrapped edge (count starts from zero)
179    */
180   const TopoDS_Edge& Edge(int i) const { return myEdge[i]; }
181   /*!
182    * \brief Return all edges
183    */
184   const std::vector<TopoDS_Edge>& Edges() const { return myEdge; }
185   /*!
186    * \brief Return 1st vertex of the i-the edge (count starts from zero)
187    */
188   TopoDS_Vertex FirstVertex(int i=0) const;
189   /*!
190    * \brief Return last vertex of the i-the edge (count starts from zero)
191    */
192   TopoDS_Vertex LastVertex(int i=-1) const;
193   /*!
194    * \brief Return side length
195    */
196   double Length() const { return myLength; }
197   /*!
198    * \brief Return edge index corresponding to normalized parameter
199    */
200   inline int EdgeIndex( double U ) const;
201
202   //virtual gp_Pnt Value(double U) const;
203   
204   void dump(const char* msg=0) const;
205   
206   /*!
207    * \brief Return ID of i-th wrapped edge (count starts from zero)
208    */
209   inline int EdgeID(int i) const;
210   /*!
211    * \brief Return p-curve of i-th wrapped edge (count starts from zero)
212    */
213   inline Handle(Geom2d_Curve) Curve2d(int i) const;
214   /*!
215    * \brief Return first normalized parameter of the i-the edge (count starts from zero)
216    */
217   inline double FirstParameter(int i) const;
218   /*!
219    * \brief Return last normalized parameter of the i-the edge (count starts from zero)
220    */
221   inline double LastParameter(int i) const;
222   /*!
223    * \brief Return first parameter of the i-the edge (count starts from zero).
224    *        EDGE orientation is taken into account
225    */
226   inline double FirstU(int i) const;
227   /*!
228    * \brief Return last parameter of the i-the edge (count starts from zero).
229    *        EDGE orientation is taken into account
230    */
231   inline double LastU(int i) const;
232   /*!
233    * \brief Return length of i-th wrapped edge (count starts from zero)
234    */
235   inline double EdgeLength(int i) const;
236   /*!
237    * \brief Return orientation of i-th wrapped edge (count starts from zero)
238    */
239   inline bool IsReversed(int i) const;
240
241 protected:
242
243   void reverseProxySubmesh( const TopoDS_Edge& E );
244
245   // DON't FORGET to update Reverse() when adding one more vector!
246   std::vector<uvPtStruct>           myPoints, myFalsePoints;
247   std::vector<TopoDS_Edge>          myEdge;
248   std::vector<int>                  myEdgeID;
249   std::vector<Handle(Geom2d_Curve)> myC2d;
250   std::vector<GeomAdaptor_Curve>    myC3dAdaptor;
251   std::vector<double>               myFirst, myLast;
252   std::vector<double>               myNormPar;
253   std::vector<double>               myEdgeLength;
254   std::vector<double>               myIsUniform;
255   double                            myLength;
256   int                               myNbPonits, myNbSegments;
257   SMESH_ProxyMesh::Ptr              myProxyMesh;
258   bool                              myMissingVertexNodes, myIgnoreMediumNodes;
259   gp_Pnt2d                          myDefaultPnt2d;
260 };
261
262
263 //================================================================================
264 /*!
265  * \brief Return edge index corresponding to normalized parameter
266   * \param U - the parameter
267   * \retval int - index
268  */
269 //================================================================================
270
271 inline int StdMeshers_FaceSide::EdgeIndex( double U ) const
272 {
273   int i = myNormPar.size() - 1;
274   while ( i > 0 && U < myNormPar[ i-1 ] ) --i;
275   return i;
276 }
277
278 //================================================================================
279 /*!
280  * \brief Return edge and parameter on edge by normalized parameter
281   * \param U - the parameter
282   * \retval double - pameter on a curve
283  */
284 //================================================================================
285
286 inline double StdMeshers_FaceSide::Parameter(double U, TopoDS_Edge & edge) const
287 {
288   int i = EdgeIndex( U );
289   edge = myEdge[ i ];
290   double prevU = i ? myNormPar[ i-1 ] : 0;
291   double r = ( U - prevU )/ ( myNormPar[ i ] - prevU );
292   return myFirst[i] * ( 1 - r ) + myLast[i] * r;
293 }
294
295 //================================================================================
296 /*!
297  * \brief Return first normalized parameter of the i-the edge
298  */
299 //================================================================================
300
301 inline double StdMeshers_FaceSide::FirstParameter(int i) const
302 {
303   return i==0 ? 0. : i<(int)myNormPar.size() ? myNormPar[i-1] : 1.;
304 }
305
306 //================================================================================
307 /*!
308  * \brief Return ast normalized parameter of the i-the edge
309  */
310 //================================================================================
311
312 inline double StdMeshers_FaceSide::LastParameter(int i) const
313 {
314   return i < (int)myNormPar.size() ? myNormPar[i] : 1;
315 }
316
317 //================================================================================
318 /*!
319  * \brief Return first parameter of the i-the edge
320  */
321 //================================================================================
322
323 inline double StdMeshers_FaceSide::FirstU(int i) const
324 {
325   return myFirst[ i % myFirst.size() ];
326 }
327
328 //================================================================================
329 /*!
330  * \brief Return last parameter of the i-the edge
331  */
332 //================================================================================
333
334 inline double StdMeshers_FaceSide::LastU(int i) const
335 {
336   return myLast[ i % myLast.size() ];
337 }
338
339 //================================================================================
340   /*!
341    * \brief Return ID of i-th wrapped edge (count starts from zero)
342    */
343 //================================================================================
344
345 inline int StdMeshers_FaceSide::EdgeID(int i) const
346 {
347   return myEdgeID[ i % myEdgeID.size() ];
348 }
349
350 //================================================================================
351 /*!
352    * \brief Return p-curve of i-th wrapped edge (count starts from zero)
353    */
354 //================================================================================
355
356 inline Handle(Geom2d_Curve) StdMeshers_FaceSide::Curve2d(int i) const
357 {
358   return myC2d[ i % myC2d.size() ];
359 }
360
361 //================================================================================
362 /*!
363  * \brief Return length of i-th wrapped edge (count starts from zero)
364  */
365  //================================================================================
366
367 inline double StdMeshers_FaceSide::EdgeLength(int i) const
368 {
369   return myEdgeLength[ i % myEdgeLength.size() ];
370 }
371
372 //================================================================================
373 /*!
374  * \brief Return orientation of i-th wrapped edge (count starts from zero)
375  */
376  //================================================================================
377
378 inline bool StdMeshers_FaceSide::IsReversed(int i) const
379 {
380   return myFirst[i] > myLast[i];
381 }
382
383 #endif