Salome HOME
Merge from V6_main_20120808 08Aug12
[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 <Geom2d_Curve.hxx>
34 #include <GeomAdaptor_Curve.hxx>
35 #include <TopoDS_Edge.hxx>
36 #include <TopoDS_Vertex.hxx>
37 #include <gp_Pnt2d.hxx>
38
39 #include <vector>
40 #include <list>
41 #include <boost/shared_ptr.hpp>
42
43 class SMDS_MeshNode;
44 class SMESH_Mesh;
45 class Adaptor2d_Curve2d;
46 class Adaptor3d_Curve;
47 class BRepAdaptor_CompCurve;
48 class TopoDS_Face;
49 struct SMESH_ComputeError;
50
51 typedef struct uvPtStruct
52 {
53   double param;
54   //int    curvIndex;
55   double normParam;
56   double u; // original 2d parameter
57   double v;
58   double x; // 2d parameter, normalized [0,1]
59   double y;
60   const SMDS_MeshNode * node;
61 } UVPtStruct;
62
63 class StdMeshers_FaceSide;
64 typedef boost::shared_ptr< StdMeshers_FaceSide > StdMeshers_FaceSidePtr;
65 typedef std::vector< StdMeshers_FaceSidePtr >    TSideVector;
66 typedef boost::shared_ptr< SMESH_ComputeError >  TError;
67
68 //================================================================================
69 /*!
70  * \brief Represents a side of a quasi quadrilateral face.
71  * It can be composed of several edges. Gives access to geometry and 1D mesh of a side.
72  */
73 //================================================================================
74
75 class STDMESHERS_EXPORT StdMeshers_FaceSide
76 {
77 public:
78   /*!
79    * \brief Wrap one edge
80    */
81   StdMeshers_FaceSide(const TopoDS_Face& theFace,
82                       const TopoDS_Edge& theEdge,
83                       SMESH_Mesh*        theMesh,
84                       const bool         theIsForward,
85                       const bool         theIgnoreMediumNodes);
86   /*!
87    * \brief Wrap several edges. Edges must be properly ordered and oriented.
88    */
89   StdMeshers_FaceSide(const TopoDS_Face&      theFace,
90                       std::list<TopoDS_Edge>& theEdges,
91                       SMESH_Mesh*             theMesh,
92                       const bool              theIsForward,
93                       const bool              theIgnoreMediumNodes);
94   /*!
95    * \brief Simulate a side from a vertex using data from other FaceSide
96    */
97   StdMeshers_FaceSide(const SMDS_MeshNode*       theNode,
98                       const gp_Pnt2d             thePnt2d,
99                       const StdMeshers_FaceSide* theSide);
100   /*!
101    * \brief Return wires of a face as StdMeshers_FaceSide's
102    */
103   static TSideVector GetFaceWires(const TopoDS_Face& theFace,
104                                   SMESH_Mesh &       theMesh,
105                                   const bool         theIgnoreMediumNodes,
106                                   TError &           theError);  
107
108   /*!
109    * \brief Change orientation of side geometry
110    */
111   void Reverse();
112   /*!
113    * \brief Return nb nodes on edges and vertices (+1 to be == GetUVPtStruct().size() )
114    */
115   int NbPoints() const { return myNbPonits; }
116   /*!
117    * \brief Return nb edges
118    */
119   int NbSegments() const { return myNbSegments; }
120   /*!
121    * \brief Return mesh
122    */
123   SMESH_Mesh* GetMesh() const { return myMesh; }
124   /*!
125    * \brief Return true if there are vertices without nodes
126    */
127   bool MissVertexNode() const { return myMissingVertexNodes; }
128   /*!
129    * \brief Return detailed data on nodes
130     * \param isXConst - true if normalized parameter X is constant
131     * \param constValue - constant parameter value
132     *
133     * Missing nodes are allowed only on internal vertices.
134     * For a closed side, the 1st point repeats at end
135    */
136   const std::vector<UVPtStruct>& GetUVPtStruct(bool isXConst =0, double constValue =0) const;
137   /*!
138    * \brief Simulates detailed data on nodes
139     * \param isXConst - true if normalized parameter X is constant
140     * \param constValue - constant parameter value
141    */
142   const std::vector<UVPtStruct>& SimulateUVPtStruct(int    nbSeg,
143                                                     bool   isXConst   = 0,
144                                                     double constValue = 0) const;
145   /*!
146    * \brief Return nodes in the order they encounter while walking along the side.
147     * For a closed side, the 1st point repeats at end
148    */
149   std::vector<const SMDS_MeshNode*> GetOrderedNodes() const;
150   /*!
151    * \brief Return edge and parameter on edge by normalized parameter
152    */
153   inline double Parameter(double U, TopoDS_Edge & edge) const;
154   /*!
155    * \brief Return UV by normalized parameter
156    */
157   gp_Pnt2d Value2d(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 first normalized parameter of the i-the edge (count starts from zero)
188    */
189   inline double FirstParameter(int i) const;
190   /*!
191    * \brief Return ast normalized parameter of the i-the edge (count starts from zero)
192    */
193   inline double LastParameter(int i) const;
194   /*!
195    * \brief Return side length
196    */
197   double Length() const { return myLength; }
198   /*!
199    * \brief Return edge index corresponding to normalized parameter
200    */
201   inline int EdgeIndex( double U ) const;
202
203   //virtual gp_Pnt Value(double U) const;
204   
205   void dump(const char* msg=0) const;
206   
207
208 protected:
209
210   // DON't FORGET to update Reverse() when adding one more vector!
211   std::vector<uvPtStruct>           myPoints, myFalsePoints;
212   std::vector<TopoDS_Edge>          myEdge;
213   std::vector<int>                  myEdgeID;
214   std::vector<Handle(Geom2d_Curve)> myC2d;
215   std::vector<GeomAdaptor_Curve>    myC3dAdaptor;
216   std::vector<double>               myFirst, myLast;
217   std::vector<double>               myNormPar;
218   std::vector<double>               myEdgeLength;
219   std::vector<double>               myIsUniform;
220   double                            myLength;
221   int                               myNbPonits, myNbSegments;
222   SMESH_Mesh*                       myMesh;
223   bool                              myMissingVertexNodes, myIgnoreMediumNodes;
224   gp_Pnt2d                          myDefaultPnt2d;
225 };
226
227
228 //================================================================================
229 /*!
230  * \brief Return edge index corresponding to normalized parameter
231   * \param U - the parameter
232   * \retval int - index
233  */
234 //================================================================================
235
236 inline int StdMeshers_FaceSide::EdgeIndex( double U ) const
237 {
238   int i = myNormPar.size() - 1;
239   while ( i > 0 && U < myNormPar[ i-1 ] ) --i;
240   return i;
241 }
242
243 //================================================================================
244 /*!
245  * \brief Return edge and parameter on edge by normalized parameter
246   * \param U - the parameter
247   * \retval double - pameter on a curve
248  */
249 //================================================================================
250
251 inline double StdMeshers_FaceSide::Parameter(double U, TopoDS_Edge & edge) const
252 {
253   int i = EdgeIndex( U );
254   edge = myEdge[ i ];
255   double prevU = i ? myNormPar[ i-1 ] : 0;
256   double r = ( U - prevU )/ ( myNormPar[ i ] - prevU );
257   return myFirst[i] * ( 1 - r ) + myLast[i] * r;
258 }
259
260 //================================================================================
261 /*!
262  * \brief Return first normalized parameter of the i-the edge
263  */
264 //================================================================================
265
266 inline double StdMeshers_FaceSide::FirstParameter(int i) const
267 {
268   return i==0 ? 0. : i<myNormPar.size() ? myNormPar[i-1] : 1.;
269 }
270
271 //================================================================================
272 /*!
273  * \brief Return ast normalized parameter of the i-the edge
274  */
275 //================================================================================
276
277 inline double StdMeshers_FaceSide::LastParameter(int i) const
278 {
279   return i<myNormPar.size() ? myNormPar[i] : 1;
280 }
281
282 #endif