map3.h 13.7 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;

60 61 62 63 64 65 66 67 68 69
	inline static unsigned int ORBIT_IN_PARENT(unsigned int o)	{ return o+7; }
	inline static unsigned int ORBIT_IN_PARENT2(unsigned int o) { return o+5; }

	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;

Pierre Kraemer's avatar
Pierre Kraemer committed
70 71
	Map3();

72
	virtual std::string mapTypeName() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
73 74 75

	virtual unsigned int dimension();

76 77
	virtual void clear(bool removeAttrib);

Sylvain Thery's avatar
Sylvain Thery committed
78 79
	virtual void update_topo_shortcuts();

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

Pierre Kraemer's avatar
Pierre Kraemer committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
	/*! @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
103
	/*! @param d,e the darts to link
Pierre Kraemer's avatar
Pierre Kraemer committed
104 105 106 107 108 109
	 *	- 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
110
	/*! @param d the dart to unlink
Pierre Kraemer's avatar
Pierre Kraemer committed
111 112 113 114 115
	 * - Before:	d->e and e->d
	 * - After:		d->d and e->e
	 */
	void phi3unsew(Dart d);

116
public:
Pierre Kraemer's avatar
Pierre Kraemer committed
117 118 119 120 121
	/*! @name Generator and Deletor
	 *  To generate or delete volumes in a 3-map
	 *************************************************************************/

	//@{
122 123 124
	//! 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
125
	 */
126
	virtual void deleteVolume(Dart d);
untereiner's avatar
untereiner committed
127 128 129 130 131 132

	//! 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) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
133 134 135 136 137 138 139
	//@}

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

	//@{
140 141 142 143 144 145 146 147 148
	//! Split the vertex
	/*! \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
	 *  @param d first dart in vertex v
	 *	@param e second dart in vertex v
	 */
	virtual void splitVertex(Dart d, Dart e);

149
	//! Delete the vertex of d
150
	/*! All the volumes around the vertex are merged into one volume
151
	 *  @param d a dart of the vertex to delete
152
	 *  @return a Dart of the resulting volume
Pierre Kraemer's avatar
Pierre Kraemer committed
153
	 */
154
	virtual Dart deleteVertex(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
155

Pierre Kraemer's avatar
Pierre Kraemer committed
156
	//! Cut the edge of d (all darts around edge orbit are cut)
157
	/*! @param d a dart of the edge to cut
Pierre Kraemer's avatar
Pierre Kraemer committed
158
	 *  @return a dart of the new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
159
	 */
David Cazier's avatar
David Cazier committed
160
	virtual Dart cutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
161

Pierre Kraemer's avatar
Pierre Kraemer committed
162
	//! Uncut the edge of d (all darts around edge orbit are uncut)
163
	/*! @param d a dart of the edge to uncut
Pierre Kraemer's avatar
Pierre Kraemer committed
164
	 */
165
	virtual bool uncutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
166

167 168 169 170 171 172

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

173 174 175 176
	//! 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
177 178 179 180 181 182 183 184 185 186 187
	 */
	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);

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

Pierre Kraemer's avatar
Pierre Kraemer committed
203 204 205 206 207 208 209
	//! 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);

210 211 212 213 214 215 216
	//! 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);

217 218 219 220 221 222
	//! 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
	 */
223
	bool collapseDegeneretedVolume(Dart d);
224

225 226 227 228
	//!! sewVolumes Pre-condition
	bool sewVolumesPreCond(Dart d, Dart e);


229
	//! Sew two oriented volumes along their faces. 
Pierre Kraemer's avatar
Pierre Kraemer committed
230
	/*! The oriented faces should not be phi3-linked and have the same degree
231 232
	 *  @param d a dart of the first volume
	 *  @param e a dart of the second volume
233
	 *  @param withBoundary: if false, volumes must have phi3 fixed points (only for construction: import/primitives)
Pierre Kraemer's avatar
Pierre Kraemer committed
234
	 */
235
	virtual void sewVolumes(Dart d, Dart e, bool withBoundary = true);
Pierre Kraemer's avatar
Pierre Kraemer committed
236

237 238 239
	//! Unsew volumes pre-condition
	bool unsewVolumesPreCond(Dart d);

240 241
	//! Unsew two oriented volumes along their faces.
	/*! @param d a dart of one volume
Pierre Kraemer's avatar
Pierre Kraemer committed
242
	 */
243
	virtual void unsewVolumes(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
244

245 246
	//! Merge to volume along their common oriented face
	/*! @param d a dart of common face
Pierre Kraemer's avatar
Pierre Kraemer committed
247
	 */
248
	virtual bool mergeVolumes(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
249

untereiner's avatar
untereiner committed
250 251 252 253
	//! Split a volume into two volumes along a edge path
	/*! @param vd a vector of darts
	 */
	virtual void splitVolume(std::vector<Dart>& vd);
254 255 256 257 258 259 260

	//! 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);
261
	//@}
Pierre Kraemer's avatar
Pierre Kraemer committed
262

263 264 265 266 267 268 269 270 271 272 273
	/*! @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) ;

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

279 280 281 282 283
	//! Compute the number of edges of the vertex of d on the boundary
	/*!	@param d a dart
	 */
	unsigned int vertexDegreeOnBoundary(Dart d);

284 285 286
	//! Tell if the vertex of d is on the boundary
	/*! @param d a dart
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
287
	bool isBoundaryVertex(Dart d) ;
288

untereiner's avatar
untereiner committed
289 290 291 292 293 294
	//! 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) ;

295 296 297 298 299 300 301 302 303 304 305 306
	//! 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) ;

307 308
	//! Compute the number of volumes around the edge of d
	/*! @param d a dart
Pierre Kraemer's avatar
Pierre Kraemer committed
309
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
310
	unsigned int edgeDegree(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
311

untereiner's avatar
untereiner committed
312 313
	//! Tell if the edge of d is on the boundary of the map
	/*! @param d a dart
untereiner's avatar
bla  
untereiner committed
314 315 316
	 */
	bool isBoundaryEdge(Dart d) ;

untereiner's avatar
untereiner committed
317 318 319
	//! 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
320
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
321
	Dart findBoundaryFaceOfEdge(Dart d) ;
untereiner's avatar
untereiner committed
322

323 324 325
	//! 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
326
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
327
	bool sameFace(Dart d, Dart e) ;
untereiner's avatar
untereiner committed
328

329 330
	//! Test if the face is on the boundary
	/*! @param d a dart from the face
Pierre Kraemer's avatar
Pierre Kraemer committed
331
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
332
	bool isBoundaryFace(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
333

334 335
	//! Tell if a face of the volume is on the boundary
	/*  @param d a dart
336
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
337
	bool isBoundaryVolume(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
338

339 340 341 342 343
	//! Tell if an edge of the volume is on the boundary
	/*	@param d a dart
	 */
	bool hasBoundaryEdge(Dart d);

untereiner's avatar
untereiner committed
344 345 346
	//! Check the map completeness
	/*! Test if phi3 and phi2 ares involutions and if phi1 is a permutation
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
347
	virtual bool check() ;
Pierre Kraemer's avatar
Pierre Kraemer committed
348 349 350 351 352 353 354
	//@}

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

	//@{
355 356 357 358
	//! 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
359
	bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
360

361 362 363 364
	//! 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
365
	bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
366

367
	//! Apply a functor on each dart of a face
368 369 370
	/*! @param d a dart of the oriented face
	 *  @param fonct the functor
	 */
untereiner's avatar
bla  
untereiner committed
371
	bool foreach_dart_of_face(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
372

373 374 375 376 377 378
	//! Apply a functor on each dart of a face
	/*! @param d a dart of the oriented face
	 *  @param fonct the functor
	 */
	bool foreach_dart_of_volume(Dart d, FunctorType& f, unsigned int thread);

379 380 381 382
	//! 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
383
	bool foreach_dart_of_cc(Dart d, FunctorType& f, unsigned int thread = 0);
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403


	//! 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
404 405
	//@}

untereiner's avatar
untereiner committed
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
	/*! @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 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.
423
	 *  @return the number of closed holes
untereiner's avatar
untereiner committed
424
	 */
425
	unsigned int closeMap();
untereiner's avatar
untereiner committed
426
	//@}
Pierre Kraemer's avatar
Pierre Kraemer committed
427 428 429 430 431 432 433
};

} // namespace CGoGN

#include "Topology/map/map3.hpp"

#endif