Point Cloud Library (PCL)  1.14.1-dev
List of all members | Public Types | Public Member Functions | Public Attributes
pcl::geometry::FaceAroundVertexCirculator< MeshT > Class Template Reference

Circulates counter-clockwise around a vertex and returns an index to the face of the outgoing half-edge (the target). More...

#include <pcl/geometry/mesh_circulators.h>

+ Inheritance diagram for pcl::geometry::FaceAroundVertexCirculator< MeshT >:
+ Collaboration diagram for pcl::geometry::FaceAroundVertexCirculator< MeshT >:

Public Types

using Base = boost::equality_comparable< pcl::geometry::FaceAroundVertexCirculator< MeshT >, boost::unit_steppable< pcl::geometry::FaceAroundVertexCirculator< MeshT > >>
 
using Self = pcl::geometry::FaceAroundVertexCirculator< MeshT >
 
using Mesh = MeshT
 
using FaceIndex = typename Mesh::FaceIndex
 
using VertexIndex = typename Mesh::VertexIndex
 
using HalfEdgeIndex = typename Mesh::HalfEdgeIndex
 

Public Member Functions

 FaceAroundVertexCirculator ()
 Constructor resulting in an invalid circulator. More...
 
 FaceAroundVertexCirculator (const VertexIndex &idx_vertex, Mesh *const mesh)
 Construct from the vertex around which we want to circulate. More...
 
 FaceAroundVertexCirculator (const HalfEdgeIndex &idx_outgoing_half_edge, Mesh *const mesh)
 Construct directly from the outgoing half-edge. More...
 
bool isValid () const
 Check if the circulator is valid. More...
 
bool operator== (const Self &other) const
 Comparison operators (with boost::operators): == !=. More...
 
Selfoperator++ ()
 Increment operators (with boost::operators): ++ (pre and post) More...
 
Selfoperator-- ()
 Decrement operators (with boost::operators): – (pre and post) More...
 
FaceIndex getTargetIndex () const
 Get the index to the target face. More...
 
HalfEdgeIndex getCurrentHalfEdgeIndex () const
 Get the half-edge that is currently stored in the circulator. More...
 

Public Attributes

Meshmesh_
 The mesh to which this circulator belongs to. More...
 
HalfEdgeIndex idx_outgoing_half_edge_
 The outgoing half-edge of the vertex around which we want to circulate. More...
 

Detailed Description

template<class MeshT>
class pcl::geometry::FaceAroundVertexCirculator< MeshT >

Circulates counter-clockwise around a vertex and returns an index to the face of the outgoing half-edge (the target).

The best way to declare the circulator is to use the method pcl::geometry::MeshBase::getFaceAroundVertexCirculator ().

Template Parameters
MeshTMesh to which this circulator belongs to.
Note
The circulator can't be used to change the connectivity in the mesh (only const circulators are valid).
Author
Martin Saelzle

Definition at line 384 of file mesh_circulators.h.

Member Typedef Documentation

◆ Base

template<class MeshT >
using pcl::geometry::FaceAroundVertexCirculator< MeshT >::Base = boost::equality_comparable< pcl::geometry::FaceAroundVertexCirculator<MeshT>, boost::unit_steppable<pcl::geometry::FaceAroundVertexCirculator<MeshT> >>

Definition at line 389 of file mesh_circulators.h.

◆ FaceIndex

template<class MeshT >
using pcl::geometry::FaceAroundVertexCirculator< MeshT >::FaceIndex = typename Mesh::FaceIndex

Definition at line 395 of file mesh_circulators.h.

◆ HalfEdgeIndex

template<class MeshT >
using pcl::geometry::FaceAroundVertexCirculator< MeshT >::HalfEdgeIndex = typename Mesh::HalfEdgeIndex

Definition at line 397 of file mesh_circulators.h.

◆ Mesh

template<class MeshT >
using pcl::geometry::FaceAroundVertexCirculator< MeshT >::Mesh = MeshT

Definition at line 394 of file mesh_circulators.h.

◆ Self

Definition at line 392 of file mesh_circulators.h.

◆ VertexIndex

template<class MeshT >
using pcl::geometry::FaceAroundVertexCirculator< MeshT >::VertexIndex = typename Mesh::VertexIndex

Definition at line 396 of file mesh_circulators.h.

Constructor & Destructor Documentation

◆ FaceAroundVertexCirculator() [1/3]

template<class MeshT >
pcl::geometry::FaceAroundVertexCirculator< MeshT >::FaceAroundVertexCirculator ( )
inline

Constructor resulting in an invalid circulator.

Definition at line 400 of file mesh_circulators.h.

◆ FaceAroundVertexCirculator() [2/3]

template<class MeshT >
pcl::geometry::FaceAroundVertexCirculator< MeshT >::FaceAroundVertexCirculator ( const VertexIndex idx_vertex,
Mesh *const  mesh 
)
inline

Construct from the vertex around which we want to circulate.

Definition at line 403 of file mesh_circulators.h.

◆ FaceAroundVertexCirculator() [3/3]

template<class MeshT >
pcl::geometry::FaceAroundVertexCirculator< MeshT >::FaceAroundVertexCirculator ( const HalfEdgeIndex idx_outgoing_half_edge,
Mesh *const  mesh 
)
inline

Construct directly from the outgoing half-edge.

Definition at line 408 of file mesh_circulators.h.

Member Function Documentation

◆ getCurrentHalfEdgeIndex()

template<class MeshT >
HalfEdgeIndex pcl::geometry::FaceAroundVertexCirculator< MeshT >::getCurrentHalfEdgeIndex ( ) const
inline

Get the half-edge that is currently stored in the circulator.

Definition at line 458 of file mesh_circulators.h.

References pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_.

◆ getTargetIndex()

template<class MeshT >
FaceIndex pcl::geometry::FaceAroundVertexCirculator< MeshT >::getTargetIndex ( ) const
inline

◆ isValid()

template<class MeshT >
bool pcl::geometry::FaceAroundVertexCirculator< MeshT >::isValid ( ) const
inline

Check if the circulator is valid.

Warning
Does NOT check if the stored mesh pointer is valid. You have to ensure this yourself when constructing the circulator.

Definition at line 417 of file mesh_circulators.h.

References pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_.

◆ operator++()

template<class MeshT >
Self& pcl::geometry::FaceAroundVertexCirculator< MeshT >::operator++ ( )
inline

Increment operators (with boost::operators): ++ (pre and post)

Definition at line 433 of file mesh_circulators.h.

References pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_, and pcl::geometry::FaceAroundVertexCirculator< MeshT >::mesh_.

◆ operator--()

template<class MeshT >
Self& pcl::geometry::FaceAroundVertexCirculator< MeshT >::operator-- ( )
inline

Decrement operators (with boost::operators): – (pre and post)

Definition at line 442 of file mesh_circulators.h.

References pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_, and pcl::geometry::FaceAroundVertexCirculator< MeshT >::mesh_.

◆ operator==()

template<class MeshT >
bool pcl::geometry::FaceAroundVertexCirculator< MeshT >::operator== ( const Self other) const
inline

Comparison operators (with boost::operators): == !=.

Warning
Does NOT check if the circulators belong to the same mesh. Please check this yourself.

Definition at line 426 of file mesh_circulators.h.

References pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_.

Member Data Documentation

◆ idx_outgoing_half_edge_

template<class MeshT >
HalfEdgeIndex pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_

◆ mesh_

template<class MeshT >
Mesh* pcl::geometry::FaceAroundVertexCirculator< MeshT >::mesh_

The documentation for this class was generated from the following file: