gmap2.h 12.9 KB
Newer Older
Pierre Kraemer's avatar
Pierre Kraemer committed
1
2
3
/*******************************************************************************
* CGoGN: Combinatorial and Geometric modeling with Generic N-dimensional Maps  *
* version 0.1                                                                  *
4
* Copyright (C) 2009-2011, IGG Team, LSIIT, University of Strasbourg           *
Pierre Kraemer's avatar
Pierre Kraemer committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
*                                                                              *
* This library is free software; you can redistribute it and/or modify it      *
* under the terms of the GNU Lesser General Public License as published by the *
* Free Software Foundation; either version 2.1 of the License, or (at your     *
* option) any later version.                                                   *
*                                                                              *
* This library is distributed in the hope that it will be useful, but WITHOUT  *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or        *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License  *
* for more details.                                                            *
*                                                                              *
* You should have received a copy of the GNU Lesser General Public License     *
* along with this library; if not, write to the Free Software Foundation,      *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.           *
*                                                                              *
20
* Web site: http://cgogn.u-strasbg.fr/                                         *
Pierre Kraemer's avatar
Pierre Kraemer committed
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __GMAP2_H__
#define __GMAP2_H__

#include "Topology/gmap/gmap1.h"

namespace CGoGN
{

/**
* The class of 2-GMap
*/
class GMap2 : public GMap1
{
protected:
39
	AttributeMultiVector<Dart>* m_beta2 ;
Pierre Kraemer's avatar
Pierre Kraemer committed
40

41
42
	void init() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
43
public:
Thomas's avatar
Thomas committed
44
45
	typedef GMap1 ParentMap;

Pierre Kraemer's avatar
Pierre Kraemer committed
46
47
48
49
50
51
	GMap2();

	virtual std::string mapTypeName();

	virtual unsigned int dimension();

52
53
	virtual void clear(bool removeAttrib);

Pierre Kraemer's avatar
Pierre Kraemer committed
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
	/*! @name Basic Topological Operators
	 * Access and Modification
	 *************************************************************************/

	virtual Dart newDart();

	Dart beta2(Dart d);

	template <int N>
	Dart beta(const Dart d);

	Dart phi2(Dart d);

	template <int N>
	Dart phi(const Dart d);

	Dart alpha0(Dart d);

	Dart alpha1(Dart d);

	Dart alpha_1(Dart d);

76
protected:
Pierre Kraemer's avatar
Pierre Kraemer committed
77
78
79
80
	void beta2sew(Dart d, Dart e);

	void beta2unsew(Dart d);

81
public:
Pierre Kraemer's avatar
Pierre Kraemer committed
82
83
84
85
86
	/*! @name Constructors and Destructors
	 *  To generate or delete cells in a 2-G-map
	 *************************************************************************/

	//@{
87
88
89
90
91
92
93
	//! Create an new face of nbEdges
	/*! @param nbEdges the number of edges
	 *  @param withBoudary create the face and its boundary (default true)
	 *  @return return a dart of the face
	 */
	virtual Dart newFace(unsigned int nbEdges, bool withBoundary = true) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
94
95
96
97
	//! Delete a face erasing all its darts
	/*! @param d a dart of the face
	 */
	virtual void deleteFace(Dart d);
98
99
100
101
102
103

	//! Fill a hole with a face
	/*! \pre Dart d is boundary marked
	 *  @param d a dart of the face to fill
	 */
	virtual void fillHole(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
104
105
106
107
108
109
110
	//@}

	/*! @name Topological Operators
	 *  Topological operations on 2-G-maps
	 *************************************************************************/

	//@{
111
	//! Split a vertex v between d and e inserting an edge after d and e
Pierre Kraemer's avatar
Pierre Kraemer committed
112
113
114
115
116
117
	/*! \pre Darts d & e MUST belong to the same oriented vertex
	 *  @param d first dart in vertex v
	 *  @param e second dart in vertex v
	 */
	virtual void splitVertex(Dart d, Dart e);

118
	//! Delete the vertex of d (works only for internal vertices)
119
120
	/*! Does not create a hole -> all the faces
	 * 	around the vertex are merged into one face
121
	 *  @param d a dart of the vertex to delete
122
	 *  @return a dart of the resulting face (NIL if the deletion has not been executed)
123
	 */
124
	virtual Dart deleteVertex(Dart d) ;
125

126
	//! Cut the edge of d by inserting a new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
127
128
129
130
	/*! @param d a dart of the edge to cut
	 */
	virtual void cutEdge(Dart d);

131
	//! Undo the cut of the edge of d
132
	/*! @param d a dart of the edge to uncut
133
	 *  @return true if the uncut has been executed, false otherwise
134
	 */
135
	virtual bool uncutEdge(Dart d);
136

Pierre Kraemer's avatar
Pierre Kraemer committed
137
138
139
	//! Collapse an edge (that is deleted) possibly merging its vertices
	/*! If delDegenerateFaces is true, the method checks that no degenerate
	 *  faces are build (faces with less than 3 edges). If it occurs the faces
140
	 *  are deleted and the adjacencies are updated (see deleteIfDegenerated).
Pierre Kraemer's avatar
Pierre Kraemer committed
141
142
143
144
	 *  \warning This may produce two distinct vertices if the edge
	 *  was the only link between two border faces
	 *  @param d a dart in the deleted edge
	 *  @param delDegenerateFaces a boolean (default to true)
145
	 *  @return a dart of the resulting vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
146
	 */
147
	virtual Dart collapseEdge(Dart d, bool delDegenerateFaces = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
148
149

	/**
150
151
	 * Flip the edge of d (rotation in phi1 order)
	 * WARNING : Works only for non-border edges
Pierre Kraemer's avatar
Pierre Kraemer committed
152
153
154
155
156
157
	 * @param d a dart of the edge to flip
	 * @return true if the flip has been executed, false otherwise
	 */
	virtual bool flipEdge(Dart d);

	/**
158
159
	 * Flip the edge of d (rotation in phi_1 order)
	 * WARNING : Works only for non-border edges
Pierre Kraemer's avatar
Pierre Kraemer committed
160
	 * @param d a dart of the edge to flip
161
	 * @return true if the flipBack has been executed, false otherwise
Pierre Kraemer's avatar
Pierre Kraemer committed
162
163
164
	 */
	virtual bool flipBackEdge(Dart d);

165
166
167
168
169
170
171
172
173
174
175
176
177
178
//	//! Insert an edge after a dart in the vertex orbit
//	/*! \pre Dart d and e MUST be different and belong to distinct face
//	 *  \pre Dart e must be phi2-linked with its phi_1 dart
//	 *  @param d dart of the vertex
//	 *  @param e dart of the edge
//	 */
//	virtual void insertEdgeInVertex(Dart d, Dart e);
//
//	//! Remove an edge from a vertex orbit
//	/*! \pre Dart d must be phi2 sewn
//	 *  @param d the dart of the edge to remove from the vertex
//	 */
//	virtual void removeEdgeFromVertex(Dart d);

thomas's avatar
thomas committed
179
	//! Sew two faces along an edge (pay attention to the orientation !)
180
	/*! \pre Edges of darts d & e MUST be boundary edges
Pierre Kraemer's avatar
Pierre Kraemer committed
181
182
	 *  @param d a dart of the first face
	 *  @param e a dart of the second face
183
	 *  @param withBoundary: if false, faces must have beta2 fixed points (only for construction: import/primitives)
Pierre Kraemer's avatar
Pierre Kraemer committed
184
	 */
185
	virtual void sewFaces(Dart d, Dart e, bool withBoundary = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
186

187
188
189
	//! Unsew two faces
	/*! \pre Edge of dart d MUST NOT be a boundary edge
	 *  @param d a dart of a face
Pierre Kraemer's avatar
Pierre Kraemer committed
190
191
192
	 */
	virtual void unsewFaces(Dart d);

193
194
195
	//! Delete a face if and only if it has one or two edges
	/*! If the face is sewed to two distinct adjacent faces,
	 *  then those two faces are sewed
Pierre Kraemer's avatar
Pierre Kraemer committed
196
197
198
199
200
201
202
203
204
205
206
207
208
	 *  @param d a dart of the face
	 *  @return true if the collapse has been executed, false otherwise
	 */
	virtual bool collapseDegeneratedFace(Dart d);

	//! Split a face f between d and e inserting an edge between vertices d & e
	/*! \pre Darts d & e MUST belong to the same face
	 *  @param d first dart in face f
	 *  @param e second dart in face f
	 */
	virtual void splitFace(Dart d, Dart e);

	//! Merge the two faces incident to the edge of d.
209
210
	/*! Works only for non-boundary edges.
	 *  \warning Darts of the edge of d no longer exist after the call
Pierre Kraemer's avatar
Pierre Kraemer committed
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
	 *  @param d a dart in the first face
	 *  @return true if the merge has been executed, false otherwise
	 */
	virtual bool mergeFaces(Dart d);

	/**
	 * Extract a pair of sewed triangles and sew their adjacent faces
	 * d is a dart of the common edge of the pair of triangles
	 */
	void extractTrianglePair(Dart d) ;

	/**
	 * Insert a pair of sewed triangles in a vertex by exploding the edges of d1 and d2
	 * d1 and d2 belong to the same vertex
	 * d is a dart of the common edge of the pair of triangles
	 */
	void insertTrianglePair(Dart d, Dart v1, Dart v2) ;

229
230
231
232
233
234
	/**
	 * Unsew the faces of the umbrella of the vertex of d
	 * @param d a dart from the vertex
	 */
	void unsewAroundVertex(Dart d) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
235
236
	//! Merge two volumes along two faces.
	/*! Works only if the two faces have the same number of edges.
237
	 *  The faces adjacent to the two given faces are pairwise sewed
Pierre Kraemer's avatar
Pierre Kraemer committed
238
239
240
241
242
243
244
245
246
247
248
249
250
251
	 *  then the 2 faces are deleted.
	 *  If the two faces belong to different surfaces, the surfaces are merged,
	 *  else a handle is created that increases the genus of the surface.
	 *  @param d a dart of the first face
	 *  @param e a dart of the second face
	 *  @return true if the merge has been executed, false otherwise
	 */
	virtual bool mergeVolumes(Dart d, Dart e);
	//@}

	/*! @name Topological Queries
	 *  Return or set various topological information
	 *************************************************************************/

252
	//@{
Thomas's avatar
Thomas committed
253
254
255
256
257
258
	//! Test if dart d and e belong to the same oriented vertex
	/*! @param d a dart
	 *  @param e a dart
	 */
	bool sameOrientedVertex(Dart d, Dart e);

Pierre Kraemer's avatar
Pierre Kraemer committed
259
260
261
262
263
264
	//! Test if dart d and e belong to the same vertex
	/*! @param d a dart
	 *  @param e a dart
	 */
	bool sameVertex(Dart d, Dart e);

265
266
267
268
269
	/**
	 * compute the number of edges of the vertex of d
	 */
	unsigned int vertexDegree(Dart d) ;

270
271
	//! tell if the vertex of d is on the boundary of the map
	/*! @param d a dart
272
273
274
	 */
	bool isBoundaryVertex(Dart d) ;

275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
	/**
	 * find the dart of vertex that belong to the boundary
	 * return NIL if the vertex is not on the boundary
	 */
	Dart findBoundaryEdgeOfVertex(Dart d);

	//! Test if dart d and e belong to the same edge
	/*! @param d a dart
	 *  @param e a dart
	 */
	bool sameEdge(Dart d, Dart e) ;

	/**
	 * tell if the edge of d is on the boundary of the map
	 */
	bool isBoundaryEdge(Dart d) ;

	//!Test if dart d and e belong to the same oriented face
	/*! @param d a dart
	 *  @param e a dart
	 */
	bool sameOrientedFace(Dart d, Dart e);

	//! Test if dart d and e belong to the same face
	/*! @param d a dart
	 *  @param e a dart
	 */
	bool sameFace(Dart d, Dart e) ;

	/**
	 * compute the number of edges of the face of d
	 */
	unsigned int faceDegree(Dart d) ;

	/**
	 * tell if the face of d is on the boundary of the map
	 */
	bool isBoundaryFace(Dart d) ;

Thomas's avatar
Thomas committed
314
315
316
317
318
319
320
321
322
323
	//! Test if dart d and e belong to the same oriented volume
	/*! @param d a dart
	 *  @param e a dart
	 */
	bool sameOrientedVolume(Dart d, Dart e);

	//! Test if dart d and e belong to the same volume
	/*! @param d a dart
	 *  @param e a dart
	 */
324
325
	bool sameVolume(Dart d, Dart e);

326
327
328
329
330
331
	//! Compute the number of faces in the volume of d
	/*! @param d a dart
	 */
	unsigned int volumeDegree(Dart d);

	// TODO a mettre en algo
Pierre Kraemer's avatar
Pierre Kraemer committed
332
	/**
333
334
	 * check if the mesh is triangular or not
	 * @return a boolean indicating if the mesh is triangular
Pierre Kraemer's avatar
Pierre Kraemer committed
335
	 */
336
337
338
339
340
341
	bool isTriangular() ;

	// TODO a mettre en algo
	/**
	 * Check if map is complete
	 * Should be executed after import
Pierre Kraemer's avatar
Pierre Kraemer committed
342
343
344
345
346
347
348
349
350
351
352
353
354
355
	 */
	virtual bool check();
	//@}

	/*! @name Cell Functors
	 *  Apply functors to all darts of a cell
	 *************************************************************************/

	//@{
	/**
	* Apply a functor on each dart of a face
	* @param d a dart of the face
	* @param fonct functor obj ref
	*/
356
	bool foreach_dart_of_oriented_vertex(Dart d, FunctorType& fonct, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
357
358
359
360
361
362

	/**
	* Apply a functor on each dart of a face
	* @param d a dart of the face
	* @param fonct functor obj ref
	*/
363
	bool foreach_dart_of_vertex(Dart d, FunctorType& fonct, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
364
365
366
367
368
369

	/**
	* Apply a functor on each dart of an edge
	* @param d a dart of the oriented face
	* @param fonct functor obj ref
	*/
370
	bool foreach_dart_of_edge(Dart d, FunctorType& fonct, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
371
372
373
374
375

	//! Apply a functor on every dart of a volume
	/*! @param d a dart of the volume
	 *  @param f the functor to apply
	 */
376
	bool foreach_dart_of_oriented_volume(Dart d, FunctorType& fonct, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
377
378
379
380
381

	//! Apply a functor on every dart of a volume
	/*! @param d a dart of the volume
	 *  @param f the functor to apply
	 */
382
	bool foreach_dart_of_volume(Dart d, FunctorType& fonct, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
383

384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
	//! Apply a functor on every dart of a connected component
	/*! @param d a dart of the connected component
	 *  @param f the functor to apply
	 */
	bool foreach_dart_of_cc(Dart d, FunctorType& fonct, unsigned int thread = 0);
	//@}

	/*! @name Close map after import or creation
	 *  These functions must be used with care, generally only by import algorithms
	 *************************************************************************/

	//@{
	//! Close a topological hole (a sequence of connected fixed point of beta2). DO NOT USE, only for import/creation algorithm
	/*! \pre dart d MUST be fixed point of beta2 relation
	 *  Add a face to the map that closes the hole.
	 *  @param d a dart of the hole (with beta2(d)==d)
	 *  @param forboundary tag the created face as boundary (default is true)
	 *  @return the degree of the created face
	 */
	virtual unsigned int closeHole(Dart d, bool forboundary = true);

	//! Close the map removing topological holes: DO NOT USE, only for import/creation algorithm
	/*! Add faces to the map that close every existing hole.
	 *  These faces are marked as boundary.
	 */
	void closeMap();
	//@}
Pierre Kraemer's avatar
Pierre Kraemer committed
411
412
413
414
415
416
417
};

} // namespace CGoGN

#include "Topology/gmap/gmap2.hpp"

#endif