collector.h

/*******************************************************************************
* CGoGN: Combinatorial and Geometric modeling with Generic N-dimensional Maps  *
* version 0.1                                                                  *
* Copyright (C) 2009, IGG Team, LSIIT, University of Strasbourg                *
*                                                                              *
* 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.           *
*                                                                              *
* Web site: http://cgogn.unistra.fr/                                  *
* Contact information: cgogn@unistra.fr                                        *
*                                                                              *
*******************************************************************************/

#ifndef __COLLECTOR_H__
#define __COLLECTOR_H__

#include "Container/fakeAttribute.h"
#include "Geometry/basic.h"

/*****************************************
 * Class hierarchy :
 * Collector (virtual)
 * - Collector_WithinSphere
 * - Collector_OneRing
 ****************************************/

namespace CGoGN
{

namespace Algo
{

namespace Selection
{

/*********************************************************
 * Generic Collector
 *********************************************************/

template <typename PFP>
class Collector
{
protected:
	typedef typename PFP::VEC3 VEC3;
	typedef typename PFP::REAL REAL;

	typename PFP::MAP& map;
	unsigned int m_thread;

	Dart centerDart;

	std::vector<Dart> insideVertices;
	std::vector<Dart> insideEdges;
	std::vector<Dart> insideFaces;
	std::vector<Dart> border;

public:
	Collector(typename PFP::MAP& m, unsigned int thread =0);

	inline void init(Dart d)
	{
		centerDart = d;
		insideVertices.clear();
		insideEdges.clear();
		insideFaces.clear();
		border.clear();
	}

	virtual void collectAll(Dart d) = 0;
	virtual void collectBorder(Dart d) = 0;

	bool applyOnInsideVertices(FunctorType& f);
	bool applyOnInsideEdges(FunctorType& f);
	bool applyOnInsideFaces(FunctorType& f);
	bool applyOnBorder(FunctorType& f);

	inline void sort()
	{
		std::sort(insideVertices.begin(), insideVertices.end());
		std::sort(insideEdges.begin(), insideEdges.end());
		std::sort(insideFaces.begin(), insideFaces.end());
		std::sort(border.begin(), border.end());
	}

	inline typename PFP::MAP& getMap() { return map; }

	inline Dart getCenterDart() const { return centerDart; }

	inline const std::vector<Dart>& getInsideVertices() const { return insideVertices; }
	inline const std::vector<Dart>& getInsideEdges() const { return insideEdges; }
	inline const std::vector<Dart>& getInsideFaces() const { return insideFaces; }
	inline const std::vector<Dart>& getBorder() const { return border; }

	inline unsigned int getNbInsideVertices() const { return insideVertices.size(); }
	inline unsigned int getNbInsideEdges() const { return insideEdges.size(); }
	inline unsigned int getNbInsideFaces() const { return insideFaces.size(); }
	inline unsigned int getNbBorder() const { return border.size(); }

	template <typename PPFP>
	friend std::ostream& operator<<(std::ostream &out, const Collector<PPFP>& c);
};

/*********************************************************
 * Collector One Ring
 *********************************************************/

/*
 * insideVertices = centerDart
 * insideEdges = star (edges incident to centerDart)
 * insideFaces = triangles incident to centerDart
 * border = vertices of 1-ring -> link (set of adjacent vertices)
 *        = edges of 1-ring
 */
template <typename PFP>
class Collector_OneRing : public Collector<PFP>
{
public:
	Collector_OneRing(typename PFP::MAP& m, unsigned int thread=0):
		Collector<PFP>(m, thread) {}
	void collectAll(Dart d);
	void collectBorder(Dart d);
};

/*********************************************************
 * Collector Within Sphere
 *********************************************************/

/*
 * collect all primitives of the connected component containing "centerDart"
 * within the sphere of radius "radius" and center "position[centerDart]"
 * (hopefully) it defines a 2-manifold (if inserting border-vertices along the border-edges)
 * NB : is equivalent to Collector_Vertices with CollectorCriterion_VertexWithinSphere
 */
template <typename PFP>
class Collector_WithinSphere : public Collector<PFP>
{
protected:
	const VertexAttribute<typename PFP::VEC3>& position;
	typename PFP::REAL radius;
	typename PFP::REAL area;

public:
	Collector_WithinSphere(typename PFP::MAP& m, const VertexAttribute<typename PFP::VEC3>& p, typename PFP::REAL r = 0, unsigned int thread=0) :
		Collector<PFP>(m, thread),
		position(p),
		radius(r),
		area(0)
	{}
	inline void setRadius(typename PFP::REAL r) { radius = r; }
	inline typename PFP::REAL getRadius() const { return radius; }
	inline const VertexAttribute<typename PFP::VEC3>& getPosition() const { return position; }

	void collectAll(Dart d);
	void collectBorder(Dart d);

	void computeArea();
	inline typename PFP::REAL getArea() const { return area; }
};

/*********************************************************
 * Collector Normal Angle (Vertices)
 *********************************************************/

/*
 * collect all primitives of the connected component containing "centerDart"
 * the angle between the included vertices normal vectors and the central normal vector
 * stays under a given threshold
 * NB : is equivalent to Collector_Vertices with CollectorCriterion_VertexNormalAngle
 */
template <typename PFP>
class Collector_NormalAngle : public Collector<PFP>
{
protected:
	const VertexAttribute<typename PFP::VEC3>& normal ;
	typename PFP::REAL angleThreshold ;

public:
	Collector_NormalAngle(
		typename PFP::MAP& m,
		const VertexAttribute<typename PFP::VEC3>& n,
		typename PFP::REAL a,
		unsigned int thread=0
	) :	Collector<PFP>(m,thread), normal(n), angleThreshold(a)
	{}
	inline void setAngleThreshold(typename PFP::REAL a) { angleThreshold = a; }
	inline typename PFP::REAL getAngleThreshold() const { return angleThreshold; }
	inline const VertexAttribute<typename PFP::VEC3>& getNormal() const { return normal ; }

	void collectAll(Dart d) ;
	void collectBorder(Dart d) ;
};

/*********************************************************
 * Collector Criterions
 *********************************************************/
class CollectorCriterion
{
public :
	CollectorCriterion() {};
	virtual ~CollectorCriterion() {} ;
	virtual void init(Dart center) = 0;
	virtual bool isInside(Dart d) = 0;

};

template <typename PFP>
class CollectorCriterion_VertexNormalAngle : public CollectorCriterion
{ // tests if the angle between vertex normals is below some threshold
private :
	typedef typename PFP::VEC3 VEC3;
	typedef typename PFP::REAL REAL;

	const VertexAttribute<VEC3> & vertexNormals;
	REAL threshold;
	VEC3 centerNormal;
public :
	CollectorCriterion_VertexNormalAngle(const VertexAttribute<VEC3> & n, REAL th) :
		vertexNormals(n), threshold(th), centerNormal(0) {}

	void init (Dart center) {centerNormal = vertexNormals[center];}
	bool isInside (Dart d) {
		return ( Geom::angle(centerNormal, vertexNormals[d]) < threshold);
	}
};

template <typename PFP>
class CollectorCriterion_TriangleNormalAngle : public CollectorCriterion
{ // tests if the angle between vertex normals is below some threshold
private :
	typedef typename PFP::VEC3 VEC3;
	typedef typename PFP::REAL REAL;

	const FaceAttribute<VEC3> & faceNormals;
	REAL threshold;
	VEC3 centerNormal;
public :
	CollectorCriterion_TriangleNormalAngle(const FaceAttribute<VEC3> & n, REAL th) :
		faceNormals(n), threshold(th), centerNormal(0) {}

	void init (Dart center) {centerNormal = faceNormals[center];}
	bool isInside (Dart d) {
		return ( Geom::angle(centerNormal, faceNormals[d]) < threshold);
	}
};

template <typename PFP>
class CollectorCriterion_VertexWithinSphere : public CollectorCriterion
{ // tests if the distance between vertices is below some threshold
private :
	typedef typename PFP::VEC3 VEC3;
	typedef typename PFP::REAL REAL;

	const VertexAttribute<VEC3> & vertexPositions;
	REAL threshold;
	VEC3 centerPosition;
public :
	CollectorCriterion_VertexWithinSphere(const VertexAttribute<VEC3> & p, REAL th) :
		vertexPositions(p), threshold(th), centerPosition(0) {}

	void init (Dart center) {centerPosition = vertexPositions[center];}
	bool isInside (Dart d) {
		return (vertexPositions[d] - centerPosition).norm() < threshold ;
	}
};


/*********************************************************
 * Collector Vertices
 *********************************************************/

/*
 * collect all vertices of the connected component containing "centerDart"
 * within a distance to centerDart defined by the CollectorCriterion
 * (hopefully) it defines a 2-manifold (if inserting border-vertices along the border-edges)
 */
template <typename PFP>
class Collector_Vertices : public Collector<PFP>
{
protected:
	CollectorCriterion & crit;

public:
	Collector_Vertices(typename PFP::MAP& m, CollectorCriterion& c, unsigned int thread=0) :
		Collector<PFP>(m, thread),
		crit(c)
	{}

	void collectAll(Dart d);
	void collectBorder(Dart d);
};


/*********************************************************
 * Collector Normal Angle (Triangles)
 *********************************************************/

/*
 * collect all primitives of the connected component containing "centerDart"
 * the angle between the included triangles normal vectors and the central normal vector
 * stays under a given threshold
 * NB : is equivalent to Collector_Triangles with CollectorCriterion_TriangleNormalAngle
 */
template <typename PFP>
class Collector_NormalAngle_Triangles : public Collector<PFP>
{
protected:
	const FaceAttribute<typename PFP::VEC3>& normal ;
	typename PFP::REAL angleThreshold ;

public:
	Collector_NormalAngle_Triangles(
		typename PFP::MAP& m,
		const FaceAttribute<typename PFP::VEC3>& n,
		typename PFP::REAL a,
		unsigned int thread=0
	) :	Collector<PFP>(m,thread), normal(n), angleThreshold(a)
	{}
	inline void setAngleThreshold(typename PFP::REAL a) { angleThreshold = a; }
	inline typename PFP::REAL getAngleThreshold() const { return angleThreshold; }
	inline const VertexAttribute<typename PFP::VEC3>& getNormal() const { return normal ; }

	void collectAll(Dart d) ;
	void collectBorder(Dart d) ;
};

/*********************************************************
 * Collector Triangles
 *********************************************************/

/*
 * collect all triangles of the connected component containing "centerDart"
 * within a distance to centerDart defined by the CollectorCriterion
 */
template <typename PFP>
class Collector_Triangles : public Collector<PFP>
{
protected:
	CollectorCriterion & crit;

public:
	Collector_Triangles(typename PFP::MAP& m, CollectorCriterion& c, unsigned int thread=0) :
		Collector<PFP>(m,thread), crit(c)
	{}

	void collectAll(Dart d) ;
	void collectBorder(Dart d) ;
};

/*********************************************************
 * Collector Dijkstra_Vertices
 *********************************************************/

/*
 * collect all primitives of the connected component containing "centerDart"
 * within a distance < maxDist (the shortest path follows edges)
 * the edge length is specified in edge_cost attribute
 */

template <typename PFP>
class Collector_Dijkstra_Vertices : public Collector<PFP>
{
protected:
	const EdgeAttribute<typename PFP::REAL>& edge_cost;
	typename PFP::REAL maxDist;

	typedef struct
	{
		typename std::multimap<float,Dart>::iterator it ;
		bool valid ;
		static std::string CGoGNnameOfType() { return "DijkstraVertexInfo" ; }
	} DijkstraVertexInfo ;
	typedef NoMathIOAttribute<DijkstraVertexInfo> VertexInfo ;

	VertexAttribute<VertexInfo> vertexInfo ;

	std::multimap<float,Dart> front ;

public:
	Collector_Dijkstra_Vertices(typename PFP::MAP& m, const EdgeAttribute<typename PFP::REAL>& c, typename PFP::REAL d = 0, unsigned int thread=0) :
		Collector<PFP>(m,thread),
		edge_cost(c),
		maxDist(d)
	{
		vertexInfo = m.template addAttribute<VertexInfo, VERTEX>("vertexInfo");
	}
	~Collector_Dijkstra_Vertices(){
		this->map.removeAttribute(vertexInfo);
	}
	inline void init (Dart d) {Collector<PFP>::init(d); front.clear();}
	inline void setMaxDistance(typename PFP::REAL d) { maxDist = d; }
	inline typename PFP::REAL getMaxDist() const { return maxDist; }

	void collectAll(Dart d);
	void collectBorder(Dart d);
};


/*********************************************************
 * Collector Dijkstra
 *********************************************************/

/*
 * collect all primitives of the connected component containing "centerDart"
 * within a distance < maxDist (the shortest path follows edges)
 */
template <typename PFP>
class Collector_Dijkstra : public Collector<PFP>
{
protected:
	const VertexAttribute<typename PFP::VEC3>& position;
	typename PFP::REAL maxDist;

	typedef struct
	{
		typename std::multimap<float,Dart>::iterator it ;
		bool valid ;
		static std::string CGoGNnameOfType() { return "DijkstraVertexInfo" ; }
	} DijkstraVertexInfo ;
	typedef NoMathIOAttribute<DijkstraVertexInfo> VertexInfo ;

	VertexAttribute<VertexInfo> vertexInfo ;

	std::multimap<float,Dart> front ;

public:
	Collector_Dijkstra(typename PFP::MAP& m, const VertexAttribute<typename PFP::VEC3>& p, typename PFP::REAL d = 0, unsigned int thread=0) :
		Collector<PFP>(m,thread),
		position(p),
		maxDist(d)
	{
		vertexInfo = m.template addAttribute<VertexInfo, VERTEX>("vertexInfo");
	}
	~Collector_Dijkstra(){
		this->map.removeAttribute(vertexInfo);
	}
	inline void init (Dart d) {Collector<PFP>::init(d); front.clear();}
	inline void setMaxDistance(typename PFP::REAL d) { maxDist = d; }
	inline typename PFP::REAL getMaxDist() const { return maxDist; }
	inline const VertexAttribute<typename PFP::VEC3>& getPosition() const { return position; }

	void collectAll(Dart d);
	void collectBorder(Dart d);
private :
	inline float edgeLength (Dart d);
//	inline Dart oppositeVertex (Dart d);
};



} // namespace Selection

} // namespace Algo

} // namespace CGoGN

#include "Algo/Selection/collector.hpp"

#endif