Salome HOME
Merge from BR_V5_DEV 16Feb09
[modules/smesh.git] / src / StdMeshers / StdMeshers_ProjectionUtils.hxx
1 //  Copyright (C) 2007-2008  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 //  SMESH SMESH : idl implementation based on 'SMESH' unit's calsses
23 // File      : StdMeshers_ProjectionUtils.hxx
24 // Created   : Thu Oct 26 15:37:24 2006
25 // Author    : Edward AGAPOV (eap)
26 //
27 #ifndef StdMeshers_ProjectionUtils_HeaderFile
28 #define StdMeshers_ProjectionUtils_HeaderFile
29
30 #include "SMESH_StdMeshers.hxx"
31
32 #include <TopTools_DataMapOfShapeShape.hxx>
33 #include <TopoDS_Edge.hxx>
34 #include <TopoDS_Vertex.hxx>
35 #include <TopoDS_Face.hxx>
36
37 #include <list>
38 #include <map>
39
40 class TopoDS_Shape;
41 class SMDS_MeshNode;
42 class SMESH_Mesh;
43 class SMESH_Hypothesis;
44 class SMESH_subMesh;
45 class TopTools_IndexedDataMapOfShapeListOfShape;
46
47 /*!
48  * \brief Class encapsulating methods common to Projection algorithms
49  */
50 class StdMeshers_ProjectionUtils
51 {
52  public:
53
54   typedef TopTools_DataMapOfShapeShape                         TShapeShapeMap;
55   typedef TopTools_IndexedDataMapOfShapeListOfShape            TAncestorMap;
56   typedef std::map<const SMDS_MeshNode*, const SMDS_MeshNode*> TNodeNodeMap;
57
58   /*!
59    * \brief Looks for association of all subshapes of two shapes
60     * \param theShape1 - shape 1
61     * \param theMesh1 - mesh built on shape 1
62     * \param theShape2 - shape 2
63     * \param theMesh2 - mesh built on shape 2
64     * \param theAssociation - association map to be filled that may
65     *                         contain association of one or two pairs of vertices
66     * \retval bool - true if association found
67    */
68   static bool FindSubShapeAssociation(const TopoDS_Shape& theShape1,
69                                       SMESH_Mesh*         theMesh1,
70                                       const TopoDS_Shape& theShape2,
71                                       SMESH_Mesh*         theMesh2,
72                                       TShapeShapeMap &    theAssociationMap);
73
74   /*!
75    * \brief Find association of edges of faces
76     * \param face1 - face 1
77     * \param VV1 - vertices of face 1
78     * \param face2 - face 2
79     * \param VV2 - vertices of face 2 associated with oned of face 1
80     * \param edges1 - out list of edges of face 1
81     * \param edges2 - out list of edges of face 2
82     * \retval int - nb of edges in an outer wire in a success case, else zero
83    */
84   static int FindFaceAssociation(const TopoDS_Face&    face1,
85                                  TopoDS_Vertex         VV1[2],
86                                  const TopoDS_Face&    face2,
87                                  TopoDS_Vertex         VV2[2],
88                                  std::list< TopoDS_Edge > & edges1,
89                                  std::list< TopoDS_Edge > & edges2);
90
91   /*!
92    * \brief Insert vertex association defined by a hypothesis into a map
93     * \param theHyp - hypothesis
94     * \param theAssociationMap - association map
95     * \param theTargetShape - the shape theHyp assigned to
96    */
97   static void InitVertexAssociation( const SMESH_Hypothesis* theHyp,
98                                      TShapeShapeMap &        theAssociationMap,
99                                      const TopoDS_Shape&     theTargetShape);
100
101   /*!
102    * \brief Inserts association theShape1 <-> theShape2 to TShapeShapeMap
103     * \param theShape1 - shape 1
104     * \param theShape2 - shape 2
105     * \param theAssociationMap - association map 
106     * \param theBidirectional - if false, inserts theShape1 -> theShape2 association
107     * \retval bool - true if there was no association for these shapes before
108    */
109   static bool InsertAssociation( const TopoDS_Shape& theShape1,
110                                  const TopoDS_Shape& theShape2,
111                                  TShapeShapeMap &    theAssociationMap,
112                                  const bool          theBidirectional=true);
113
114   static bool IsSubShape( const TopoDS_Shape& shape, SMESH_Mesh* aMesh );
115
116   static bool IsSubShape( const TopoDS_Shape& shape, const TopoDS_Shape& mainShape );
117
118   /*!
119    * \brief Finds an edge by its vertices in a main shape of the mesh
120    */
121   static TopoDS_Edge GetEdgeByVertices( SMESH_Mesh*          aMesh,
122                                         const TopoDS_Vertex& V1,
123                                         const TopoDS_Vertex& V2);
124                                         
125   /*!
126    * \brief Return another face sharing an edge
127    * \param edgeToFaces - data map of descendants to ancestors
128    */
129   static TopoDS_Face GetNextFace( const TAncestorMap& edgeToFaces,
130                                   const TopoDS_Edge&  edge,
131                                   const TopoDS_Face&  face);
132   /*!
133    * \brief Return other vertex of an edge
134    */
135   static TopoDS_Vertex GetNextVertex(const TopoDS_Edge&   edge,
136                                      const TopoDS_Vertex& vertex);
137
138   /*!
139    * \brief Return an oriented propagation edge
140     * \param aMesh - mesh
141     * \param fromEdge - start edge for propagation
142     * \retval pair<int,TopoDS_Edge> - propagation step and found edge
143    */
144   static std::pair<int,TopoDS_Edge> GetPropagationEdge( SMESH_Mesh*        aMesh,
145                                                         const TopoDS_Edge& anEdge,
146                                                         const TopoDS_Edge& fromEdge);
147
148   /*!
149    * \brief Find corresponding nodes on two faces
150     * \param face1 - the first face
151     * \param mesh1 - mesh containing elements on the first face
152     * \param face2 - the second face
153     * \param mesh2 - mesh containing elements on the second face
154     * \param assocMap - map associating subshapes of the faces
155     * \param nodeIn2OutMap - map containing found matching nodes
156     * \retval bool - is a success
157    */
158   static bool FindMatchingNodesOnFaces( const TopoDS_Face&     face1,
159                                         SMESH_Mesh*            mesh1,
160                                         const TopoDS_Face&     face2,
161                                         SMESH_Mesh*            mesh2,
162                                         const TShapeShapeMap & assocMap,
163                                         TNodeNodeMap &         nodeIn2OutMap);
164   /*!
165    * \brief Check if the first and last vertices of an edge are the same
166     * \param anEdge - the edge to check
167     * \retval bool - true if same
168    */
169   static bool IsClosedEdge( const TopoDS_Edge& anEdge );
170
171   /*!
172    * \brief Return any subshape of a face belonging to the outer wire
173     * \param face - the face
174     * \param type - type of subshape to return
175     * \retval TopoDS_Shape - the found subshape
176    */
177   static TopoDS_Shape OuterShape( const TopoDS_Face& face,
178                                   TopAbs_ShapeEnum   type);
179
180   /*!
181    * \brief Check that submeshis is computed and try to compute it if is not
182     * \param sm - submesh to compute
183     * \param iterationNb - int used to stop infinite recursive call
184     * \retval bool - true if computed
185    */
186   static bool MakeComputed(SMESH_subMesh * sm, const int iterationNb = 0);
187
188   /*!
189    * \brief Count nb of subshapes
190     * \param shape - the shape
191     * \param type - the type of subshapes to count
192     * \param ignoreSame - if true, use map not to count same shapes, esle use explorer
193     * \retval int - the calculated number
194    */
195   static int Count(const TopoDS_Shape&    shape,
196                    const TopAbs_ShapeEnum type,
197                    const bool             ignoreSame);
198
199   /*!
200    * \brief Set event listeners to submesh with projection algo
201     * \param subMesh - submesh with projection algo
202     * \param srcShape - source shape
203     * \param srcMesh - source mesh
204    */
205   static void SetEventListener(SMESH_subMesh* subMesh,
206                                TopoDS_Shape   srcShape,
207                                SMESH_Mesh*    srcMesh);
208
209 };
210
211 #endif