]> SALOME platform Git repositories - modules/smesh.git/blob - src/SMESHUtils/SMESH_MeshAlgos.hxx
Salome HOME
Fix linkage problem
[modules/smesh.git] / src / SMESHUtils / SMESH_MeshAlgos.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 // File      : SMESH_MeshAlgos.hxx
23 // Created   : Tue Apr 30 18:00:36 2013
24 // Author    : Edward AGAPOV (eap)
25
26 // This file holds some low level algorithms extracted from SMESH_MeshEditor
27 // to make them accessible from Controls package
28
29
30 #ifndef __SMESH_MeshAlgos_HXX__
31 #define __SMESH_MeshAlgos_HXX__
32
33 #include "SMDSAbs_ElementType.hxx"
34 #include "SMDS_ElemIterator.hxx"
35 #include "SMESH_TypeDefs.hxx"
36
37 #include <TopAbs_State.hxx>
38 #include <vector>
39
40 class gp_Pnt;
41 class gp_Ax1;
42 class SMDS_MeshNode;
43 class SMDS_MeshElement;
44 class SMDS_Mesh;
45
46 //=======================================================================
47 /*!
48  * \brief Searcher for the node closest to a point
49  */
50 //=======================================================================
51
52 struct SMESH_NodeSearcher
53 {
54   virtual const SMDS_MeshNode* FindClosestTo( const gp_Pnt& pnt ) = 0;
55   virtual void MoveNode( const SMDS_MeshNode* node, const gp_Pnt& toPnt ) = 0;
56 };
57
58 //=======================================================================
59 /*!
60  * \brief Searcher for elements
61  */
62 //=======================================================================
63
64 struct SMESH_ElementSearcher
65 {
66   /*!
67    * \brief Find elements of given type where the given point is IN or ON.
68    *        Returns nb of found elements and elements them-selves.
69    *
70    * 'ALL' type means elements of any type excluding nodes and 0D elements
71    */
72   virtual int FindElementsByPoint(const gp_Pnt&                           point,
73                                   SMDSAbs_ElementType                     type,
74                                   std::vector< const SMDS_MeshElement* >& foundElems) = 0;
75   /*!
76    * \brief Return an element most close to the given point
77    */
78   virtual const SMDS_MeshElement* FindClosestTo( const gp_Pnt&       point,
79                                                  SMDSAbs_ElementType type) = 0;
80   /*!
81    * \brief Return elements possibly intersecting the line
82    */
83   virtual void GetElementsNearLine( const gp_Ax1&                           line,
84                                     SMDSAbs_ElementType                     type,
85                                     std::vector< const SMDS_MeshElement* >& foundElems) = 0;
86   /*!
87    * \brief Find out if the given point is out of closed 2D mesh.
88    */
89   virtual TopAbs_State GetPointState(const gp_Pnt& point) = 0;
90   virtual ~SMESH_ElementSearcher();
91 };
92
93 namespace SMESH_MeshAlgos
94 {
95   /*!
96    * \brief Return true if the point is IN or ON of the element
97    */
98   bool IsOut( const SMDS_MeshElement* element, const gp_Pnt& point, double tol );
99
100   double GetDistance( const SMDS_MeshFace* face, const gp_Pnt& point );
101
102   /*!
103    * Return a face having linked nodes n1 and n2 and which is
104    * - not in avoidSet,
105    * - in elemSet provided that !elemSet.empty()
106    * i1 and i2 optionally returns indices of n1 and n2
107    */
108   const SMDS_MeshElement* FindFaceInSet(const SMDS_MeshNode*    n1,
109                                         const SMDS_MeshNode*    n2,
110                                         const TIDSortedElemSet& elemSet,
111                                         const TIDSortedElemSet& avoidSet,
112                                         int*                    i1=0,
113                                         int*                    i2=0);
114   /*!
115    * \brief Calculate normal of a mesh face
116    */
117   bool FaceNormal(const SMDS_MeshElement* F, gp_XYZ& normal, bool normalized=true);
118
119   /*!
120    * \brief Return nodes common to two elements
121    */
122   std::vector< const SMDS_MeshNode*> GetCommonNodes(const SMDS_MeshElement* e1,
123                                                     const SMDS_MeshElement* e2);
124
125   /*!
126    * \brief Return SMESH_NodeSearcher. The caller is responsible for deleteing it
127    */
128   SMESH_NodeSearcher* GetNodeSearcher( SMDS_Mesh& mesh );
129
130   /*!
131    * \brief Return SMESH_ElementSearcher. The caller is responsible for deleting it
132    */
133   SMESH_ElementSearcher* GetElementSearcher( SMDS_Mesh& mesh );
134   SMESH_ElementSearcher* GetElementSearcher( SMDS_Mesh& mesh,
135                                              SMDS_ElemIteratorPtr elemIt );
136 }
137
138 #endif