map2.h 13.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 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 58 59 60 61 62 63
public:
	typedef Map1 ParentMap;

	Map2();

	virtual std::string mapTypeName();

	virtual unsigned int dimension();

64 65
	virtual void clear(bool removeAttrib);

Pierre Kraemer's avatar
Pierre Kraemer committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
	/*! @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);

98
public:
Pierre Kraemer's avatar
Pierre Kraemer committed
99 100 101 102 103
	/*! @name Generator and Deletor
	 *  To generate or delete faces in a 2-map
	 *************************************************************************/

	//@{
104 105
	//! Create an new face of nbEdges
	/*! @param nbEdges the number of edges
106
	 *  @param withBoudary create the face and its boundary (default true)
107 108
	 *  @return return a dart of the face
	 */
109
	virtual Dart newFace(unsigned int nbEdges, bool withBoundary = true) ;
110

111 112
	//! Delete the face of d
	/*! @param d a dart of the face
113
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
114
	virtual void deleteFace(Dart d) ;
115

untereiner's avatar
untereiner committed
116 117 118 119 120
	//! Delete a connected component of the map
	/*! @param d a dart of the connected component
	 */
	virtual void deleteCC(Dart d) ;

121 122 123 124 125
	//! 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
126 127 128 129 130 131 132 133 134 135 136 137 138 139
	//@}

	/*! @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
140
	//! Delete the vertex of d (works only for internal vertices)
Pierre Kraemer's avatar
Pierre Kraemer committed
141 142
	/*! Does not create a hole -> all the faces
	 * 	around the vertex are merged into one face
Pierre Kraemer's avatar
Pierre Kraemer committed
143
	 *  @param d a dart of the vertex to delete
144
	 *  @return a dart of the resulting face (NIL if the deletion has not been executed)
Pierre Kraemer's avatar
Pierre Kraemer committed
145
	 */
146
	virtual Dart deleteVertex(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
147

Pierre Kraemer's avatar
Pierre Kraemer committed
148
	//! Cut the edge of d by inserting a new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
149 150 151 152
	/*! @param d a dart of the edge to cut
	 */
	virtual void cutEdge(Dart d);

Pierre Kraemer's avatar
Pierre Kraemer committed
153
	//! Undo the cut of the edge of d
Pierre Kraemer's avatar
Pierre Kraemer committed
154
	/*! @param d a dart of the edge to uncut
155
	 *  @return true if the uncut has been executed, false otherwise
Pierre Kraemer's avatar
Pierre Kraemer committed
156
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
157
	virtual bool uncutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
158

Pierre Kraemer's avatar
Pierre Kraemer committed
159 160
	//! Collapse an edge (that is deleted) possibly merging its vertices
	/*! If delDegenerateFaces is true, the method checks that no degenerate
161
	 *  faces are built (faces with less than 3 edges). If it occurs the faces
Pierre Kraemer's avatar
Pierre Kraemer committed
162 163 164 165 166
	 *  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)
167
	 *  @return a dart of the resulting vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
168
	 */
169
	virtual Dart collapseEdge(Dart d, bool delDegenerateFaces = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
170 171

	/**
172
	 * Flip the edge of d (rotation in phi1 order)
173
	 * WARNING : Works only for non-border edges
Pierre Kraemer's avatar
Pierre Kraemer committed
174 175 176 177 178 179
	 * @param d a dart of the edge to flip
	 * @return true if the flip has been executed, false otherwise
	 */
	virtual bool flipEdge(Dart d);

	/**
180
	 * Flip the edge of d (rotation in phi_1 order)
181
	 * WARNING : Works only for non-border edges
Pierre Kraemer's avatar
Pierre Kraemer committed
182
	 * @param d a dart of the edge to flip
Pierre Kraemer's avatar
Pierre Kraemer committed
183
	 * @return true if the flipBack has been executed, false otherwise
Pierre Kraemer's avatar
Pierre Kraemer committed
184 185 186
	 */
	virtual bool flipBackEdge(Dart d);

187 188 189 190 191 192 193 194 195 196 197 198 199 200
//	//! 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);
201

Pierre Kraemer's avatar
Pierre Kraemer committed
202
	//! Sew two oriented faces along oriented edges
Pierre Kraemer's avatar
Pierre Kraemer committed
203
	/*! \pre Edges of darts d & e MUST be boundary edges
Pierre Kraemer's avatar
Pierre Kraemer committed
204 205
	 *  @param d a dart of the first face
	 *  @param e a dart of the second face
206
	 *  @param withBoundary: if false, faces must have phi2 fixed points (only for construction: import/primitives)
Pierre Kraemer's avatar
Pierre Kraemer committed
207
	 */
208
	virtual void sewFaces(Dart d, Dart e, bool withBoundary = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
209

210 211 212
	//! 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
213 214
	 */
	virtual void unsewFaces(Dart d);
Sylvain Thery's avatar
Sylvain Thery committed
215

Pierre Kraemer's avatar
Pierre Kraemer committed
216
	//! Delete an oriented face if and only if it has one or two edges
217 218
	/*! If the face is sewed to two distinct adjacent faces,
	 *  then those two faces are sewed
Pierre Kraemer's avatar
Pierre Kraemer committed
219 220 221 222 223 224 225 226 227 228 229 230 231
	 *  @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.
232 233
	/*! 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
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
	 *  @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) ;

252
	/**
253
	 * Unsew the faces of the umbrella of the vertex of d
254 255
	 * @param d a dart from the vertex
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
256
	void unsewAroundVertex(Dart d) ;
Sylvain Thery's avatar
Sylvain Thery committed
257

Pierre Kraemer's avatar
Pierre Kraemer committed
258 259
	//! Merge two volumes along two faces.
	/*! Works only if the two faces have the same number of edges.
260
	 *  The faces adjacent to the two given faces are pairwise sewed
Pierre Kraemer's avatar
Pierre Kraemer committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
	 *  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) ;

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
	//! 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
298
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
299 300
	 * 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
301
	 */
302
	Dart findBoundaryEdgeOfVertex(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
303

Pierre Kraemer's avatar
Pierre Kraemer committed
304 305 306
	//! Test if dart d and e belong to the same edge
	/*! @param d a dart
	 *  @param e a dart
307
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
308
	bool sameEdge(Dart d, Dart e) ;
309

Pierre Kraemer's avatar
Pierre Kraemer committed
310
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
311
	 * tell if the edge of d is on the boundary of the map
Pierre Kraemer's avatar
Pierre Kraemer committed
312
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
313
	bool isBoundaryEdge(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
314

untereiner's avatar
bla  
untereiner committed
315
	//! Test if dart d and e belong to the same oriented face
untereiner's avatar
untereiner committed
316 317 318 319 320
	/*! @param d a dart
	 *  @param e a dart
	 */
	bool sameOrientedFace(Dart d, Dart e);

Pierre Kraemer's avatar
Pierre Kraemer committed
321 322 323 324 325
	//! 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
326

327
	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
328
	 * compute the number of edges of the face of d
329
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
330
	unsigned int faceDegree(Dart d) ;
Sylvain Thery's avatar
Sylvain Thery committed
331

Pierre Kraemer's avatar
Pierre Kraemer committed
332 333 334 335
	/**
	 * tell if the face of d is on the boundary of the map
	 */
	bool isBoundaryFace(Dart d) ;
336 337

	//! Test if dart d and e belong to the same oriented volume
Pierre Kraemer's avatar
Pierre Kraemer committed
338 339 340
	/*! @param d a dart
	 *  @param e a dart
	 */
341
	bool sameOrientedVolume(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
342

343
	//! Test if dart d and e belong to the same volume
344
	/*! @param d a dart
345
	 *  @param e a dart
Pierre Kraemer's avatar
Pierre Kraemer committed
346
	 */
347
	bool sameVolume(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
348

349 350
	//! Compute the number of faces in the volume of d
	/*! @param d a dart
Pierre Kraemer's avatar
Pierre Kraemer committed
351 352 353 354 355 356 357 358 359 360
	 */
	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
361
	// TODO a mettre en algo
Pierre Kraemer's avatar
Pierre Kraemer committed
362 363
	/**
	 * Check if map is complete
Pierre Kraemer's avatar
Pierre Kraemer committed
364
	 * Should be executed after import
Pierre Kraemer's avatar
Pierre Kraemer committed
365 366 367 368 369 370 371 372
	 */
	virtual bool check();
	//@}

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

373
	//@{
Pierre Kraemer's avatar
Pierre Kraemer committed
374 375 376 377
	//! 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
378
	bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
379 380 381 382 383

	//! Apply a functor on every dart of a edge
	/*! @param d a dart of the edge
	 *  @param f the functor to apply
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
384
	bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
385 386 387 388 389

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

392 393 394 395 396
	//! Apply a functor on every dart of a volume
	/*! @param d a dart of the volume
	 *  @param f the functor to apply
	 */

Pierre Kraemer's avatar
Pierre Kraemer committed
397
	bool foreach_dart_of_volume(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
398 399 400 401 402

	//! 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
403
	bool foreach_dart_of_cc(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
404
	//@}
Sylvain Thery's avatar
Sylvain Thery committed
405

Pierre Kraemer's avatar
Pierre Kraemer committed
406 407 408 409
	/*! @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
410
	//@{
411
	//! 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
412 413 414
	/*! \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)
415
	 *  @param forboundary tag the created face as boundary (default is true)
Sylvain Thery's avatar
Sylvain Thery committed
416 417
	 *  @return the degree of the created face
	 */
418
	virtual unsigned int closeHole(Dart d, bool forboundary = true);
Sylvain Thery's avatar
Sylvain Thery committed
419

420
	//! Close the map removing topological holes: DO NOT USE, only for import/creation algorithm
Sylvain Thery's avatar
Sylvain Thery committed
421
	/*! Add faces to the map that close every existing hole.
422
	 *  These faces are marked as boundary.
Sylvain Thery's avatar
Sylvain Thery committed
423 424
	 */
	void closeMap();
Pierre Kraemer's avatar
Pierre Kraemer committed
425 426 427 428 429 430 431 432
	//@}
};

} // namespace CGoGN

#include "Topology/map/map2.hpp"

#endif