map3.h 10.1 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-2011, 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.u-strasbg.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 39 40 41 42 43 44 45 46 47 48 49 50 51 52
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __MAP3_H__
#define __MAP3_H__

#include "Topology/map/map2.h"

namespace CGoGN
{

/*! \brief The class of dual 3-dimensional combinatorial maps:
 *  set of oriented volumes pairwise sewed by an adjacency relation.
 *  A dual 3-map represents close or open oriented 3-manifolds (volume subdivisions).
 *  - A dual 3-map is made of darts linked by the phi1 permutation
 * 	and/or the phi2 and phi3 one-to-one relation.
 *  - In this class darts are interpreted as oriented edges.
 *  - The phi1 relation defines oriented faces (see tMap1)
 *  and faces may have arbitrary size (degenerated faces are accepted).
 *  - The phi2 relation links oriented faces along oriented edges building
 *  oriented surfaces. A close oriented surface define an oriented volume.
 *  - Volume are linked along whole faces with the phi3 relation 
 *  - Faces that have no phi3-link are border faces. If there exists
 *  such edges the maps is open.
 *  - When every face is phi3-linked, the map is close. In this case
 *  some optimizations are enable that speed up the processing of cells.
 *  @param DART the type of dart used in the class
 */
class Map3 : public Map2
{
protected:
53
	AttributeMultiVector<Dart>* m_phi3 ;
Pierre Kraemer's avatar
Pierre Kraemer committed
54

55 56
	void init() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
57 58 59 60 61 62 63 64 65
public:
	typedef Map2 ParentMap;

	Map3();

	virtual std::string mapTypeName();

	virtual unsigned int dimension();

66 67
	virtual void clear(bool removeAttrib);

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
	/*! @name Basic Topological Operators
	 * Access and Modification
	 *************************************************************************/

	virtual Dart newDart();

	Dart phi3(Dart d);

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

	Dart alpha0(Dart d);

	Dart alpha1(Dart d);

	Dart alpha2(Dart d);

	Dart alpha_2(Dart d);

protected:
	//! Link dart d with dart e by an involution
89
	/*! @param d,e the darts to link
Pierre Kraemer's avatar
Pierre Kraemer committed
90 91 92 93 94 95
	 *	- Before:	d->d and e->e
	 *	- After:	d->e and e->d
	 */
	void phi3sew(Dart d, Dart e);

	//! Unlink the current dart by an involution
96
	/*! @param d the dart to unlink
Pierre Kraemer's avatar
Pierre Kraemer committed
97 98 99 100 101
	 * - Before:	d->e and e->d
	 * - After:		d->d and e->e
	 */
	void phi3unsew(Dart d);

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

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

	//! 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
119 120 121 122 123 124 125
	//@}

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

	//@{
126 127 128 129
	//! Delete the vertex of d
	/*! All the faces around the vertex are merged into one face
	 *  @param d a dart of the vertex to delete
	 *  @return true if the deletion has been executed, false otherwise
Pierre Kraemer's avatar
Pierre Kraemer committed
130
	 */
131
	virtual Dart deleteVertex(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
132

133 134
	//! Cut the edge of d (all darts around edge orbit are cutted)
	/*! @param d a dart of the edge to cut
Pierre Kraemer's avatar
Pierre Kraemer committed
135
	 */
136
	virtual void cutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
137

138 139
	//! Uncut the edge of d (all darts around edge orbit are uncutted)
	/*! @param d a dart of the edge to uncut
Pierre Kraemer's avatar
Pierre Kraemer committed
140
	 */
141
	virtual bool uncutEdge(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
142

untereiner's avatar
untereiner committed
143 144 145 146 147 148 149 150 151 152 153 154 155
	//! Delete an edge and all the faces aroud this edge
	/*! @param d a dart of the edge to delete
	 */
	virtual Dart deleteEdge(Dart d);

	//! Collapse an edge (that is deleted) possibly merging its vertices
	/*! \warning This may produce two distinct vertices if the edge
	 *  was the only link between two border faces
	 *  @param d a dart in the deleted edge
	 *  @return a dart of the resulting vertex
	 */
	virtual Dart collapseEdge(Dart d, bool delDegenerateVolumes = true);

Pierre Kraemer's avatar
Pierre Kraemer committed
156 157 158 159 160 161 162 163
	//! 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
	 *  @return the dart of the new edge lying in the vertex of d after the cut
	 */
	virtual void splitFace(Dart d, Dart e);

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

172 173
	//! Unsew two oriented volumes along their faces.
	/*! @param d a dart of one volume
Pierre Kraemer's avatar
Pierre Kraemer committed
174
	 */
175
	virtual void unsewVolumes(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
176

177 178
	//! Merge to volume along their common oriented face
	/*! @param d a dart of common face
Pierre Kraemer's avatar
Pierre Kraemer committed
179
	 */
180
	virtual bool mergeVolumes(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
181

untereiner's avatar
untereiner committed
182 183 184 185
	//! Split a volume into two volumes along a edge path
	/*! @param vd a vector of darts
	 */
	virtual void splitVolume(std::vector<Dart>& vd);
186
	//@}
Pierre Kraemer's avatar
Pierre Kraemer committed
187

188 189 190 191 192 193 194 195 196 197 198
	/*! @name Topological Queries
	 *  Return or set various topological information
	 *************************************************************************/

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

199 200 201 202 203 204 205 206 207 208
	//! 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
	 */
	bool isBoundaryVertex(Dart d);

209 210 211 212 213 214 215 216 217 218 219 220
	//! 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) ;

221 222
	//! Compute the number of volumes around the edge of d
	/*! @param d a dart
Pierre Kraemer's avatar
Pierre Kraemer committed
223
	 */
untereiner's avatar
untereiner committed
224
	unsigned int edgeDegree(Dart d);
Pierre Kraemer's avatar
Pierre Kraemer committed
225

untereiner's avatar
bla  
untereiner committed
226 227 228 229 230
	/**
	 * tell if the edge of d is on the boundary of the map
	 */
	bool isBoundaryEdge(Dart d) ;

untereiner's avatar
untereiner committed
231 232 233 234 235 236
	/**
	 * find the dart of edge that belong to the boundary
	 * return NIL if the edge is not on the boundary
	 */
	Dart findBoundaryFaceOfEdge(Dart d);

237 238 239
	//! Test if dart d and e belong to the same oriented face
	/*! @param d a dart
	 *  @param e a dart
untereiner's avatar
untereiner committed
240
	 */
241
	bool sameFace(Dart d, Dart e);
untereiner's avatar
untereiner committed
242

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

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

untereiner's avatar
untereiner committed
253 254 255
	//! Check the map completeness
	/*! Test if phi3 and phi2 ares involutions and if phi1 is a permutation
	 */
256
	virtual bool check();
Pierre Kraemer's avatar
Pierre Kraemer committed
257 258 259 260 261 262 263
	//@}

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

	//@{
264 265 266 267
	//! Apply a functor on each dart of a vertex
	/*! @param d a dart of the vertex
	 *  @param fonct the functor
	 */
untereiner's avatar
bla  
untereiner committed
268
	bool foreach_dart_of_vertex(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
269

270 271 272 273
	//! Apply a functor on each dart of an edge
	/*! @param d a dart of the oriented edge
	 *  @param fonct the functor
	 */
untereiner's avatar
bla  
untereiner committed
274
	bool foreach_dart_of_edge(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
275

276 277 278 279
	//! Apply a functor on each dart of an oriented face
	/*! @param d a dart of the oriented face
	 *  @param fonct the functor
	 */
untereiner's avatar
bla  
untereiner committed
280
	bool foreach_dart_of_face(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
281

282 283 284 285
	//! Apply a functor on each dart of a cc
	/*! @param d a dart of the cc
	 *  @param fonct the functor
	 */
untereiner's avatar
bla  
untereiner committed
286
	bool foreach_dart_of_cc(Dart d, FunctorType& f, unsigned int thread = 0);
Pierre Kraemer's avatar
Pierre Kraemer committed
287 288
	//@}

untereiner's avatar
untereiner committed
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
	/*! @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.
	 */
	void closeMap();
	//@}
Pierre Kraemer's avatar
Pierre Kraemer committed
309 310 311 312 313 314 315
};

} // namespace CGoGN

#include "Topology/map/map3.hpp"

#endif