attribmap.h 4.56 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
* 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 37 38
private:
	void init() ;

Pierre Kraemer's avatar
Pierre Kraemer committed
39
public:
40
	static const unsigned int UNKNOWN_ATTRIB = AttributeContainer::UNKNOWN ;
Pierre Kraemer's avatar
Pierre Kraemer committed
41

42 43 44
	AttribMap() ;

	virtual void clear(bool removeAttrib) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
45 46 47 48 49 50 51 52

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

	/**
	* Create an attribute for a given orbit
	* @param nameAttr attribute name
53
	* @return an AttributeHandler
Pierre Kraemer's avatar
Pierre Kraemer committed
54
	*/
55 56
	template <typename T, unsigned int ORBIT>
	AttributeHandler<T, ORBIT> addAttribute(const std::string& nameAttr) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
57 58 59 60 61 62

	/**
	 * remove an attribute
	 * @param attr a handler to the attribute to remove
	 * @return true if remove succeed else false
	 */
63 64
	template <typename T, unsigned int ORBIT>
	bool removeAttribute(AttributeHandler<T, ORBIT>& attr) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
65 66 67 68

	/**
	* search an attribute for a given orbit
	* @param nameAttr attribute name
69
	* @return an AttributeHandler
Pierre Kraemer's avatar
Pierre Kraemer committed
70
	*/
71 72
	template <typename T, unsigned int ORBIT>
	AttributeHandler<T, ORBIT> getAttribute(const std::string& nameAttr) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
73

74 75 76 77 78 79 80 81
	/**
	 * @brief get a generic pointer to an existing attribute multi vector
	 * @param orbit the concerned orbit
	 * @param nameAttr attribute name
	 * @return a pointer to an AttributeMultiVectorGen
	 */
	AttributeMultiVectorGen* getAttributeVectorGen(unsigned int orbit, const std::string& nameAttr) ;

82 83 84 85 86 87 88 89
	/**
	* check if an attribute exist ( get, test if valid and add if necessary)
	* @param nameAttr attribute name
	* @return an AttributeHandler
	*/
	template <typename T, unsigned int ORBIT>
	AttributeHandler<T, ORBIT> checkAttribute(const std::string& nameAttr) ;

Pierre Kraemer's avatar
Pierre Kraemer committed
90 91 92
	/**
	 * swap the content of two attributes (efficient, only swap pointers)
	 */
93 94
	template <typename T, unsigned int ORBIT>
	bool swapAttributes(AttributeHandler<T, ORBIT>& attr1, AttributeHandler<T, ORBIT>& attr2) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
95 96 97 98

	/**
	 * copy the content of src attribute to dst attribute
	 */
99 100
	template <typename T, unsigned int ORBIT>
	bool copyAttribute(AttributeHandler<T, ORBIT>& dst, AttributeHandler<T, ORBIT>& src) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
101 102 103 104 105 106 107 108 109 110


	/****************************************
	 *               UTILITIES              *
	 ****************************************/

	/**
	 * use the given attribute to store the indices of the cells of the corresponding orbit
	 * @return the number of cells of the orbit
	 */
111 112
	template <unsigned int ORBIT>
	unsigned int computeIndexCells(AttributeHandler<unsigned int, ORBIT>& idx) ;
113 114 115 116

	/**
	 * ensure that each orbit as one embedding and that each embedding is handle by only one orbit
	 */
117 118
	template <unsigned int ORBIT>
	void bijectiveOrbitEmbedding();
119

Pierre Kraemer's avatar
Pierre Kraemer committed
120 121 122 123 124 125 126
} ;

} // namespace CGoGN

#include "Topology/generic/attribmap.hpp"

#endif