CGAL 5.1 - Classification
CGAL::Classification::Mesh_neighborhood< FaceListGraph > Class Template Reference

#include <CGAL/Classification/Mesh_neighborhood.h>

Definition

template<typename FaceListGraph>
class CGAL::Classification::Mesh_neighborhood< FaceListGraph >

Class that generates models of NeighborQuery based on an input mesh.

Template Parameters
FaceListGraphmodel of FaceListGraph.

Classes

class  N_ring_neighbor_query
 Functor that computes the N-ring neighborhood of the face of an input mesh. More...
 
class  One_ring_neighbor_query
 Functor that computes the 1-ring neighborhood of the face of an input mesh. More...
 

Public Types

typedef boost::graph_traits< FaceListGraph >::face_descriptor face_descriptor
 

Constructor

 Mesh_neighborhood (const FaceListGraph &mesh)
 Constructs a neighborhood object based on the input mesh. More...
 

Queries

One_ring_neighbor_query one_ring_neighbor_query () const
 Returns a 1-ring neighbor query object. More...
 
N_ring_neighbor_query n_ring_neighbor_query (const std::size_t n) const
 Returns an N-ring neighbor query object. More...
 

Member Typedef Documentation

◆ face_descriptor

template<typename FaceListGraph >
typedef boost::graph_traits<FaceListGraph>::face_descriptor CGAL::Classification::Mesh_neighborhood< FaceListGraph >::face_descriptor

Constructor & Destructor Documentation

◆ Mesh_neighborhood()

template<typename FaceListGraph >
CGAL::Classification::Mesh_neighborhood< FaceListGraph >::Mesh_neighborhood ( const FaceListGraph mesh)

Constructs a neighborhood object based on the input mesh.

Parameters
meshinput mesh.

Member Function Documentation

◆ n_ring_neighbor_query()

template<typename FaceListGraph >
N_ring_neighbor_query CGAL::Classification::Mesh_neighborhood< FaceListGraph >::n_ring_neighbor_query ( const std::size_t  n) const

Returns an N-ring neighbor query object.

◆ one_ring_neighbor_query()

template<typename FaceListGraph >
One_ring_neighbor_query CGAL::Classification::Mesh_neighborhood< FaceListGraph >::one_ring_neighbor_query ( ) const

Returns a 1-ring neighbor query object.