attribmap.h 4.11 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:
Pierre Kraemer's avatar
Pierre Kraemer committed
37 38
	template<typename T> friend class AutoAttributeHandler ;

39 40
	void init() ;

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

44 45 46
	AttribMap() ;

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

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

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

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

	/**
	* search an attribute for a given orbit
	* @param orbit
	* @param nameAttr attribute name
73
	* @return an AttributeHandler
Pierre Kraemer's avatar
Pierre Kraemer committed
74 75
	*/
	template <typename T>
76
	AttributeHandler<T> getAttribute(unsigned int orbit, const std::string& nameAttr) ;
Pierre Kraemer's avatar
Pierre Kraemer committed
77 78 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 106

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


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) ;
107 108 109 110 111 112

	/**
	 * ensure that each orbit as one embedding and that each embedding is handle by only one orbit
	 */
	void bijectiveOrbitEmbedding(unsigned int orbit);

Pierre Kraemer's avatar
Pierre Kraemer committed
113 114 115 116 117 118 119
} ;

} // namespace CGoGN

#include "Topology/generic/attribmap.hpp"

#endif