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

#ifndef __MAP1_H__
#define __MAP1_H__

#include "Topology/generic/dartmarker.h"
#include "Topology/generic/cellmarker.h"

namespace CGoGN
{

34 35
class MapMono;

Pierre Kraemer's avatar
Pierre Kraemer committed
36 37 38 39
/*! \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.
40 41 42
 *  - 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
43
 */
44 45
template <class MAP = MapMono>
class Map1 : public MAP
Pierre Kraemer's avatar
Pierre Kraemer committed
46
{
47
<<<<<<< HEAD
untereiner's avatar
untereiner committed
48 49
//protected:
public:
50 51
	AttributeMultiVector<Dart>* m_phi1 ;
	AttributeMultiVector<Dart>* m_phi_1 ;
Pierre Kraemer's avatar
Pierre Kraemer committed
52

53 54 55
=======
protected:
>>>>>>> debut grosse update classes de carte...
56 57
	void init() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
58 59 60
public:
	Map1();

61 62
	static const unsigned int DIMENSION = 1 ;

63
	virtual std::string mapTypeName() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
64

65
	virtual unsigned int dimension() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
66

67 68
	virtual void clear(bool removeAttrib);

Sylvain Thery's avatar
Sylvain Thery committed
69 70
	virtual void update_topo_shortcuts();

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

Pierre Kraemer's avatar
Pierre Kraemer committed
73 74 75 76 77 78
	/*! @name Basic Topological Operators
	 * Access and Modification
	 *************************************************************************/

	virtual Dart newDart();

Sylvain Thery's avatar
Sylvain Thery committed
79
	Dart phi1(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
80

Sylvain Thery's avatar
Sylvain Thery committed
81
	Dart phi_1(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
82 83

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

Sylvain Thery's avatar
Sylvain Thery committed
86
	Dart alpha1(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
87

Sylvain Thery's avatar
Sylvain Thery committed
88
	Dart alpha_1(Dart d) const;
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 110 111 112 113 114 115 116 117 118

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
	 */
119
	Dart newCycle(unsigned int nbEdges) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
120

Sylvain Thery's avatar
Sylvain Thery committed
121 122 123 124
	//! Create an new face for boundary (marked)
	/*! @param nbEdges the number of edges
	 *  @return return a dart of the face
	 */
125
//	Dart newBoundaryCycle(unsigned int nbEdges);
Sylvain Thery's avatar
Sylvain Thery committed
126

Pierre Kraemer's avatar
Pierre Kraemer committed
127 128 129
	//! Delete an oriented face erasing all its darts
	/*! @param d a dart of the face
	 */
130
	void deleteCycle(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
131 132 133 134 135 136 137
	//@}

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

	//@{
138
	//! Cut an edge inserting a new dart between d and its successor in the cycle
Pierre Kraemer's avatar
Pierre Kraemer committed
139 140 141
	/*! @param d the edge to cut
	 * \image hmtl map1_cutEdge.png
	 */
David Cazier's avatar
David Cazier committed
142
	Dart cutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
143

144 145 146 147 148
	//! Undo the cut of the edge of d
	/*! @param d a dart of the edge to uncut
	 */
	void uncutEdge(Dart d);

149
	//! Collapse an edge of a cycle
Pierre Kraemer's avatar
Pierre Kraemer committed
150 151 152 153 154
	/*!  \warning Dart d no longer exists after the call
	 *  @param d the edge
	 */
	void collapseEdge(Dart d);

155
	//! Split a cycle between vertices d and e
Pierre Kraemer's avatar
Pierre Kraemer committed
156 157 158 159
	/*! \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
	 */
160
	void splitCycle(Dart d, Dart e);
Pierre Kraemer's avatar
Pierre Kraemer committed
161

162
	//! Merge two cycles on vertices d and e
Pierre Kraemer's avatar
Pierre Kraemer committed
163 164 165 166
	/*! \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
	 */
167 168
	void mergeCycles(Dart d, Dart e);

169
	//! Link two cycles by adding an edge between two vertices
170 171 172 173 174
	/*! \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
175 176 177 178

	//! reverse a face (phi1 become phi_1 and ...)
	/*! @param d a dart of face
	 */
179
	void reverseCycle(Dart d) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
180 181 182 183 184 185 186
	//@}

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

	//@{
187
	//! Test if darts d and e belong to the same cycle
Pierre Kraemer's avatar
Pierre Kraemer committed
188 189 190
	/*! @param d a dart
	 *  @param e a dart
	 */
Sylvain Thery's avatar
Sylvain Thery committed
191
	bool sameCycle(Dart d, Dart e) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
192

193 194 195
	//! 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
196
	 */
Sylvain Thery's avatar
Sylvain Thery committed
197
	unsigned int cycleDegree(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
198

199 200 201 202 203
	//! 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
204
	 int checkCycleDegree(Dart d, unsigned int degree) const;
205

Pierre Kraemer's avatar
Pierre Kraemer committed
206
	/**
207 208
	 * 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
209
	 */
Sylvain Thery's avatar
Sylvain Thery committed
210
	bool isCycleTriangle(Dart d) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
211 212 213 214 215 216 217 218 219 220 221
	//@}

	/*! @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
222
	bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
223 224 225 226 227

	//! 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
228
	bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
229 230 231


	//! Apply a functor on every dart of a connected component
232
	/*! @param d a dart of the connected component
Pierre Kraemer's avatar
Pierre Kraemer committed
233 234
	 *  @param f the functor to apply
	 */
Sylvain Thery's avatar
Sylvain Thery committed
235
	bool foreach_dart_of_cc(Dart d, FunctorType& f, unsigned int thread = 0) const;
Pierre Kraemer's avatar
Pierre Kraemer committed
236 237 238 239 240 241 242 243
	//@}
} ;

} // namespace CGoGN

#include "Topology/map/map1.hpp"

#endif