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

#ifndef __ATTRIB_MAP__
#define __ATTRIB_MAP__

#include "Topology/generic/genericmap.h"
#include "Topology/generic/attributeHandler.h"

namespace CGoGN
{

class AttribMap : public GenericMap
{
36
private:
37
	friend class CellMarkerGen ;
38

Pierre Kraemer's avatar
Pierre Kraemer committed
39
40
	template<typename T> friend class AutoAttributeHandler ;

41
42
	void init() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
43
public:
44
	static const unsigned int UNKNOWN_ATTRIB = AttributeContainer::UNKNOWN ;
Pierre Kraemer's avatar
Pierre Kraemer committed
45

46
47
48
	AttribMap() ;

	virtual void clear(bool removeAttrib) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
49
50
51
52
53
54
55
56
57

	/****************************************
	 *        ATTRIBUTES MANAGEMENT         *
	 ****************************************/

	/**
	* Create an attribute for a given orbit
	* @param orbit
	* @param nameAttr attribute name
58
	* @return an AttributeHandler
Pierre Kraemer's avatar
Pierre Kraemer committed
59
60
	*/
	template <typename T>
61
	AttributeHandler<T> addAttribute(unsigned int orbit, const std::string& nameAttr) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
62
63
64
65
66
67
68

	/**
	 * remove an attribute
	 * @param attr a handler to the attribute to remove
	 * @return true if remove succeed else false
	 */
	template <typename T>
69
	bool removeAttribute(AttributeHandler<T>& attr) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
70
71
72
73
74

	/**
	* search an attribute for a given orbit
	* @param orbit
	* @param nameAttr attribute name
75
	* @return an AttributeHandler
Pierre Kraemer's avatar
Pierre Kraemer committed
76
77
	*/
	template <typename T>
78
	AttributeHandler<T> getAttribute(unsigned int orbit, const std::string& nameAttr) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

	/**
	 * swap the content of two attributes (efficient, only swap pointers)
	 */
	template <typename T>
	bool swapAttributes(AttributeHandler<T>& attr1, AttributeHandler<T>& attr2) ;

	/**
	 * copy the content of src attribute to dst attribute
	 */
	template <typename T>
	bool copyAttribute(AttributeHandler<T>& dst, AttributeHandler<T>& src) ;

	/**
	 * get the number of cell in the attribute container of an orbit
	 * @param orb the orbit to get number of cells
	 */
	unsigned int getNbCells(unsigned int orbit);

protected:
	/****************************************
	 *   EMBEDDING ATTRIBUTES MANAGEMENT    *
	 ****************************************/
	/**
	 * Create the dart attribute to store the embedding of this orbit (for internal use only)
	 * Also adds a Marker attribute to the container
	 */
106
	void addEmbedding(unsigned int orbit) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
107
108
109
110
111
112
113
114
115

	/****************************************
	 *  TOPOLOGICAL ATTRIBUTES MANAGEMENT   *
	 ****************************************/

	/**
	 * Add a toological relation in the map
	 * @param name name of relation
	 */
116
	AttributeMultiVector<Dart>* addRelation(const std::string& name) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

public:
	/****************************************
	 *               UTILITIES              *
	 ****************************************/

	/**
	 * use the given attribute to store the indices of the cells of the corresponding orbit
	 * @return the number of cells of the orbit
	 */
	unsigned int computeIndexCells(AttributeHandler<unsigned int>& idx) ;
} ;

} // namespace CGoGN

#include "Topology/generic/attribmap.hpp"

#endif