Salome HOME
Fix documentation problems (reported as doxygen warnings)
[modules/geom.git] / src / NMTAlgo / NMTAlgo_Tools.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 #ifndef _NMTAlgo_Tools_HeaderFile
23 #define _NMTAlgo_Tools_HeaderFile
24
25 #ifndef _TopAbs_Orientation_HeaderFile
26 #include <TopAbs_Orientation.hxx>
27 #endif
28 #ifndef _Standard_Integer_HeaderFile
29 #include <Standard_Integer.hxx>
30 #endif
31 #ifndef _Standard_Boolean_HeaderFile
32 #include <Standard_Boolean.hxx>
33 #endif
34 class TopoDS_Shell;
35 class TopoDS_Face;
36 class TopoDS_Edge;
37 class TopoDS_Shape;
38 class TopTools_ListOfShape;
39 class TopTools_IndexedMapOfShape;
40
41
42 #ifndef _Standard_HeaderFile
43 #include <Standard.hxx>
44 #endif
45 #ifndef _Standard_Macro_HeaderFile
46 #include <Standard_Macro.hxx>
47 #endif
48
49 class NMTAlgo_Tools  {
50
51 public:
52
53     void* operator new(size_t,void* anAddress) 
54       {
55         return anAddress;
56       }
57     void* operator new(size_t size) 
58       { 
59         return Standard::Allocate(size); 
60       }
61     void  operator delete(void *anAddress) 
62       { 
63         if (anAddress) Standard::Free((Standard_Address&)anAddress); 
64       }
65  // Methods PUBLIC
66  // 
67 Standard_EXPORT static  void OrientFacesOnShell(const TopoDS_Shell& aShell,TopoDS_Shell& aShellNew) ;
68 Standard_EXPORT static  void OrientFacesOnShell(const TopoDS_Face& aF,TopoDS_Shell& aSh) ;
69 Standard_EXPORT static  TopAbs_Orientation Orientation(const TopoDS_Edge& aE,const TopoDS_Face& aF) ;
70 Standard_EXPORT static  Standard_Integer Sense(const TopoDS_Face& aF1,const TopoDS_Face& aF2) ;
71 Standard_EXPORT static  Standard_Boolean IsInside(const TopoDS_Shape& aS1,const TopoDS_Shape& aS2) ;
72 Standard_EXPORT static  void MakeShells(const TopoDS_Shape& aFC,TopTools_ListOfShape& aLS) ;
73 Standard_EXPORT static  void MakeSolids(TopTools_ListOfShape& aLS) ;
74 Standard_EXPORT static  void MakeSolids(const TopoDS_Shape& aFC,TopTools_ListOfShape& aLS) ;
75 Standard_EXPORT static  void BreakWebs(const TopoDS_Shape& aS1,TopoDS_Shape& aS2) ;
76 Standard_EXPORT static  Standard_Boolean FindImageSolid(const TopoDS_Shape& aFC,const TopTools_IndexedMapOfShape& aMSo,TopoDS_Shape& aSo) ;
77
78
79
80
81
82 protected:
83
84  // Methods PROTECTED
85  // 
86
87
88  // Fields PROTECTED
89  //
90
91
92 private: 
93
94  // Methods PRIVATE
95  // 
96
97
98  // Fields PRIVATE
99  //
100
101
102 };
103
104
105
106
107
108 // other Inline functions and methods (like "C++: function call" methods)
109 //
110
111
112 #endif