map2.h 14.8 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 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;

58 59 60 61 62
	inline static unsigned int ORBIT_IN_PARENT(unsigned int o)	{ return o+5; }

	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
63 64 65 66 67 68
	Map2();

	virtual std::string mapTypeName();

	virtual unsigned int dimension();

69 70
	virtual void clear(bool removeAttrib);

Sylvain Thery's avatar
Sylvain Thery committed
71 72
	virtual void update_topo_shortcuts();

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

Pierre Kraemer's avatar
Pierre Kraemer committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
	/*! @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);

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

107
public:
108

109 110
	void rdfi(Dart t, DartMarker& m1, DartMarker& m2);

Pierre Kraemer's avatar
Pierre Kraemer committed
111 112 113 114 115
	/*! @name Generator and Deletor
	 *  To generate or delete faces in a 2-map
	 *************************************************************************/

	//@{
116 117
	//! Create an new face of nbEdges
	/*! @param nbEdges the number of edges
118
	 *  @param withBoudary create the face and its boundary (default true)
119 120
	 *  @return return a dart of the face
	 */
121
	virtual Dart newFace(unsigned int nbEdges, bool withBoundary = true) ;
122

123 124
	//! Delete the face of d
	/*! @param d a dart of the face
125
	 *  @param withBoudary  create or extend boundary face instead of fixed points (default true)
126
	 */
127
	virtual void deleteFace(Dart d, bool withBoundary = true) ;
128

untereiner's avatar
untereiner committed
129 130 131 132 133
	//! Delete a connected component of the map
	/*! @param d a dart of the connected component
	 */
	virtual void deleteCC(Dart d) ;

134 135 136 137 138
	//! 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
139 140 141 142 143 144 145 146 147 148 149 150 151 152
	//@}

	/*! @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
153
	//! Delete the vertex of d (works only for internal vertices)
Pierre Kraemer's avatar
Pierre Kraemer committed
154 155
	/*! Does not create a hole -> all the faces
	 * 	around the vertex are merged into one face
Pierre Kraemer's avatar
Pierre Kraemer committed
156
	 *  @param d a dart of the vertex to delete
157
	 *  @return a dart of the resulting face (NIL if the deletion has not been executed)
Pierre Kraemer's avatar
Pierre Kraemer committed
158
	 */
159
	virtual Dart deleteVertex(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
160

Pierre Kraemer's avatar
Pierre Kraemer committed
161
	//! Cut the edge of d by inserting a new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
162
	/*! @param d a dart of the edge to cut
Pierre Kraemer's avatar
Pierre Kraemer committed
163
	 *  @return a dart of the new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
164
	 */
David Cazier's avatar
David Cazier committed
165
	virtual Dart cutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
166

Pierre Kraemer's avatar
Pierre Kraemer committed
167
	//! Undo the cut of the edge of d
Pierre Kraemer's avatar
Pierre Kraemer committed
168
	/*! @param d a dart of the edge to uncut
169
	 *  @return true if the uncut has been executed, false otherwise
Pierre Kraemer's avatar
Pierre Kraemer committed
170
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
171
	virtual bool uncutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
172

Pierre Kraemer's avatar
Pierre Kraemer committed
173 174
	//! Collapse an edge (that is deleted) possibly merging its vertices
	/*! If delDegenerateFaces is true, the method checks that no degenerate
175
	 *  faces are built (faces with less than 3 edges). If it occurs the faces
Pierre Kraemer's avatar
Pierre Kraemer committed
176 177 178 179 180
	 *  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)
181
	 *  @return a dart of the resulting vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
182
	 */
183
	virtual Dart collapseEdge(Dart d, bool delDegenerateFaces = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
184 185

	/**
186
	 * Flip the edge of d (rotation in phi1 order)
187
	 * WARNING : Works only for non-border edges
Pierre Kraemer's avatar
Pierre Kraemer committed
188 189 190 191 192 193
	 * @param d a dart of the edge to flip
	 * @return true if the flip has been executed, false otherwise
	 */
	virtual bool flipEdge(Dart d);

	/**
194
	 * Flip the edge of d (rotation in phi_1 order)
195
	 * WARNING : Works only for non-border edges
Pierre Kraemer's avatar
Pierre Kraemer committed
196
	 * @param d a dart of the edge to flip
Pierre Kraemer's avatar
Pierre Kraemer committed
197
	 * @return true if the flipBack has been executed, false otherwise
Pierre Kraemer's avatar
Pierre Kraemer committed
198 199 200
	 */
	virtual bool flipBackEdge(Dart d);

201 202 203 204 205 206 207 208 209 210 211 212 213 214
//	//! 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 sewed
//	 *  @param d the dart of the edge to remove from the vertex
//	 * @return true if the removal has been executed, false otherwise
//	 */
//	virtual bool removeEdgeFromVertex(Dart d);
215

Pierre Kraemer's avatar
Pierre Kraemer committed
216
	//! Sew two oriented faces along oriented edges
Pierre Kraemer's avatar
Pierre Kraemer committed
217
	/*! \pre Edges of darts d & e MUST be boundary edges
Pierre Kraemer's avatar
Pierre Kraemer committed
218 219
	 *  @param d a dart of the first face
	 *  @param e a dart of the second face
220
	 *  @param withBoundary: if false, faces must have phi2 fixed points (only for construction: import/primitives)
Pierre Kraemer's avatar
Pierre Kraemer committed
221
	 */
222
	virtual void sewFaces(Dart d, Dart e, bool withBoundary = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
223

224 225 226
	//! 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
227 228
	 */
	virtual void unsewFaces(Dart d);
Sylvain Thery's avatar
Sylvain Thery committed
229

Pierre Kraemer's avatar
Pierre Kraemer committed
230
	//! Delete an oriented face if and only if it has one or two edges
231 232
	/*! If the face is sewed to two distinct adjacent faces,
	 *  then those two faces are sewed
Pierre Kraemer's avatar
Pierre Kraemer committed
233 234 235 236 237 238 239 240 241 242 243 244 245
	 *  @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.
246 247
	/*! 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
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
	 *  @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) ;

266
	/**
267
	 * Unsew the faces of the umbrella of the vertex of d
268 269
	 * @param d a dart from the vertex
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
270
	void unsewAroundVertex(Dart d) ;
Sylvain Thery's avatar
Sylvain Thery committed
271

Pierre Kraemer's avatar
Pierre Kraemer committed
272 273
	//! Merge two volumes along two faces.
	/*! Works only if the two faces have the same number of edges.
274
	 *  The faces adjacent to the two given faces are pairwise sewed
Pierre Kraemer's avatar
Pierre Kraemer committed
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
	 *  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
	 *************************************************************************/

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

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
	//! 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
312
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
313 314
	 * 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
315
	 */
316
	Dart findBoundaryEdgeOfVertex(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
317

Pierre Kraemer's avatar
Pierre Kraemer committed
318 319 320
	//! Test if dart d and e belong to the same edge
	/*! @param d a dart
	 *  @param e a dart
321
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
322
	bool sameEdge(Dart d, Dart e) ;
323

Pierre Kraemer's avatar
Pierre Kraemer committed
324
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
325
	 * tell if the edge of d is on the boundary of the map
Pierre Kraemer's avatar
Pierre Kraemer committed
326
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
327
	bool isBoundaryEdge(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
328

untereiner's avatar
bla  
untereiner committed
329
	//! Test if dart d and e belong to the same oriented face
untereiner's avatar
untereiner committed
330 331 332 333 334
	/*! @param d a dart
	 *  @param e a dart
	 */
	bool sameOrientedFace(Dart d, Dart e);

Pierre Kraemer's avatar
Pierre Kraemer committed
335 336 337 338 339
	//! 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
340

341
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
342
	 * compute the number of edges of the face of d
343
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
344
	unsigned int faceDegree(Dart d) ;
Sylvain Thery's avatar
Sylvain Thery committed
345

Pierre Kraemer's avatar
Pierre Kraemer committed
346 347 348 349
	/**
	 * tell if the face of d is on the boundary of the map
	 */
	bool isBoundaryFace(Dart d) ;
350 351

	//! Test if dart d and e belong to the same oriented volume
Pierre Kraemer's avatar
Pierre Kraemer committed
352 353 354
	/*! @param d a dart
	 *  @param e a dart
	 */
355
	bool sameOrientedVolume(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
356

357
	//! Test if dart d and e belong to the same volume
358
	/*! @param d a dart
359
	 *  @param e a dart
Pierre Kraemer's avatar
Pierre Kraemer committed
360
	 */
361
	bool sameVolume(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
362

363 364
	//! Compute the number of faces in the volume of d
	/*! @param d a dart
Pierre Kraemer's avatar
Pierre Kraemer committed
365 366 367 368 369 370 371 372 373 374
	 */
	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
375
	// TODO a mettre en algo
Pierre Kraemer's avatar
Pierre Kraemer committed
376 377
	/**
	 * Check if map is complete
Pierre Kraemer's avatar
Pierre Kraemer committed
378
	 * Should be executed after import
Pierre Kraemer's avatar
Pierre Kraemer committed
379 380
	 */
	virtual bool check();
untereiner's avatar
untereiner committed
381 382 383 384 385

	/**
	 * 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
386 387 388 389 390 391
	//@}

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

392
	//@{
Pierre Kraemer's avatar
Pierre Kraemer committed
393 394 395 396
	//! 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
397
	bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
398

untereiner's avatar
untereiner committed
399
	//! Apply a functor on every dart of an edge
Pierre Kraemer's avatar
Pierre Kraemer committed
400 401 402
	/*! @param d a dart of the edge
	 *  @param f the functor to apply
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
403
	bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
404

405
	//! Apply a functor on every dart of an face
406 407 408
	/*! @param d a dart of the volume
	 *  @param f the functor to apply
	 */
409
	bool foreach_dart_of_face(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
410 411 412 413 414

	//! 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
415
	bool foreach_dart_of_cc(Dart d, FunctorType& f, unsigned int thread = 0);
416 417 418 419 420 421 422 423 424 425 426 427 428

	//! 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
429
	//@}
Sylvain Thery's avatar
Sylvain Thery committed
430

Pierre Kraemer's avatar
Pierre Kraemer committed
431 432 433 434
	/*! @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
435
	//@{
436
	//! 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
437 438 439
	/*! \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)
440
	 *  @param forboundary tag the created face as boundary (default is true)
Sylvain Thery's avatar
Sylvain Thery committed
441 442
	 *  @return the degree of the created face
	 */
443
	virtual unsigned int closeHole(Dart d, bool forboundary = true);
Sylvain Thery's avatar
Sylvain Thery committed
444

445
	//! Close the map removing topological holes: DO NOT USE, only for import/creation algorithm
Sylvain Thery's avatar
Sylvain Thery committed
446
	/*! Add faces to the map that close every existing hole.
447
	 *  These faces are marked as boundary.
Sylvain Thery's avatar
Sylvain Thery committed
448 449
	 */
	void closeMap();
Pierre Kraemer's avatar
Pierre Kraemer committed
450 451 452 453 454 455 456 457
	//@}
};

} // namespace CGoGN

#include "Topology/map/map2.hpp"

#endif