gmap1.h 6.53 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;

46 47 48 49
	static const unsigned int DIMENSION = 1 ;



Pierre Kraemer's avatar
Pierre Kraemer committed
50 51
	GMap1();

52
	virtual std::string mapTypeName() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
53

54
	virtual unsigned int dimension() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
55

56 57
	virtual void clear(bool removeAttrib);

Sylvain Thery's avatar
Sylvain Thery committed
58 59
	virtual void update_topo_shortcuts();

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

Pierre Kraemer's avatar
Pierre Kraemer committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
	/*! @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);

84
protected:
Pierre Kraemer's avatar
Pierre Kraemer committed
85 86 87 88
	void beta1sew(Dart d, Dart e);

	void beta1unsew(Dart d);

89
public:
Pierre Kraemer's avatar
Pierre Kraemer committed
90 91 92 93 94 95
	/*! @name Constructors and Destructors
	 *  To generate or delete cells in a 1-G-map
	 *************************************************************************/

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

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

	//! Delete a 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 119 120
	//@}

	/*! @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
121
	 *  @return a dart of the new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
122 123
	 * \image hmtl map1_cutEdge.png
	 */
124
	Dart cutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
125

Pierre Kraemer's avatar
Pierre Kraemer committed
126 127 128 129 130
	//! 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
131 132 133 134 135 136 137 138 139 140 141
	//! 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
	 */
142
	void splitCycle(Dart d, Dart e);
Pierre Kraemer's avatar
Pierre Kraemer committed
143 144 145 146 147 148 149

	//! 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
	 */
150
	void mergeCycles(Dart d, Dart e);
151 152 153 154 155 156

	//! 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
	 */
157
	void linkCycles(Dart d, Dart e);
Pierre Kraemer's avatar
Pierre Kraemer committed
158 159 160 161 162 163 164 165 166 167 168
	//@}

	/*! @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
	 */
169
	bool sameOrientedCycle(Dart d, Dart e) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
170 171 172 173 174

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

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

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

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

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

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

	/**
210 211
	* 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
212 213
	* @param fonct functor obj ref
	*/
214
	bool foreach_dart_of_oriented_cc(Dart d, FunctorType& f, unsigned int thread=0);
Pierre Kraemer's avatar
Pierre Kraemer committed
215

216 217
	//! Apply a functor on every dart of a cc (face)
	/*! @param d a dart of the cc
Pierre Kraemer's avatar
Pierre Kraemer committed
218 219
	 *  @param f the functor to apply
	 */
Sylvain Thery's avatar
Sylvain Thery committed
220
	bool foreach_dart_of_cc(Dart d, FunctorType& fonct, unsigned int thread=0);
Pierre Kraemer's avatar
Pierre Kraemer committed
221 222 223 224 225 226 227 228
	//@}
};

} // namespace CGoGN

#include "Topology/gmap/gmap1.hpp"

#endif