gmap3.h 11.2 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;

Pierre Kraemer's avatar
Pierre Kraemer committed
46
	inline static unsigned int ORBIT_IN_PARENT(unsigned int o) { return o+7; }
47 48
	inline static unsigned int ORBIT_IN_PARENT2(unsigned int o) { return o+5; }

Pierre Kraemer's avatar
Pierre Kraemer committed
49 50 51
	static const unsigned int IN_PARENT = 7 ;
	static const unsigned int IN_PARENT2 = 5 ;

52 53 54 55 56 57 58
	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;

59 60 61
	static const unsigned int DIMENSION = 3 ;
//	enum {	DIMENSION = 3 } ;

Pierre Kraemer's avatar
Pierre Kraemer committed
62 63
	GMap3();

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

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

68 69
	virtual void clear(bool removeAttrib);

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

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

Pierre Kraemer's avatar
Pierre Kraemer committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
	/*! @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
98
protected:
Pierre Kraemer's avatar
Pierre Kraemer committed
99 100 101 102
	void beta3sew(Dart d, Dart e);

	void beta3unsew(Dart d);

Pierre Kraemer's avatar
Pierre Kraemer committed
103
public:
104
	/*! @name Generator and Deletor
Pierre Kraemer's avatar
Pierre Kraemer committed
105
	 *  To generate or delete volumes in a 3-G-map
106
	 *************************************************************************/
Pierre Kraemer's avatar
Pierre Kraemer committed
107 108

	//@{
109 110 111
	//! 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
112
	 */
113
	void deleteVolume(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
114 115 116 117 118 119

	//! 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
120 121 122
	//@}

	/*! @name Topological Operators
Pierre Kraemer's avatar
Pierre Kraemer committed
123
	 *  Topological operations on 3-G-maps
Pierre Kraemer's avatar
Pierre Kraemer committed
124 125 126
	 *************************************************************************/

	//@{
Pierre Kraemer's avatar
Pierre Kraemer committed
127
	//! Delete the vertex of d
128
	/*! All the volumes around the vertex are merged into one volume
Pierre Kraemer's avatar
Pierre Kraemer committed
129
	 *  @param d a dart of the vertex to delete
130
	 *  @return a Dart of the resulting volume
Pierre Kraemer's avatar
Pierre Kraemer committed
131 132 133 134
	 */
	virtual Dart deleteVertex(Dart d);

	//! Cut the edge of d (all darts around edge orbit are cut)
135
	/*! @param d a dart of the edge to cut
136
	 *  @return a dart of the new vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
137
	 */
138
	virtual Dart cutEdge(Dart d);
139

Pierre Kraemer's avatar
Pierre Kraemer committed
140 141 142 143 144
	//! 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);

145 146 147 148 149
	/**
	 * Precondition for deleting edge
	 */
	bool deleteEdgePreCond(Dart d);

150 151 152 153 154 155 156
	//! 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);

157 158 159 160 161
	/**
	 * Precondition for splitting face
	 */
	bool splitFacePreCond(Dart d, Dart e);

162 163 164 165 166 167
	//! 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
168

169
	//! Sew two oriented volumes along their faces.
Pierre Kraemer's avatar
Pierre Kraemer committed
170
	/*! The oriented faces should not be beta3-linked and have the same degree
171 172
	 *  @param d a dart of the first volume
	 *  @param e a dart of the second volume
Pierre Kraemer's avatar
Pierre Kraemer committed
173
	 *  @param withBoundary: if false, volumes must have beta3 fixed points (only for construction: import/primitives)
Thomas's avatar
Thomas committed
174
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
175
	virtual void sewVolumes(Dart d, Dart e, bool withBoundary = true);
Thomas's avatar
Thomas committed
176

177 178
	//! unsew two oriented volumes along their faces.
	/*! @param d a dart of one volume
Thomas's avatar
Thomas committed
179
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
180
	virtual void unsewVolumes(Dart d);
Thomas's avatar
Thomas committed
181

182 183
	//! merge to volume sewed by one face
	/*! @param d a dart of common face
Thomas's avatar
Thomas committed
184
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
185
	virtual bool mergeVolumes(Dart d);
186

187 188 189
	virtual bool mergeVolumes(Dart d, Dart e) { assert("use mergeVolumes(d,e) only in dimension 2");return false;}


Pierre Kraemer's avatar
Pierre Kraemer committed
190 191 192 193 194
	//! 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
195

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
	/*! @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) ;

213 214 215 216 217 218 219 220
	//! 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
221
	virtual bool isBoundaryVertex(Dart d) ;
222

223 224 225 226 227 228 229 230 231 232 233 234
	//! 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) ;

235 236 237
	//! Compute the number of volumes around the edge of d
	/*! @param d a dart
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
238 239 240 241 242 243 244 245 246 247 248 249
	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) ;
250

251 252 253 254
	//!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
255
	bool sameOrientedFace(Dart d, Dart e) ;
256 257 258 259 260

	//!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
261
	bool sameFace(Dart d, Dart e) ;
262

Pierre Kraemer's avatar
Pierre Kraemer committed
263 264 265 266
	//! Test if the face is on the boundary
	/*! @param d a dart from the face
	 */
	bool isBoundaryFace(Dart d) ;
Thomas's avatar
Thomas committed
267

Pierre Kraemer's avatar
Pierre Kraemer committed
268 269 270 271 272 273 274
	//! Tell if a face of the volume is on the boundary
	/*  @param d a dart
	 */
	bool isBoundaryVolume(Dart d) ;

	virtual bool check() ;
	//@}
275

Pierre Kraemer's avatar
Pierre Kraemer committed
276 277 278 279 280 281
	/*! @name Cell Functors
	 *  Apply functors to all darts of a cell
	 *************************************************************************/

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

	/**
	* Apply a functor on each dart of a vertex
290
	* @param d a dart of the vertex
Pierre Kraemer's avatar
Pierre Kraemer committed
291 292
	* @param fonct functor obj ref
	*/
Pierre Kraemer's avatar
Pierre Kraemer committed
293
	bool foreach_dart_of_vertex(Dart d, FunctorType& fonct, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
294

295 296 297 298 299 300 301
	/**
	* Apply a functor on each dart of an oriented edge
	* @param d a dart of the oriented edge
	* @param fonct functor obj ref
	*/
	bool foreach_dart_of_oriented_edge(Dart d, FunctorType& fonct, unsigned int thread = 0);

Pierre Kraemer's avatar
Pierre Kraemer committed
302 303
	/**
	* Apply a functor on each dart of an edge
304
	* @param d a dart of the edge
Pierre Kraemer's avatar
Pierre Kraemer committed
305 306
	* @param fonct functor obj ref
	*/
Pierre Kraemer's avatar
Pierre Kraemer committed
307
	bool foreach_dart_of_edge(Dart d, FunctorType& fonct, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
308 309

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

315 316 317 318
	//! Apply a functor on every dart of an oriented volume
	/*! @param d a dart of the oriented volume
	 *  @param f the functor to apply
	 */
319 320
	bool foreach_dart_of_oriented_volume(Dart d, FunctorType& fonct, unsigned int thread = 0);

321 322 323 324 325
	//! Apply a functor on every dart of a volume
	/*! @param d a dart of the volume
	 *  @param f the functor to apply
	 */
	bool foreach_dart_of_volume(Dart d, FunctorType& fonct, unsigned int thread = 0);
326

Pierre Kraemer's avatar
Pierre Kraemer committed
327 328 329 330 331
	/**
	* 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
332
	bool foreach_dart_of_cc(Dart d, FunctorType& fonct, unsigned int thread = 0);
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354



	/**
	* 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
355
	//@}
Pierre Kraemer's avatar
Pierre Kraemer committed
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373

	/*! @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.
374
	 *  @return the number of closed holes
Pierre Kraemer's avatar
Pierre Kraemer committed
375
	 */
376
	unsigned int closeMap();
Pierre Kraemer's avatar
Pierre Kraemer committed
377 378 379 380 381 382 383
};

} // namespace CGoGN

#include "Topology/gmap/gmap3.hpp"

#endif