map2.h 15.6 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-2012, 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.unistra.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
39
40
41
42
43
44
45
46
47
48
49
50
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __MAP2_H__
#define __MAP2_H__

#include "Topology/map/map1.h"

namespace CGoGN
{

/*! \brief The class of dual 2-dimensional combinatorial maps:
 *  set of oriented faces pairwise sewed by an adjacency relation.
 *  A dual 2-map represents close or open oriented 2-manifolds (surfaces).
 *  - A dual 2-map is made of darts linked by the phi1 permutation
 * 	and/or the phi2 one-to-one relation.
 *  - In this class darts are interpreted as oriented edges.
 *  - The phi1 relation defines oriented faces (see Map1)
 *  and faces may have arbitrary size (degenerated faces are accepted).
 *  - The phi2 relation links oriented faces along oriented edges.
 *  A set of phi2-linked faces represents a surface 
 *  - Edges that have no phi2-link are border edges. If there exists
 *  such edges the map is open.
 *  - When every edge is phi2-linked, the map is closed. In this case
 *  some optimizations are enabled that speed up the processing of vertices.
 */
class Map2 : public Map1
{
protected:
51
	AttributeMultiVector<Dart>* m_phi2 ;
Pierre Kraemer's avatar
Pierre Kraemer committed
52

53
54
	void init() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
55
56
57
public:
	typedef Map1 ParentMap;

Pierre Kraemer's avatar
Pierre Kraemer committed
58
	inline static unsigned int ORBIT_IN_PARENT(unsigned int o) { return o+5; }
59

Pierre Kraemer's avatar
Pierre Kraemer committed
60
61
	static const unsigned int IN_PARENT = 5 ;

62
63
64
	static const unsigned int VERTEX_OF_PARENT = VERTEX+5;
	static const unsigned int EDGE_OF_PARENT = EDGE+5;

Pierre Kraemer's avatar
Pierre Kraemer committed
65
66
	Map2();

67
	virtual std::string mapTypeName() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
68

69
	virtual unsigned int dimension() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
70

71
72
	virtual void clear(bool removeAttrib);

Sylvain Thery's avatar
Sylvain Thery committed
73
74
	virtual void update_topo_shortcuts();

Pierre Kraemer's avatar
merges    
Pierre Kraemer committed
75
	virtual void compactTopoRelations(const std::vector<unsigned int>& oldnew);
76

Pierre Kraemer's avatar
Pierre Kraemer committed
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
	/*! @name Basic Topological Operators
	 * Access and Modification
	 *************************************************************************/

	virtual Dart newDart();

	Dart phi2(Dart d);

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

	Dart alpha0(Dart d);

	Dart alpha1(Dart d);

	Dart alpha_1(Dart d);

94
95
96
97
98
99
100
101
102
103
	/**
	 * prefer phi2_1 to alpha1 in algo if your want it to work in Map2 of Map3
	 */
	Dart phi2_1(Dart d);

	/**
	 * prefer phi21 to alpha_1 in algo if your want it to work in Map2 of Map3
	 */
	Dart phi12(Dart d);

Pierre Kraemer's avatar
Pierre Kraemer committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
protected:
	//! Link dart d with dart e by an involution
	/*  @param d,e the darts to link
	 *	- Before:	d->d and e->e
	 *	- After:	d->e and e->d
	 */
	void phi2sew(Dart d, Dart e);

	//! Unlink the current dart by an involution
	/*  @param d the dart to unlink
	 * - Before:	d->e and e->d
	 * - After:		d->d and e->e
	 */
	void phi2unsew(Dart d);

119
public:
120

121
122
	void rdfi(Dart t, DartMarker& m1, DartMarker& m2);

Pierre Kraemer's avatar
Pierre Kraemer committed
123
124
125
126
127
	/*! @name Generator and Deletor
	 *  To generate or delete faces in a 2-map
	 *************************************************************************/

	//@{
128
	//! Create an new polyline of nbEdges, i.e 2*nbEdges darts pairwise sewn by phi2
David Cazier's avatar
David Cazier committed
129
130
131
132
133
	/*! @param nbEdges the number of edges
	 *  @return return a dart of the face
	 */
	virtual Dart newPolyLine(unsigned int nbEdges) ;

134
135
	//! Create an new face of nbEdges
	/*! @param nbEdges the number of edges
136
	 *  @param withBoundary create the face and its boundary (default true)
137
138
	 *  @return return a dart of the face
	 */
139
	virtual Dart newFace(unsigned int nbEdges, bool withBoundary = true) ;
140

141
142
	//! Delete the face of d
	/*! @param d a dart of the face
143
	 *  @param withBoundary create or extend boundary face instead of fixed points (default true)
144
	 */
145
	virtual void deleteFace(Dart d, bool withBoundary = true) ;
146

untereiner's avatar
untereiner committed
147
148
149
150
151
	//! Delete a connected component of the map
	/*! @param d a dart of the connected component
	 */
	virtual void deleteCC(Dart d) ;

152
153
154
155
156
	//! 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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
	//@}

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

	//@{
	//! Split a vertex v between d and e inserting an edge after d and e
	/*! \pre Darts d & e MUST belong to the same vertex
	 *  @param d first dart in vertex v
	 *  @param e second dart in vertex v
	 */
	virtual void splitVertex(Dart d, Dart e);

Pierre Kraemer's avatar
Pierre Kraemer committed
171
	//! Delete the vertex of d (works only for internal vertices)
Pierre Kraemer's avatar
Pierre Kraemer committed
172
173
	/*! Does not create a hole -> all the faces
	 * 	around the vertex are merged into one face
Pierre Kraemer's avatar
Pierre Kraemer committed
174
	 *  @param d a dart of the vertex to delete
175
	 *  @return a dart of the resulting face (NIL if the deletion has not been executed)
Pierre Kraemer's avatar
Pierre Kraemer committed
176
	 */
177
	virtual Dart deleteVertex(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
178

Pierre Kraemer's avatar
Pierre Kraemer committed
179
	//! Cut the edge of d by inserting a new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
180
	/*! @param d a dart of the edge to cut
Pierre Kraemer's avatar
Pierre Kraemer committed
181
	 *  @return a dart of the new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
182
	 */
David Cazier's avatar
David Cazier committed
183
	virtual Dart cutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
184

Pierre Kraemer's avatar
Pierre Kraemer committed
185
	//! Undo the cut of the edge of d
Pierre Kraemer's avatar
Pierre Kraemer committed
186
	/*! @param d a dart of the edge to uncut
187
	 *  @return true if the uncut has been executed, false otherwise
Pierre Kraemer's avatar
Pierre Kraemer committed
188
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
189
	virtual bool uncutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
190

Pierre Kraemer's avatar
Pierre Kraemer committed
191
192
	//! Collapse an edge (that is deleted) possibly merging its vertices
	/*! If delDegenerateFaces is true, the method checks that no degenerate
193
	 *  faces are built (faces with less than 3 edges). If it occurs the faces
Pierre Kraemer's avatar
Pierre Kraemer committed
194
195
196
197
198
	 *  are deleted and the adjacencies are updated (see collapseDegeneratedFace).
	 *  \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)
199
	 *  @return a dart of the resulting vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
200
	 */
201
	virtual Dart collapseEdge(Dart d, bool delDegenerateFaces = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
202
203

	/**
204
	 * Flip the edge of d (rotation in phi1 order)
205
	 * WARNING : Works only for non-border edges
Pierre Kraemer's avatar
Pierre Kraemer committed
206
207
208
209
210
211
	 * @param d a dart of the edge to flip
	 * @return true if the flip has been executed, false otherwise
	 */
	virtual bool flipEdge(Dart d);

	/**
212
	 * Flip the edge of d (rotation in phi_1 order)
213
	 * WARNING : Works only for non-border edges
Pierre Kraemer's avatar
Pierre Kraemer committed
214
	 * @param d a dart of the edge to flip
Pierre Kraemer's avatar
Pierre Kraemer committed
215
	 * @return true if the flipBack has been executed, false otherwise
Pierre Kraemer's avatar
Pierre Kraemer committed
216
217
218
	 */
	virtual bool flipBackEdge(Dart d);

untereiner's avatar
untereiner committed
219
220
221
222
223
224
	//!
	/*!
	 *
	 */
	void swapEdges(Dart d, Dart e);

225
226
227
	 //	 *  @param d dart of the vertex
	 //	 *  @param e dart of the edge
	 //	 */
228
	virtual void insertEdgeInVertex(Dart d, Dart e);
229
230
231
232
233
234
	 //
	 //	//! Remove an edge from a vertex orbit
	 //	/*! \pre Dart d must be phi2 sewed
	 //	 *  @param d the dart of the edge to remove from the vertex
	 //	 * @return true if the removal has been executed, false otherwise
	 //	 */
235
	virtual bool removeEdgeFromVertex(Dart d);
236

Pierre Kraemer's avatar
Pierre Kraemer committed
237
	//! Sew two oriented faces along oriented edges
Pierre Kraemer's avatar
Pierre Kraemer committed
238
	/*! \pre Edges of darts d & e MUST be boundary edges
Pierre Kraemer's avatar
Pierre Kraemer committed
239
240
	 *  @param d a dart of the first face
	 *  @param e a dart of the second face
241
	 *  @param withBoundary: if false, faces must have phi2 fixed points (only for construction: import/primitives)
Pierre Kraemer's avatar
Pierre Kraemer committed
242
	 */
243
	virtual void sewFaces(Dart d, Dart e, bool withBoundary = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
244

245
246
247
	//! Unsew two oriented 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
248
	 */
249
	virtual void unsewFaces(Dart d, bool withBoundary = true);
Sylvain Thery's avatar
Sylvain Thery committed
250

Pierre Kraemer's avatar
Pierre Kraemer committed
251
	//! Delete an oriented face if and only if it has one or two edges
252
253
	/*! If the face is sewed to two distinct adjacent faces,
	 *  then those two faces are sewed
Pierre Kraemer's avatar
Pierre Kraemer committed
254
255
256
257
258
259
260
261
262
263
264
265
266
	 *  @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.
267
268
	/*! 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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
	 *  @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 v1 and v2
	 * v1 and v2 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) ;

	//! Merge two volumes along two faces.
	/*! Works only if the two faces have the same number of edges.
289
	 *  The faces adjacent to the two given faces are pairwise sewed
Pierre Kraemer's avatar
Pierre Kraemer committed
290
291
292
293
294
295
296
297
	 *  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);
298
299
300

	//! Split a surface into two disconnected surfaces along a edge path
	/*! @param vd a vector of darts
301
302
	 *  @param firstSideOpen : if false, one of the 2 sides of the surface remains closed (no hole)
	 *  @param secondSideOpen : if false, the other side of the surface remains closed (no hole)
303
	 */
304
	virtual void splitSurface(std::vector<Dart>& vd, bool firstSideClosed = true, bool secondSideClosed = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
305
306
307
308
309
310
311
312
313
314
315
316
317
	//@}

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

	//@{
	//! 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) ;

318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
	//! 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) ;

	//! Compute the number of edges of the vertex of d
	/*! @param d a dart
	 */
	unsigned int vertexDegree(Dart d) ;

	//! Tell if the vertex of d is on the boundary of the map
	/*! @param d a dart
	 */
	bool isBoundaryVertex(Dart d) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
334
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
335
336
	 * find the dart of vertex that belong to the boundary
	 * return NIL if the vertex is not on the boundary
Pierre Kraemer's avatar
Pierre Kraemer committed
337
	 */
338
	Dart findBoundaryEdgeOfVertex(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
339

340
341
342
343
344
345
	/**
	 * find the dart of edge that belong to the boundary
	 * return NIL if the face is not on the boundary
	 */
	Dart findBoundaryEdgeOfFace(Dart d);

Pierre Kraemer's avatar
Pierre Kraemer committed
346
347
348
	//! Test if dart d and e belong to the same edge
	/*! @param d a dart
	 *  @param e a dart
349
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
350
	bool sameEdge(Dart d, Dart e) ;
351

Pierre Kraemer's avatar
Pierre Kraemer committed
352
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
353
	 * tell if the edge of d is on the boundary of the map
Pierre Kraemer's avatar
Pierre Kraemer committed
354
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
355
	bool isBoundaryEdge(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
356

untereiner's avatar
bla    
untereiner committed
357
	//! Test if dart d and e belong to the same oriented face
untereiner's avatar
untereiner committed
358
359
360
361
362
	/*! @param d a dart
	 *  @param e a dart
	 */
	bool sameOrientedFace(Dart d, Dart e);

Pierre Kraemer's avatar
Pierre Kraemer committed
363
364
365
366
367
	//! 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) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
368

369
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
370
	 * compute the number of edges of the face of d
371
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
372
	unsigned int faceDegree(Dart d) ;
Sylvain Thery's avatar
Sylvain Thery committed
373

Pierre Kraemer's avatar
Pierre Kraemer committed
374
375
376
377
	/**
	 * tell if the face of d is on the boundary of the map
	 */
	bool isBoundaryFace(Dart d) ;
378
379

	//! Test if dart d and e belong to the same oriented volume
Pierre Kraemer's avatar
Pierre Kraemer committed
380
381
382
	/*! @param d a dart
	 *  @param e a dart
	 */
383
	bool sameOrientedVolume(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
384

385
	//! Test if dart d and e belong to the same volume
386
	/*! @param d a dart
387
	 *  @param e a dart
Pierre Kraemer's avatar
Pierre Kraemer committed
388
	 */
389
	bool sameVolume(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
390

391
392
	//! Compute the number of faces in the volume of d
	/*! @param d a dart
Pierre Kraemer's avatar
Pierre Kraemer committed
393
394
395
396
397
398
399
400
401
402
	 */
	unsigned int volumeDegree(Dart d);

	// TODO a mettre en algo
	/**
	 * check if the mesh is triangular or not
	 * @return a boolean indicating if the mesh is triangular
	 */
	bool isTriangular() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
403
	// TODO a mettre en algo
Pierre Kraemer's avatar
Pierre Kraemer committed
404
405
	/**
	 * Check if map is complete
Pierre Kraemer's avatar
Pierre Kraemer committed
406
	 * Should be executed after import
Pierre Kraemer's avatar
Pierre Kraemer committed
407
408
	 */
	virtual bool check();
untereiner's avatar
untereiner committed
409
410
411
412
413

	/**
	 * Check if a serie of darts is an oriented simple close path
	 */
	virtual bool checkSimpleOrientedPath(std::vector<Dart>& vd);
Pierre Kraemer's avatar
Pierre Kraemer committed
414
415
416
417
418
419
	//@}

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

420
	//@{
Pierre Kraemer's avatar
Pierre Kraemer committed
421
422
423
424
	//! Apply a functor on every dart of a vertex
	/*! @param d a dart of the vertex
	 *  @param f the functor to apply
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
425
	bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
426

untereiner's avatar
untereiner committed
427
	//! Apply a functor on every dart of an edge
Pierre Kraemer's avatar
Pierre Kraemer committed
428
429
430
	/*! @param d a dart of the edge
	 *  @param f the functor to apply
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
431
	bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
432

433
	//! Apply a functor on every dart of an face
434
435
436
	/*! @param d a dart of the volume
	 *  @param f the functor to apply
	 */
437
	bool foreach_dart_of_face(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
438
439
440
441
442

	//! Apply a functor on every dart of a connected component
	/*! @param d a dart of the connected component
	 *  @param f the functor to apply
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
443
	bool foreach_dart_of_cc(Dart d, FunctorType& f, unsigned int thread = 0);
444
445
446
447
448
449
450
451
452
453
454
455
456

	//! Apply a functor on every dart of a vertex of map1 representing the face of d
	/*! @param d a dart of the vertex
	 *  @param f the functor to apply
	 */
	bool foreach_dart_of_vertex1(Dart d, FunctorType& f, unsigned int thread = 0);

	//! Apply a functor on every dart of an edge of map1 representing the face of d
	/*! @param d a dart of the edge
	 *  @param f the functor to apply
	 */
	bool foreach_dart_of_edge1(Dart d, FunctorType& f, unsigned int thread = 0);

Pierre Kraemer's avatar
Pierre Kraemer committed
457
	//@}
Sylvain Thery's avatar
Sylvain Thery committed
458

Pierre Kraemer's avatar
Pierre Kraemer committed
459
460
461
462
	/*! @name Close map after import or creation
	 *  These functions must be used with care, generally only by import algorithms
	 *************************************************************************/

Sylvain Thery's avatar
Sylvain Thery committed
463
	//@{
464
	//! Close a topological hole (a sequence of connected fixed point of phi2). DO NOT USE, only for import/creation algorithm
Sylvain Thery's avatar
Sylvain Thery committed
465
466
467
	/*! \pre dart d MUST be fixed point of phi2 relation
	 *  Add a face to the map that closes the hole.
	 *  @param d a dart of the hole (with phi2(d)==d)
468
	 *  @param forboundary tag the created face as boundary (default is true)
Sylvain Thery's avatar
Sylvain Thery committed
469
470
	 *  @return the degree of the created face
	 */
471
	virtual unsigned int closeHole(Dart d, bool forboundary = true);
Sylvain Thery's avatar
Sylvain Thery committed
472

473
	//! Close the map removing topological holes: DO NOT USE, only for import/creation algorithm
Sylvain Thery's avatar
Sylvain Thery committed
474
	/*! Add faces to the map that close every existing hole.
475
	 *  These faces are marked as boundary.
476
	 *  @return the number of closed holes
Sylvain Thery's avatar
Sylvain Thery committed
477
	 */
478
	unsigned int closeMap(bool forboundary = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
479
480
481
482
483
484
485
486
	//@}
};

} // namespace CGoGN

#include "Topology/map/map2.hpp"

#endif