Salome HOME
Added help page and revert some changes for a better ergonomy
[modules/geom.git] / src / NMTTools / NMTTools_FaceInfo.hxx
1 // Copyright (C) 2007-2011  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 #ifndef _NMTTools_FaceInfo_HeaderFile
24 #define _NMTTools_FaceInfo_HeaderFile
25
26 #ifndef _Standard_Integer_HeaderFile
27 #include <Standard_Integer.hxx>
28 #endif
29 #ifndef _NMTTools_MapOfPaveBlock_HeaderFile
30 #include <NMTTools_MapOfPaveBlock.hxx>
31 #endif
32 #ifndef _TColStd_MapOfInteger_HeaderFile
33 #include <TColStd_MapOfInteger.hxx>
34 #endif
35 class NMTTools_MapOfPaveBlock;
36 class TColStd_MapOfInteger;
37
38
39 #ifndef _Standard_HeaderFile
40 #include <Standard.hxx>
41 #endif
42 #ifndef _Standard_Macro_HeaderFile
43 #include <Standard_Macro.hxx>
44 #endif
45
46
47 class NMTTools_FaceInfo  {
48
49 public:
50
51     void* operator new(size_t,void* anAddress) 
52       {
53         return anAddress;
54       }
55     void* operator new(size_t size) 
56       { 
57         return Standard::Allocate(size); 
58       }
59     void  operator delete(void *anAddress) 
60       { 
61         if (anAddress) Standard::Free((Standard_Address&)anAddress); 
62       }
63  // Methods PUBLIC
64  // 
65
66 //! Empty contructor <br>
67 //! <br>
68 NMTTools_FaceInfo();
69 virtual ~NMTTools_FaceInfo();
70
71
72 //!  Clears the contents <br>
73 Standard_EXPORT   void Clear() ;
74
75 //! Modifier <br>
76 //! Sets the index of the face <theI> <br>
77   void SetIndex(const Standard_Integer theI) ;
78
79 //! Selector <br>
80 //! Returns the index of the face <br>
81 //! <br>
82 //! In <br>
83 //! <br>
84   Standard_Integer Index() const;
85
86 //! Selector <br>
87 //! Returns the pave blocks of the face <br>
88 //! that  have state In <br>
89  const NMTTools_MapOfPaveBlock& PaveBlocksIn() const;
90
91 //! Selector/Modifier <br>
92 //! Returns the pave blocks <br>
93 //!  of the face <br>
94 //! that  have state In <br>
95   NMTTools_MapOfPaveBlock& ChangePaveBlocksIn() ;
96
97 //! Selector <br>
98 //! Returns the list of indices for vertices <br>
99 //!  of the face <br>
100 //! that have state In <br>
101  const TColStd_MapOfInteger& VerticesIn() const;
102
103 //! Selector/Modifier <br>
104 //! Returns the list of indices for vertices <br>
105 //!  of the face <br>
106 //! that have state In <br>
107 //! <br>
108 //! On <br>
109 //! <br>
110   TColStd_MapOfInteger& ChangeVerticesIn() ;
111
112 //! Selector <br>
113 //! Returns the pave blocks of the face <br>
114 //! that  have state On <br>
115  const NMTTools_MapOfPaveBlock& PaveBlocksOn() const;
116
117 //! Selector/Modifier <br>
118 //! Returns the pave blocks <br>
119 //!  of the face <br>
120 //! that  have state On <br>
121   NMTTools_MapOfPaveBlock& ChangePaveBlocksOn() ;
122
123 //! Selector <br>
124 //! Returns the list of indices for vertices <br>
125 //!  of the face <br>
126 //! that have state On <br>
127  const TColStd_MapOfInteger& VerticesOn() const;
128
129 //! Selector/Modifier <br>
130 //! Returns the list of indices for vertices <br>
131 //!  of the face <br>
132 //! that have state On <br>
133   TColStd_MapOfInteger& ChangeVerticesOn() ;
134
135
136
137
138
139 protected:
140
141  // Methods PROTECTED
142  // 
143
144
145  // Fields PROTECTED
146  //
147 Standard_Integer myIndex;
148 NMTTools_MapOfPaveBlock myPaveBlocksIn;
149 TColStd_MapOfInteger myVerticesIn;
150 NMTTools_MapOfPaveBlock myPaveBlocksOn;
151 TColStd_MapOfInteger myVerticesOn;
152
153
154 private: 
155
156  // Methods PRIVATE
157  // 
158
159
160  // Fields PRIVATE
161  //
162
163
164 };
165
166
167 #include <NMTTools_FaceInfo.lxx>
168
169
170
171 // other Inline functions and methods (like "C++: function call" methods)
172 //
173
174
175 #endif