map3.h 14.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-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
51
52
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __MAP3_H__
#define __MAP3_H__

#include "Topology/map/map2.h"

namespace CGoGN
{

/*! \brief The class of dual 3-dimensional combinatorial maps:
 *  set of oriented volumes pairwise sewed by an adjacency relation.
 *  A dual 3-map represents close or open oriented 3-manifolds (volume subdivisions).
 *  - A dual 3-map is made of darts linked by the phi1 permutation
 * 	and/or the phi2 and phi3 one-to-one relation.
 *  - In this class darts are interpreted as oriented edges.
 *  - The phi1 relation defines oriented faces (see tMap1)
 *  and faces may have arbitrary size (degenerated faces are accepted).
 *  - The phi2 relation links oriented faces along oriented edges building
 *  oriented surfaces. A close oriented surface define an oriented volume.
 *  - Volume are linked along whole faces with the phi3 relation 
 *  - Faces that have no phi3-link are border faces. If there exists
 *  such edges the maps is open.
 *  - When every face is phi3-linked, the map is close. In this case
 *  some optimizations are enable that speed up the processing of cells.
 *  @param DART the type of dart used in the class
 */
class Map3 : public Map2
{
protected:
53
	AttributeMultiVector<Dart>* m_phi3 ;
Pierre Kraemer's avatar
Pierre Kraemer committed
54

55
56
	void init() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
57
58
59
public:
	typedef Map2 ParentMap;

Pierre Kraemer's avatar
Pierre Kraemer committed
60
	inline static unsigned int ORBIT_IN_PARENT(unsigned int o){ return o+7; }
61
62
	inline static unsigned int ORBIT_IN_PARENT2(unsigned int o) { return o+5; }

Pierre Kraemer's avatar
Pierre Kraemer committed
63
64
65
	static const unsigned int IN_PARENT = 7 ;
	static const unsigned int IN_PARENT2 = 5 ;

66
67
68
69
70
71
72
	static const unsigned int VERTEX_OF_PARENT = VERTEX+7;
	static const unsigned int EDGE_OF_PARENT = EDGE+7;
	static const unsigned int FACE_OF_PARENT = FACE+7;

	static const unsigned int VERTEX_OF_PARENT2 = VERTEX+5;
	static const unsigned int EDGE_OF_PARENT2 = EDGE+5;

73
74
75
76
	static const unsigned int DIMENSION = 3 ;



Pierre Kraemer's avatar
Pierre Kraemer committed
77
78
	Map3();

79
	virtual std::string mapTypeName() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
80

81
	virtual unsigned int dimension() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
82

83
84
	virtual void clear(bool removeAttrib);

Sylvain Thery's avatar
Sylvain Thery committed
85
86
	virtual void update_topo_shortcuts();

87
88
	virtual void compactTopoRelations(const std::vector<unsigned int>& oldnew);

Pierre Kraemer's avatar
Pierre Kraemer committed
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
	/*! @name Basic Topological Operators
	 * Access and Modification
	 *************************************************************************/

	virtual Dart newDart();

	Dart phi3(Dart d);

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

	Dart alpha0(Dart d);

	Dart alpha1(Dart d);

	Dart alpha2(Dart d);

	Dart alpha_2(Dart d);

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

	//! Unlink the current dart by an involution
117
	/*! @param d the dart to unlink
Pierre Kraemer's avatar
Pierre Kraemer committed
118
119
120
121
122
	 * - Before:	d->e and e->d
	 * - After:		d->d and e->e
	 */
	void phi3unsew(Dart d);

123
public:
Pierre Kraemer's avatar
Pierre Kraemer committed
124
125
126
127
128
	/*! @name Generator and Deletor
	 *  To generate or delete volumes in a 3-map
	 *************************************************************************/

	//@{
129
130
131
	//! Delete a volume erasing all its darts.
	/*! The phi3-links around the volume are removed
	 *  @param d a dart of the volume
Pierre Kraemer's avatar
Pierre Kraemer committed
132
	 */
133
	virtual void deleteVolume(Dart d, bool withBoundary = true);
untereiner's avatar
untereiner committed
134
135
136
137
138
139

	//! Fill a hole with a volume
	/*! \pre Dart d is boundary marked
	 *  @param d a dart of the volume to fill
	 */
	virtual void fillHole(Dart d) ;
140
141
142
143
144
145

	//! Open the mesh Transforming a face in a hole
	/*! \pre Dart d is NOT boundary marked
	 *  @param d a dart of the face filled
	 */
	virtual void createHole(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
146
147
148
149
150
151
152
	//@}

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

	//@{
Lionel Untereiner's avatar
Lionel Untereiner committed
153
	//! Split the vertex along a permutation of faces
untereiner's avatar
untereiner committed
154
155
156
	/*! \per Darts d & e MUST belong to the same vertex
	 * 	\per Darts d & e MUST belong to different volumes
	 *  \per Works only on the boundary
Lionel Untereiner's avatar
Lionel Untereiner committed
157
	 *  @param vd a vector of darts
untereiner's avatar
untereiner committed
158
	 */
untereiner's avatar
untereiner committed
159
	virtual Dart splitVertex(std::vector<Dart>& vd);
untereiner's avatar
untereiner committed
160

161
162
	virtual void splitVertex(Dart d, Dart e) { assert("use splitVertex(d,e) only in dimension 2");}

163
	//! Delete the vertex of d
164
	/*! All the volumes around the vertex are merged into one volume
165
	 *  @param d a dart of the vertex to delete
166
	 *  @return a Dart of the resulting volume
Pierre Kraemer's avatar
Pierre Kraemer committed
167
	 */
168
	virtual Dart deleteVertex(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
169

Pierre Kraemer's avatar
Pierre Kraemer committed
170
	//! Cut the edge of d (all darts around edge orbit are cut)
171
	/*! @param d a dart of the edge to cut
Pierre Kraemer's avatar
Pierre Kraemer committed
172
	 *  @return a dart of the new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
173
	 */
David Cazier's avatar
David Cazier committed
174
	virtual Dart cutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
175

Pierre Kraemer's avatar
Pierre Kraemer committed
176
	//! Uncut the edge of d (all darts around edge orbit are uncut)
177
	/*! @param d a dart of the edge to uncut
Pierre Kraemer's avatar
Pierre Kraemer committed
178
	 */
179
	virtual bool uncutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
180

Sylvain Thery's avatar
Sylvain Thery committed
181
182
183
184
185
186

	/**
	 * Precondition for deleting edge
	 */
	bool deleteEdgePreCond(Dart d);

187
188
189
190
	//! Delete the edge of d
	/*! All the volumes around the edge are merged into one volume
	 *  @param d a dart of the edge to delete
	 *  @return a Dart of the resulting volume
untereiner's avatar
untereiner committed
191
192
193
194
195
196
197
198
199
200
201
	 */
	virtual Dart deleteEdge(Dart d);

	//! Collapse an edge (that is deleted) possibly merging its vertices
	/*! \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
	 *  @return a dart of the resulting vertex
	 */
	virtual Dart collapseEdge(Dart d, bool delDegenerateVolumes = true);

202
203
204
205
206
207
	//! 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
	 *  @param d a dart of the face
	 *  @return true if the collapse has been executed, false otherwise
	 */
Sylvain Thery's avatar
Sylvain Thery committed
208
209
210
211
212
213
214
215
//	virtual bool collapseDegeneratedFace(Dart d);

	//! Split Face Pre-condition
	/*!
	 *  @param d dart of first vertex
	 *  @param e dart of second vertex
	 */
	bool splitFacePreCond(Dart d, Dart e);
216

Pierre Kraemer's avatar
Pierre Kraemer committed
217
218
219
220
221
222
223
	//! Split a face inserting an edge between two vertices
	/*! \pre Dart d and e should belong to the same face and be distinct
	 *  @param d dart of first vertex
	 *  @param e dart of second vertex
	 */
	virtual void splitFace(Dart d, Dart e);

Thomas's avatar
Thomas committed
224
225
226
227
228
229
230
231
	//! Merge the two faces incident to the edge of d.
	/*! Works only for edges of degree 2.
	 *  \warning Darts of the edge of d no longer exist after the call
	 *  @param d a dart in the first face
	 *  @return true if the merge has been executed, false otherwise
	 */
	virtual bool mergeFaces(Dart d);

232
233
234
235
236
237
238
	//! Collapse a face (that is deleted) possibly merging its vertices
	/*! \warning
	 *  @param d a dart in the deleted face
	 *  @return a dart of the resulting vertex
	 */
	virtual Dart collapseFace(Dart d, bool delDegenerateVolumes = true);

239
240
241
242
243
244
	//! Delete a volume if and only if it has a face with degree < 3 or only 3 vertices
	/*! If the volume is sewed to two distinct adjacent volumes and if the face degree
	 *  of the two adjacent volumes is equal then those two volumes are sewed
	 *  @param d a dart of the face
	 *  @return true if the collapse has been executed, false otherwise
	 */
245
	bool collapseDegeneretedVolume(Dart d);
246

Sylvain Thery's avatar
Sylvain Thery committed
247
248
249
250
	//!! sewVolumes Pre-condition
	bool sewVolumesPreCond(Dart d, Dart e);


251
	//! Sew two oriented volumes along their faces. 
Pierre Kraemer's avatar
Pierre Kraemer committed
252
	/*! The oriented faces should not be phi3-linked and have the same degree
253
254
	 *  @param d a dart of the first volume
	 *  @param e a dart of the second volume
255
	 *  @param withBoundary: if false, volumes must have phi3 fixed points (only for construction: import/primitives)
Pierre Kraemer's avatar
Pierre Kraemer committed
256
	 */
257
	virtual void sewVolumes(Dart d, Dart e, bool withBoundary = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
258

Sylvain Thery's avatar
Sylvain Thery committed
259
260
261
	//! Unsew volumes pre-condition
	bool unsewVolumesPreCond(Dart d);

262
263
	//! Unsew two oriented volumes along their faces.
	/*! @param d a dart of one volume
Pierre Kraemer's avatar
Pierre Kraemer committed
264
	 */
265
	virtual void unsewVolumes(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
266

267
	//! Merge two volumes along their common oriented face
268
	/*! @param d a dart of common face
Pierre Kraemer's avatar
Pierre Kraemer committed
269
	 */
270
	virtual bool mergeVolumes(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
271

272
273
274
	virtual bool mergeVolumes(Dart d, Dart e) { assert("use mergeVolumes(d,e) only in dimension 2");return false;}


untereiner's avatar
untereiner committed
275
276
277
278
	//! Split a volume into two volumes along a edge path
	/*! @param vd a vector of darts
	 */
	virtual void splitVolume(std::vector<Dart>& vd);
279
280
281
282
283
284
285

	//! Collapse a volume (that is deleted) possibly merging its vertices
	/*! \warning
	 *  @param d a dart in the deleted volume
	 *  @return a dart of the resulting vertex
	 */
	virtual Dart collapseVolume(Dart d, bool delDegenerateVolumes = true);
286
	//@}
Pierre Kraemer's avatar
Pierre Kraemer committed
287

288
289
290
291
292
293
294
295
296
297
298
	/*! @name Topological Queries
	 *  Return or set various topological information
	 *************************************************************************/

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

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

304
305
306
307
308
	//! Compute the number of edges of the vertex of d on the boundary
	/*!	@param d a dart
	 */
	unsigned int vertexDegreeOnBoundary(Dart d);

309
310
311
	//! Tell if the vertex of d is on the boundary
	/*! @param d a dart
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
312
	bool isBoundaryVertex(Dart d) ;
313

untereiner's avatar
untereiner committed
314
315
316
317
318
319
	//! Find the dart of vertex that belong to the boundary
	/*! return NIL if the vertex is not on the boundary
	 *  @param d a dart
	 */
	Dart findBoundaryFaceOfVertex(Dart d) ;

320
321
322
323
324
325
326
327
328
329
330
331
	//! Test if dart d and e belong to the same oriented edge
	/*! @param d a dart
	 *  @param e a dart
	 */
	bool sameOrientedEdge(Dart d, Dart e) ;

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

332
333
	//! Compute the number of volumes around the edge of d
	/*! @param d a dart
Pierre Kraemer's avatar
Pierre Kraemer committed
334
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
335
	unsigned int edgeDegree(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
336

untereiner's avatar
untereiner committed
337
338
	//! Tell if the edge of d is on the boundary of the map
	/*! @param d a dart
untereiner's avatar
bla    
untereiner committed
339
340
341
	 */
	bool isBoundaryEdge(Dart d) ;

untereiner's avatar
untereiner committed
342
343
344
	//! Find the dart of edge that belong to the boundary
	/*! return NIL if the edge is not on the boundary
	 *  @param d a dart
untereiner's avatar
untereiner committed
345
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
346
	Dart findBoundaryFaceOfEdge(Dart d) ;
untereiner's avatar
untereiner committed
347

348
349
350
	//! Test if dart d and e belong to the same oriented face
	/*! @param d a dart
	 *  @param e a dart
untereiner's avatar
untereiner committed
351
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
352
	bool sameFace(Dart d, Dart e) ;
untereiner's avatar
untereiner committed
353

354
355
	//! Test if the face is on the boundary
	/*! @param d a dart from the face
Pierre Kraemer's avatar
Pierre Kraemer committed
356
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
357
	bool isBoundaryFace(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
358

359
360
	//! Tell if a face of the volume is on the boundary
	/*  @param d a dart
361
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
362
	bool isBoundaryVolume(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
363

untereiner's avatar
untereiner committed
364
365
366
367
368
	//! Tell if an edge of the volume is on the boundary
	/*	@param d a dart
	 */
	bool hasBoundaryEdge(Dart d);

untereiner's avatar
untereiner committed
369
370
371
	//! Check the map completeness
	/*! Test if phi3 and phi2 ares involutions and if phi1 is a permutation
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
372
	virtual bool check() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
373
374
375
376
377
378
379
	//@}

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

	//@{
380
381
382
383
	//! Apply a functor on each dart of a vertex
	/*! @param d a dart of the vertex
	 *  @param fonct the functor
	 */
untereiner's avatar
bla    
untereiner committed
384
	bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
385

386
387
388
389
	//! Apply a functor on each dart of an edge
	/*! @param d a dart of the oriented edge
	 *  @param fonct the functor
	 */
untereiner's avatar
bla    
untereiner committed
390
	bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
391

392
	//! Apply a functor on each dart of a face
393
394
395
	/*! @param d a dart of the oriented face
	 *  @param fonct the functor
	 */
untereiner's avatar
bla    
untereiner committed
396
	bool foreach_dart_of_face(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
397

398
399
400
401
	//! Apply a functor on each dart of a face
	/*! @param d a dart of the oriented face
	 *  @param fonct the functor
	 */
402
	bool foreach_dart_of_volume(Dart d, FunctorType& f, unsigned int thread = 0);
403

404
405
406
407
	//! Apply a functor on each dart of a cc
	/*! @param d a dart of the cc
	 *  @param fonct the functor
	 */
untereiner's avatar
bla    
untereiner committed
408
	bool foreach_dart_of_cc(Dart d, FunctorType& f, unsigned int thread = 0);
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428


	//! Apply a functor on each dart of a vertex
	/*! @param d a dart of the vertex
	 *  @param fonct the functor
	 */
	bool foreach_dart_of_vertex2(Dart d, FunctorType& f, unsigned int thread = 0);

	//! Apply a functor on each dart of an edge
	/*! @param d a dart of the oriented edge
	 *  @param fonct the functor
	 */
	bool foreach_dart_of_edge2(Dart d, FunctorType& f, unsigned int thread = 0);

	//! Apply a functor on each dart of an oriented face
	/*! @param d a dart of the oriented face
	 *  @param fonct the functor
	 */
	bool foreach_dart_of_face2(Dart d, FunctorType& f, unsigned int thread = 0);

Pierre Kraemer's avatar
Pierre Kraemer committed
429
430
	//@}

untereiner's avatar
untereiner committed
431
432
433
434
	/*! @name Close map after import or creation
	 *  These functions must be used with care, generally only by import algorithms
	 *************************************************************************/

435

untereiner's avatar
untereiner committed
436
	//@{
437
438
439
440
441
	/**
	 * create a face of map1 marked as boundary
	 */
	Dart newBoundaryCycle(unsigned int nbE);

untereiner's avatar
untereiner committed
442
443
444
445
446
447
448
449
450
451
452
453
	//! Close a topological hole (a sequence of connected fixed point of phi3). DO NOT USE, only for import/creation algorithm
	/*! \pre dart d MUST be fixed point of phi3 relation
	 *  Add a volume to the map that closes the hole.
	 *  @param d a dart of the hole (with phi3(d)==d)
	 *  @param forboundary tag the created face as boundary (default is true)
	 *  @return the degree of the created volume
	 */
	virtual unsigned int closeHole(Dart d, bool forboundary = true);

	//! Close the map removing topological holes: DO NOT USE, only for import/creation algorithm
	/*! Add volumes to the map that close every existing hole.
	 *  These faces are marked as boundary.
454
	 *  @return the number of closed holes
untereiner's avatar
untereiner committed
455
	 */
456
	unsigned int closeMap();
untereiner's avatar
untereiner committed
457
	//@}
untereiner's avatar
untereiner committed
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473

	/*! @name Compute dual
	 * These functions compute the dual mesh
	 *************************************************************************/

	//@{
	//! Reverse the orientation of the map
	/*!
	 */
	void reverseOrientation();

	//! Dual mesh computation
	/*!
	 */
	void computeDual();
	//@}
Pierre Kraemer's avatar
Pierre Kraemer committed
474
475
476
477
478
479
480
};

} // namespace CGoGN

#include "Topology/map/map3.hpp"

#endif