map1.h 7.19 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
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __MAP1_H__
#define __MAP1_H__

Pierre Kraemer's avatar
Pierre Kraemer committed
28
#include "Topology/generic/mapMono.h"
Pierre Kraemer's avatar
Pierre Kraemer committed
29
30
31
32
33
34
35
36
37
38
#include "Topology/generic/dartmarker.h"
#include "Topology/generic/cellmarker.h"

namespace CGoGN
{

/*! \brief The class of dual 1-dimensional combinatorial maps: set of oriented faces.
 *  - A dual 1-map is made of darts linked by the phi1 permutation.
 *  - In this class darts are interpreted as oriented edges.
 *  - The phi1 relation defines cycles of darts or (oriented) faces.
39
40
41
 *  - Faces may have arbitrary size.
 *  - Faces with only one edge (sometime called loops) are accepted.
 *  - Degenerated faces with only two edges are accepted.
Pierre Kraemer's avatar
Pierre Kraemer committed
42
 */
43
44
template <class MAP = MapMono>
class Map1 : public MAP
Pierre Kraemer's avatar
Pierre Kraemer committed
45
{
46
protected:
47
48
	void init() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
49
50
51
public:
	Map1();

52
53
	static const unsigned int DIMENSION = 1 ;

54
	virtual std::string mapTypeName() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
55

56
	virtual unsigned int dimension() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
57

58
59
	virtual void clear(bool removeAttrib);

Sylvain Thery's avatar
Sylvain Thery committed
60
61
	virtual void update_topo_shortcuts();

Pierre Kraemer's avatar
Pierre Kraemer committed
62
63
64
65
	/*! @name Basic Topological Operators
	 * Access and Modification
	 *************************************************************************/

Sylvain Thery's avatar
Sylvain Thery committed
66
	Dart phi1(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
67

Sylvain Thery's avatar
Sylvain Thery committed
68
	Dart phi_1(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
69
70

	template <int N>
Sylvain Thery's avatar
Sylvain Thery committed
71
	Dart phi(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
72

Sylvain Thery's avatar
Sylvain Thery committed
73
	Dart alpha1(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
74

Sylvain Thery's avatar
Sylvain Thery committed
75
	Dart alpha_1(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
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

protected:
	//! Link the current dart to dart d with a permutation
	/*! @param d the dart to which the current is linked
	 * - Before:	d->f and e->g
	 * - After:		d->g and e->f
	 * Join the permutations cycles of dart d and e
	 * - Starting from two cycles : d->f->...->d and e->g->...->e
	 * - It makes one cycle d->g->...->e->f->...->d
	 * If e = g then insert e in the cycle of d : d->e->f->...->d
	 */
	void phi1sew(Dart d, Dart e);

	//! Unlink the successor of a given dart in a permutation
	/*!	@param d a dart
	 * - Before:	d->e->f
	 * - After:		d->f and e->e
	 */
	void phi1unsew(Dart d);

public:
	/*! @name Generator and Deletor
	 *  To generate or delete faces in a 1-map
	 *************************************************************************/

	//@{
	//! Create an new face made of nbEdges linked darts.
	/*! @param nbEdges the number of edges
	 *  @return return a dart of the face
	 */
106
	Dart newCycle(unsigned int nbEdges) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
107
108
109
110

	//! Delete an oriented face erasing all its darts
	/*! @param d a dart of the face
	 */
111
	void deleteCycle(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
112
113
114
115
116
117
118
	//@}

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

	//@{
119
	//! Cut an edge inserting a new dart between d and its successor in the cycle
Pierre Kraemer's avatar
Pierre Kraemer committed
120
121
122
	/*! @param d the edge to cut
	 * \image hmtl map1_cutEdge.png
	 */
David Cazier's avatar
David Cazier committed
123
	Dart cutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
124

Pierre Kraemer's avatar
Pierre Kraemer committed
125
126
127
128
129
	//! Undo the cut of the edge of d
	/*! @param d a dart of the edge to uncut
	 */
	void uncutEdge(Dart d);

130
	//! Collapse an edge of a cycle
Pierre Kraemer's avatar
Pierre Kraemer committed
131
132
133
134
135
	/*!  \warning Dart d no longer exists after the call
	 *  @param d the edge
	 */
	void collapseEdge(Dart d);

136
	//! Split a cycle between vertices d and e
Pierre Kraemer's avatar
Pierre Kraemer committed
137
138
139
140
	/*! \pre Dart d and e MUST be different and belong to the same face
	 *  @param d first dart in the face
	 *  @param e second dart in the face
	 */
141
	void splitCycle(Dart d, Dart e);
Pierre Kraemer's avatar
Pierre Kraemer committed
142

143
	//! Merge two cycles on vertices d and e
Pierre Kraemer's avatar
Pierre Kraemer committed
144
145
146
147
	/*! \pre Dart d and e MUST belong to distinct faces
	 *  @param d a dart in the first face
	 *  @param e a dart in the second face
	 */
148
149
	void mergeCycles(Dart d, Dart e);

150
	//! Link two cycles by adding an edge between two vertices
151
152
153
154
155
	/*! \pre Dart d and e MUST be different and belong to distinct face
	 *  @param d first dart in the face
	 *  @param e second dart in the face
	 */
	void linkCycles(Dart d, Dart e);
Pierre Kraemer's avatar
Pierre Kraemer committed
156
157
158
159

	//! reverse a face (phi1 become phi_1 and ...)
	/*! @param d a dart of face
	 */
160
	void reverseCycle(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
161
162
163
164
165
166
167
	//@}

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

	//@{
168
	//! Test if darts d and e belong to the same cycle
Pierre Kraemer's avatar
Pierre Kraemer committed
169
170
171
	/*! @param d a dart
	 *  @param e a dart
	 */
Sylvain Thery's avatar
Sylvain Thery committed
172
	bool sameCycle(Dart d, Dart e) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
173

174
175
176
	//! Length of a cycle (its number of oriented edges)
	/*! @param d a dart of the cycle
	 *  @return the length of the cycle
Pierre Kraemer's avatar
Pierre Kraemer committed
177
	 */
Sylvain Thery's avatar
Sylvain Thery committed
178
	unsigned int cycleDegree(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
179

180
181
182
183
184
	//! Check the Length of a cycle (its number of oriented edges)
	/*! @param d a dart of the cycle
	 *  @param degree the length to compare
	 *  @return  negative/null/positive if face degree is less/equal/greater than given degree
	 */
Sylvain Thery's avatar
Sylvain Thery committed
185
	 int checkCycleDegree(Dart d, unsigned int degree) const;
186

Pierre Kraemer's avatar
Pierre Kraemer committed
187
	/**
188
189
	 * check if the cycle of d is a triangle
	 * @return a boolean indicating if the cycle is a triangle
Pierre Kraemer's avatar
Pierre Kraemer committed
190
	 */
Sylvain Thery's avatar
Sylvain Thery committed
191
	bool isCycleTriangle(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
192
193
194
195
196
197
198
199
200
201
202
	//@}

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

	//@{
	//! Apply a functor on every dart of a vertex
	/*! @param d a dart of the vertex
	 *  @param f the functor to apply
	 */
Sylvain Thery's avatar
Sylvain Thery committed
203
	bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
204
205
206
207
208

	//! Apply a functor on every dart of an edge
	/*! @param d a dart of the edge
	 *  @param f the functor to apply
	 */
Sylvain Thery's avatar
Sylvain Thery committed
209
	bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
210
211
212


	//! Apply a functor on every dart of a connected component
213
	/*! @param d a dart of the connected component
Pierre Kraemer's avatar
Pierre Kraemer committed
214
215
	 *  @param f the functor to apply
	 */
Sylvain Thery's avatar
Sylvain Thery committed
216
	bool foreach_dart_of_cc(Dart d, FunctorType& f, unsigned int thread = 0) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
217
218
219
220
221
222
223
224
	//@}
} ;

} // namespace CGoGN

#include "Topology/map/map1.hpp"

#endif