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

#ifndef __GMAP1_H__
#define __GMAP1_H__

#include "Topology/gmap/gmap0.h"

namespace CGoGN
{

/**
* The class of 1-GMap
*/
class GMap1 : public GMap0
{
protected:
39
	AttributeMultiVector<Dart>* m_beta1 ;
Pierre Kraemer's avatar
Pierre Kraemer committed
40

41 42
	void init() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
43
public:
Thomas's avatar
Thomas committed
44 45
	typedef GMap0 ParentMap;

Pierre Kraemer's avatar
Pierre Kraemer committed
46 47
	GMap1();

48
	virtual std::string mapTypeName() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
49

50
	virtual unsigned int dimension() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
51

52 53
	virtual void clear(bool removeAttrib);

Sylvain Thery's avatar
Sylvain Thery committed
54 55
	virtual void update_topo_shortcuts();

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

Pierre Kraemer's avatar
Pierre Kraemer committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
	/*! @name Basic Topological Operators
	 * Access and Modification
	 *************************************************************************/

	virtual Dart newDart();

	Dart beta1(const Dart d);

	template <int N>
	Dart beta(const Dart d);

	Dart phi1(const Dart d);

	Dart phi_1(const Dart d);

	template <int N>
	Dart phi(const Dart d);

	Dart alpha1(const Dart d);

	Dart alpha_1(const Dart d);

80
protected:
Pierre Kraemer's avatar
Pierre Kraemer committed
81 82 83 84
	void beta1sew(Dart d, Dart e);

	void beta1unsew(Dart d);

85
public:
Pierre Kraemer's avatar
Pierre Kraemer committed
86 87 88 89 90 91
	/*! @name Constructors and Destructors
	 *  To generate or delete cells in a 1-G-map
	 *************************************************************************/

	//@{
	/**
92 93
	* create a new face
	* @param nbEdges the number of sides of face
Pierre Kraemer's avatar
Pierre Kraemer committed
94 95
	* @return a dart of the edge
	*/
96
	Dart newCycle(unsigned int nbEdges);
97 98 99 100 101

	//! Create an new face for boundary (marked)
	/*! @param nbEdges the number of edges
	 *  @return return a dart of the face
	 */
102
	Dart newBoundaryCycle(unsigned int nbEdges);
Pierre Kraemer's avatar
Pierre Kraemer committed
103 104 105 106

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

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

	//@{
	//! Cut an edge inserting a new dart between d and its successor in the face
	/*! @param d the edge to cut
117
	 *  @return a dart of the new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
118 119
	 * \image hmtl map1_cutEdge.png
	 */
120
	Dart cutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
121

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

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

	//! Split a face between vertices d and e
	/*! \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
	 */
138
	void splitCycle(Dart d, Dart e);
Pierre Kraemer's avatar
Pierre Kraemer committed
139 140 141 142 143 144 145

	//! Merge the two faces of d and e, darts d & e disappear
	/*! \pre Dart d and e MUST belong to distinct faces
	 *  \warning Darts d and e no longer exist after the call
	 *  @param d a dart in the first face
	 *  @param e a dart in the second face
	 */
146
	void mergeCycles(Dart d, Dart e);
147 148 149 150 151 152

	//! Link two faces by adding an edge between two vertices
	/*! \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
	 */
153
	void linkCycles(Dart d, Dart e);
Pierre Kraemer's avatar
Pierre Kraemer committed
154 155 156 157 158 159 160 161 162 163 164
	//@}

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

	//@{
	//! Test if dart d and e belong to the same oriented face
	/*! @param d a dart
	 *  @param e a dart
	 */
165
	bool sameOrientedCycle(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
166 167 168 169 170

	//! Test if dart d and e belong to the same face
	/*! @param d a dart
	 *  @param e a dart
	 */
171
	bool sameCycle(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
172 173 174 175 176

	//! Length of a face (its number of oriented edges)
	/*! @param d a dart of the face
	 *  @return the length of the face
	 */
177
	unsigned int cycleDegree(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
178 179 180 181 182

	/**
	 * check if the face of d is a triangle
	 * @return a boolean indicating if the face is a triangle
	 */
183
	bool isCycleTriangle(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
184 185 186 187 188 189 190 191
	//@}

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

	//@{
	/**
192 193
	* Apply a functor on each dart of a vertex
	* @param d a dart of the vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
194 195
	* @param fonct functor obj ref
	*/
Sylvain Thery's avatar
Sylvain Thery committed
196
	bool foreach_dart_of_vertex(Dart d, FunctorType& fonct, unsigned int thread=0);
Pierre Kraemer's avatar
Pierre Kraemer committed
197 198 199

	/**
	* Apply a functor on each dart of an edge
200
	* @param d a dart of the edge
Pierre Kraemer's avatar
Pierre Kraemer committed
201 202
	* @param fonct functor obj ref
	*/
Sylvain Thery's avatar
Sylvain Thery committed
203
	bool foreach_dart_of_edge(Dart d, FunctorType& fonct, unsigned int thread=0);
Pierre Kraemer's avatar
Pierre Kraemer committed
204 205

	/**
206 207
	* Apply a functor on each dart of an oriented cc (face)
	* @param d a dart of the oriented cc
Pierre Kraemer's avatar
Pierre Kraemer committed
208 209
	* @param fonct functor obj ref
	*/
210
	bool foreach_dart_of_oriented_cc(Dart d, FunctorType& f, unsigned int thread=0);
Pierre Kraemer's avatar
Pierre Kraemer committed
211

212 213
	//! Apply a functor on every dart of a cc (face)
	/*! @param d a dart of the cc
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& fonct, unsigned int thread=0);
Pierre Kraemer's avatar
Pierre Kraemer committed
217 218 219 220 221 222 223 224
	//@}
};

} // namespace CGoGN

#include "Topology/gmap/gmap1.hpp"

#endif