gmap3.h 10.3 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 __GMAP3_H__
#define __GMAP3_H__

#include "Topology/gmap/gmap2.h"

namespace CGoGN
{

/**
Pierre Kraemer's avatar
Pierre Kraemer committed
34
* The class of 3-GMap
Pierre Kraemer's avatar
Pierre Kraemer committed
35 36 37 38
*/
class GMap3 : public GMap2
{
protected:
39
	AttributeMultiVector<Dart>* m_beta3 ;
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 GMap2 ParentMap;

46 47 48 49 50 51 52 53 54 55
	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
56 57
	GMap3();

58
	virtual std::string mapTypeName() const;
Pierre Kraemer's avatar
Pierre Kraemer committed
59 60 61

	virtual unsigned int dimension();

62 63
	virtual void clear(bool removeAttrib);

Sylvain Thery's avatar
Sylvain Thery committed
64 65
	virtual void update_topo_shortcuts();

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

Pierre Kraemer's avatar
Pierre Kraemer committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
	/*! @name Basic Topological Operators
	 * Access and Modification
	 *************************************************************************/

	virtual Dart newDart();

	Dart beta3(Dart d);

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

	Dart phi3(Dart d);

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

	Dart alpha0(Dart d);

	Dart alpha1(Dart d);

	Dart alpha2(Dart d);

	Dart alpha_2(Dart d);

Pierre Kraemer's avatar
Pierre Kraemer committed
92
protected:
Pierre Kraemer's avatar
Pierre Kraemer committed
93 94 95 96
	void beta3sew(Dart d, Dart e);

	void beta3unsew(Dart d);

Pierre Kraemer's avatar
Pierre Kraemer committed
97
public:
98
	/*! @name Generator and Deletor
Pierre Kraemer's avatar
Pierre Kraemer committed
99
	 *  To generate or delete volumes in a 3-G-map
100
	 *************************************************************************/
Pierre Kraemer's avatar
Pierre Kraemer committed
101 102

	//@{
103 104 105
	//! 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
106
	 */
107
	void deleteVolume(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
108 109 110 111 112 113

	//! 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
114 115 116
	//@}

	/*! @name Topological Operators
Pierre Kraemer's avatar
Pierre Kraemer committed
117
	 *  Topological operations on 3-G-maps
Pierre Kraemer's avatar
Pierre Kraemer committed
118 119 120
	 *************************************************************************/

	//@{
Pierre Kraemer's avatar
Pierre Kraemer committed
121
	//! Delete the vertex of d
122
	/*! All the volumes around the vertex are merged into one volume
Pierre Kraemer's avatar
Pierre Kraemer committed
123
	 *  @param d a dart of the vertex to delete
124
	 *  @return a Dart of the resulting volume
Pierre Kraemer's avatar
Pierre Kraemer committed
125 126 127 128
	 */
	virtual Dart deleteVertex(Dart d);

	//! Cut the edge of d (all darts around edge orbit are cut)
129
	/*! @param d a dart of the edge to cut
130
	 *  @return a dart of the new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
131
	 */
132
	virtual Dart cutEdge(Dart d);
133

Pierre Kraemer's avatar
Pierre Kraemer committed
134 135 136 137 138
	//! Uncut the edge of d (all darts around edge orbit are uncut)
	/*! @param d a dart of the edge to uncut
	 */
	virtual bool uncutEdge(Dart d);

139 140 141 142 143 144 145
	//! 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
	 */
	virtual Dart deleteEdge(Dart d);

146 147 148 149 150 151
	//! 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);
Pierre Kraemer's avatar
Pierre Kraemer committed
152

153
	//! Sew two oriented volumes along their faces.
Pierre Kraemer's avatar
Pierre Kraemer committed
154
	/*! The oriented faces should not be beta3-linked and have the same degree
155 156
	 *  @param d a dart of the first volume
	 *  @param e a dart of the second volume
Pierre Kraemer's avatar
Pierre Kraemer committed
157
	 *  @param withBoundary: if false, volumes must have beta3 fixed points (only for construction: import/primitives)
Thomas's avatar
Thomas committed
158
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
159
	virtual void sewVolumes(Dart d, Dart e, bool withBoundary = true);
Thomas's avatar
Thomas committed
160

161 162
	//! unsew two oriented volumes along their faces.
	/*! @param d a dart of one volume
Thomas's avatar
Thomas committed
163
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
164
	virtual void unsewVolumes(Dart d);
Thomas's avatar
Thomas committed
165

166 167
	//! merge to volume sewed by one face
	/*! @param d a dart of common face
Thomas's avatar
Thomas committed
168
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
169
	virtual bool mergeVolumes(Dart d);
170

Pierre Kraemer's avatar
Pierre Kraemer committed
171 172 173 174 175
	//! Split a volume into two volumes along a edge path
	/*! @param vd a vector of darts
	 */
	virtual void splitVolume(std::vector<Dart>& vd);
	//@}
Thomas's avatar
Thomas committed
176

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
	/*! @name Topological Queries
	 *  Return or set various topological information
	 *************************************************************************/

	//@{
	//! Test if dart d and e belong to the same oriented vertex
	/*! @param d a dart
	 *  @param e a dart
	 */
	bool sameOrientedVertex(Dart d, Dart e) ;

	//! 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) ;

194 195 196 197 198 199 200 201
	//! Compute the number of edges of the vertex of d
	/*! @param d a dart
	 */
	unsigned int vertexDegree(Dart d) ;

	//! Tell if the vertex of d is on the boundary
	/*! @param d a dart
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
202
	virtual bool isBoundaryVertex(Dart d) ;
203

204 205 206 207 208 209 210 211 212 213 214 215
	//! 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) ;

216 217 218
	//! Compute the number of volumes around the edge of d
	/*! @param d a dart
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
219 220 221 222 223 224 225 226 227 228 229 230
	unsigned int edgeDegree(Dart d) ;

	/**
	 * tell if the edge of d is on the boundary of the map
	 */
	bool isBoundaryEdge(Dart d) ;

	/**
	 * find the dart of edge that belong to the boundary
	 * return NIL if the edge is not on the boundary
	 */
	Dart findBoundaryFaceOfEdge(Dart d) ;
231

232 233 234 235
	//!Test if dart d and e belong to the same oriented face
	/*! @param d a dart
	 *  @param e a dart
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
236
	bool sameOrientedFace(Dart d, Dart e) ;
237 238 239 240 241

	//!Test if dart d and e belong to the same oriented face
	/*! @param d a dart
	 *  @param e a dart
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
242
	bool sameFace(Dart d, Dart e) ;
243

Pierre Kraemer's avatar
Pierre Kraemer committed
244 245 246 247
	//! Test if the face is on the boundary
	/*! @param d a dart from the face
	 */
	bool isBoundaryFace(Dart d) ;
Thomas's avatar
Thomas committed
248

Pierre Kraemer's avatar
Pierre Kraemer committed
249 250 251 252 253 254 255
	//! Tell if a face of the volume is on the boundary
	/*  @param d a dart
	 */
	bool isBoundaryVolume(Dart d) ;

	virtual bool check() ;
	//@}
256

Pierre Kraemer's avatar
Pierre Kraemer committed
257 258 259 260 261 262
	/*! @name Cell Functors
	 *  Apply functors to all darts of a cell
	 *************************************************************************/

	//@{
	/**
263 264 265 266
	* Apply a functor on each dart of a vertex
	* @param d a dart of the face
	* @param fonct functor obj ref
	*/
Pierre Kraemer's avatar
Pierre Kraemer committed
267
	bool foreach_dart_of_oriented_vertex(Dart d, FunctorType& fonct, unsigned int thread = 0);
268 269 270

	/**
	* Apply a functor on each dart of a vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
271 272 273
	* @param d a dart of the face
	* @param fonct functor obj ref
	*/
Pierre Kraemer's avatar
Pierre Kraemer committed
274
	bool foreach_dart_of_vertex(Dart d, FunctorType& fonct, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
275 276 277 278 279 280

	/**
	* Apply a functor on each dart of an edge
	* @param d a dart of the oriented face
	* @param fonct functor obj ref
	*/
Pierre Kraemer's avatar
Pierre Kraemer committed
281
	bool foreach_dart_of_edge(Dart d, FunctorType& fonct, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
282 283 284 285 286

	//! Apply a functor on every dart of a face
	/*! @param d a dart of the volume
	 *  @param f the functor to apply
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
287
	bool foreach_dart_of_face(Dart d, FunctorType& fonct, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
288

289 290 291 292 293
	bool foreach_dart_of_volume(Dart d, FunctorType& fonct, unsigned int thread = 0);

	bool foreach_dart_of_oriented_volume(Dart d, FunctorType& fonct, unsigned int thread = 0);


Pierre Kraemer's avatar
Pierre Kraemer committed
294 295 296 297 298
	/**
	* Apply a functor on each dart of a cc
	* @param d a dart of the cc
	* @param fonct functor obj ref
	*/
Pierre Kraemer's avatar
Pierre Kraemer committed
299
	bool foreach_dart_of_cc(Dart d, FunctorType& fonct, unsigned int thread = 0);
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321



	/**
	* Apply a functor on each dart of a vertex
	* @param d a dart of the face
	* @param fonct functor obj ref
	*/
	bool foreach_dart_of_vertex2(Dart d, FunctorType& fonct, unsigned int thread = 0);

	/**
	* Apply a functor on each dart of an edge
	* @param d a dart of the oriented face
	* @param fonct functor obj ref
	*/
	bool foreach_dart_of_edge2(Dart d, FunctorType& fonct, unsigned int thread = 0);

	//! Apply a functor on every dart of a face
	/*! @param d a dart of the volume
	 *  @param f the functor to apply
	 */
	bool foreach_dart_of_face2(Dart d, FunctorType& fonct, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
322
	//@}
Pierre Kraemer's avatar
Pierre Kraemer committed
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340

	/*! @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.
341
	 *  @return the number of closed holes
Pierre Kraemer's avatar
Pierre Kraemer committed
342
	 */
343
	unsigned int closeMap();
Pierre Kraemer's avatar
Pierre Kraemer committed
344 345 346 347 348 349 350
};

} // namespace CGoGN

#include "Topology/gmap/gmap3.hpp"

#endif