Cleanup: misc spelling fixes
[blender.git] / source / blender / freestyle / intern / geometry / GeomCleaner.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __GEOMCLEANER_H__
18 #define __GEOMCLEANER_H__
19
20 /** \file
21  * \ingroup freestyle
22  * \brief Class to define a cleaner of geometry providing a set of useful tools
23  */
24
25 #include "Geom.h"
26
27 #include "../system/FreestyleConfig.h"
28
29 #ifdef WITH_CXX_GUARDEDALLOC
30 #  include "MEM_guardedalloc.h"
31 #endif
32
33 namespace Freestyle {
34
35 using namespace Geometry;
36
37 class GeomCleaner {
38  public:
39   inline GeomCleaner()
40   {
41   }
42   inline ~GeomCleaner()
43   {
44   }
45
46   /*! Sorts an array of Indexed vertices
47    *    iVertices
48    *      Array of vertices to sort.
49    *      It is organized as a float series of vertex coordinates: XYZXYZXYZ...
50    *    iVSize
51    *      The size of iVertices array.
52    *    iIndices
53    *      The array containing the vertex indices
54    *      (used to refer to the vertex coordinates in an indexed face).
55    *      Each element is an unsignedeger multiple of 3.
56    *    iISize
57    *      The size of iIndices array
58    *    oVertices
59    *      Output of sorted vertices.
60    *      A vertex v1 precedes another one v2 in this array
61    *      if v1.x<v2.x, or v1.x=v2.x && v1.y < v2.y or v1.x=v2.y && v1.y=v2.y && v1.z < v2.z.
62    *      The array is organized as a 3-float serie giving the vertices coordinates: XYZXYZXYZ...
63    *    oIndices
64    *      Output corresponding to the iIndices array but reorganized in
65    *      order to match the sorted vertex array.
66    */
67   static void SortIndexedVertexArray(const float *iVertices,
68                                      unsigned iVSize,
69                                      const unsigned *iIndices,
70                                      unsigned iISize,
71                                      float **oVertices,
72                                      unsigned **oIndices);
73
74   /*! Compress a SORTED indexed vertex array by eliminating multiple
75    *  appearing occurrences of a single vertex.
76    *    iVertices
77    *      The SORTED vertex array to compress.
78    *      It is organized as a float series of vertex coordinates: XYZXYZXYZ...
79    *    iVSize
80    *      The size of iVertices array.
81    *    iIndices
82    *      The array containing the vertex indices
83    *      (used to refer to the vertex coordinates in an indexed face).
84    *      Each element is an unsignedeger multiple of 3.
85    *    iISize
86    *      The size of iIndices array
87    *    oVertices
88    *      The vertex array, result of the compression.
89    *      The array is organized as a 3-float serie giving the vertices coordinates: XYZXYZXYZ...
90    *    oVSize
91    *      The size of oVertices.
92    *    oIndices
93    *      The indices array, reorganized to match the compressed oVertices array.
94    */
95   static void CompressIndexedVertexArray(const float *iVertices,
96                                          unsigned iVSize,
97                                          const unsigned *iIndices,
98                                          unsigned iISize,
99                                          float **oVertices,
100                                          unsigned *oVSize,
101                                          unsigned **oIndices);
102
103   /*! Sorts and compress an array of indexed vertices.
104    *    iVertices
105    *      The vertex array to sort then compress. It is organized as a float series of
106    *      vertex coordinates: XYZXYZXYZ...
107    *    iVSize
108    *      The size of iVertices array.
109    *    iIndices
110    *      The array containing the vertex indices
111    *      (used to refer to the vertex coordinates in an indexed face).
112    *      Each element is an unsignedeger multiple of 3.
113    *    iISize
114    *      The size of iIndices array
115    *    oVertices
116    *      The vertex array, result of the sorting-compression.
117    *      The array is organized as a 3-float serie giving the vertices coordinates: XYZXYZXYZ...
118    *    oVSize
119    *      The size of oVertices.
120    *    oIndices
121    *      The indices array, reorganized to match the sorted and compressed oVertices array.
122    */
123   static void SortAndCompressIndexedVertexArray(const float *iVertices,
124                                                 unsigned iVSize,
125                                                 const unsigned *iIndices,
126                                                 unsigned iISize,
127                                                 float **oVertices,
128                                                 unsigned *oVSize,
129                                                 unsigned **oIndices);
130
131   /*! Cleans an indexed vertex array.
132    *  (Identical to SortAndCompress except that we use here a hash table to create the new array.)
133    *    iVertices
134    *      The vertex array to sort then compress. It is organized as a float series of
135    *      vertex coordinates: XYZXYZXYZ...
136    *    iVSize
137    *      The size of iVertices array.
138    *    iIndices
139    *      The array containing the vertex indices
140    *      (used to refer to the vertex coordinates in an indexed face).
141    *      Each element is an unsignedeger multiple of 3.
142    *    iISize
143    *      The size of iIndices array
144    *    oVertices
145    *      The vertex array, result of the sorting-compression.
146    *      The array is organized as a 3-float serie giving the vertices coordinates: XYZXYZXYZ...
147    *    oVSize
148    *      The size of oVertices.
149    *    oIndices
150    *      The indices array, reorganized to match the sorted and compressed oVertices array.
151    */
152   static void CleanIndexedVertexArray(const float *iVertices,
153                                       unsigned iVSize,
154                                       const unsigned *iIndices,
155                                       unsigned iISize,
156                                       float **oVertices,
157                                       unsigned *oVSize,
158                                       unsigned **oIndices);
159
160 #ifdef WITH_CXX_GUARDEDALLOC
161   MEM_CXX_CLASS_ALLOC_FUNCS("Freestyle:GeomCleaner")
162 #endif
163 };
164
165 /*! Binary operators */
166 // inline bool operator<(const IndexedVertex& iv1, const IndexedVertex& iv2);
167
168 /*! Class Indexed Vertex. Used to represent an indexed vertex by storing the vertex coordinates as
169  * well as its index */
170 class IndexedVertex {
171  private:
172   Vec3f _Vector;
173   unsigned _index;
174
175  public:
176   inline IndexedVertex()
177   {
178   }
179
180   inline IndexedVertex(Vec3f iVector, unsigned iIndex)
181   {
182     _Vector = iVector;
183     _index = iIndex;
184   }
185
186   /*! accessors */
187   inline const Vec3f &vector() const
188   {
189     return _Vector;
190   }
191
192   inline unsigned index()
193   {
194     return _index;
195   }
196
197   inline float x()
198   {
199     return _Vector[0];
200   }
201
202   inline float y()
203   {
204     return _Vector[1];
205   }
206
207   inline float z()
208   {
209     return _Vector[2];
210   }
211
212   /*! modifiers */
213   inline void setVector(const Vec3f &iVector)
214   {
215     _Vector = iVector;
216   }
217
218   inline void setIndex(unsigned iIndex)
219   {
220     _index = iIndex;
221   }
222
223   /*! operators */
224   IndexedVertex &operator=(const IndexedVertex &iv)
225   {
226     _Vector = iv._Vector;
227     _index = iv._index;
228     return *this;
229   }
230
231   inline float operator[](const unsigned i)
232   {
233     return _Vector[i];
234   }
235
236   // friend inline bool operator<(const IndexedVertex& iv1, const IndexedVertex& iv2);
237   inline bool operator<(const IndexedVertex &v) const
238   {
239     return (_Vector < v._Vector);
240   }
241
242   inline bool operator==(const IndexedVertex &v)
243   {
244     return (_Vector == v._Vector);
245   }
246
247 #ifdef WITH_CXX_GUARDEDALLOC
248   MEM_CXX_CLASS_ALLOC_FUNCS("Freestyle:IndexedVertex")
249 #endif
250 };
251
252 #if 0
253 bool operator<(const IndexedVertex &iv1, const IndexedVertex &iv2)
254 {
255   return iv1.operator<(iv2);
256 }
257 #endif
258
259 } /* namespace Freestyle */
260
261 #endif  // __GEOMCLEANER_H__