Public Types | Public Member Functions | Public Attributes
pcl::geometry::VertexAroundFaceCirculator< MeshT > Class Template Reference

Circulates clockwise around a face and returns an index to the terminating vertex of the inner half-edge (the target). The best way to declare the circulator is to use the method pcl::geometry::MeshBase::getVertexAroundFaceCirculator (). More...

#include <mesh_circulators.h>

List of all members.

Public Types

typedef
boost::equality_comparable
< pcl::geometry::VertexAroundFaceCirculator
< MeshT >
, boost::unit_steppable
< pcl::geometry::VertexAroundFaceCirculator
< MeshT > > > 
Base
typedef Mesh::FaceIndex FaceIndex
typedef Mesh::HalfEdgeIndex HalfEdgeIndex
typedef MeshT Mesh
typedef
pcl::geometry::VertexAroundFaceCirculator
< MeshT > 
Self
typedef Mesh::VertexIndex VertexIndex

Public Member Functions

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

Public Attributes

HalfEdgeIndex idx_inner_half_edge_
 The inner half-edge of the face around which we want to circulate.
Meshmesh_
 The mesh to which this circulator belongs to.

Detailed Description

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

Circulates clockwise around a face and returns an index to the terminating vertex of the inner half-edge (the target). The best way to declare the circulator is to use the method pcl::geometry::MeshBase::getVertexAroundFaceCirculator ().

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 497 of file mesh_circulators.h.


Member Typedef Documentation

template<class MeshT >
typedef boost::equality_comparable<pcl::geometry::VertexAroundFaceCirculator <MeshT> , boost::unit_steppable <pcl::geometry::VertexAroundFaceCirculator <MeshT> > > pcl::geometry::VertexAroundFaceCirculator< MeshT >::Base

Definition at line 505 of file mesh_circulators.h.

template<class MeshT >
typedef Mesh::FaceIndex pcl::geometry::VertexAroundFaceCirculator< MeshT >::FaceIndex

Definition at line 510 of file mesh_circulators.h.

Definition at line 511 of file mesh_circulators.h.

template<class MeshT >
typedef MeshT pcl::geometry::VertexAroundFaceCirculator< MeshT >::Mesh

Definition at line 508 of file mesh_circulators.h.

Definition at line 506 of file mesh_circulators.h.

Definition at line 509 of file mesh_circulators.h.


Constructor & Destructor Documentation

template<class MeshT >
pcl::geometry::VertexAroundFaceCirculator< MeshT >::VertexAroundFaceCirculator ( ) [inline]

Constructor resulting in an invalid circulator.

Definition at line 514 of file mesh_circulators.h.

template<class MeshT >
pcl::geometry::VertexAroundFaceCirculator< MeshT >::VertexAroundFaceCirculator ( const FaceIndex idx_face,
Mesh *const  mesh 
) [inline]

Construct from the face around which we want to circulate.

Definition at line 521 of file mesh_circulators.h.

template<class MeshT >
pcl::geometry::VertexAroundFaceCirculator< MeshT >::VertexAroundFaceCirculator ( const HalfEdgeIndex idx_inner_half_edge,
Mesh *const  mesh 
) [inline]

Construct directly from the inner half-edge.

Definition at line 529 of file mesh_circulators.h.


Member Function Documentation

template<class MeshT >
HalfEdgeIndex pcl::geometry::VertexAroundFaceCirculator< MeshT >::getCurrentHalfEdgeIndex ( ) const [inline]

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

Definition at line 577 of file mesh_circulators.h.

template<class MeshT >
VertexIndex pcl::geometry::VertexAroundFaceCirculator< MeshT >::getTargetIndex ( ) const [inline]

Get the index to the target vertex.

Definition at line 570 of file mesh_circulators.h.

template<class MeshT >
bool pcl::geometry::VertexAroundFaceCirculator< 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 539 of file mesh_circulators.h.

template<class MeshT >
Self& pcl::geometry::VertexAroundFaceCirculator< MeshT >::operator++ ( ) [inline]

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

Definition at line 554 of file mesh_circulators.h.

template<class MeshT >
Self& pcl::geometry::VertexAroundFaceCirculator< MeshT >::operator-- ( ) [inline]

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

Definition at line 562 of file mesh_circulators.h.

template<class MeshT >
bool pcl::geometry::VertexAroundFaceCirculator< 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 547 of file mesh_circulators.h.


Member Data Documentation

The inner half-edge of the face around which we want to circulate.

Definition at line 586 of file mesh_circulators.h.

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

The mesh to which this circulator belongs to.

Definition at line 583 of file mesh_circulators.h.


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


pcl
Author(s): Open Perception
autogenerated on Wed Aug 26 2015 15:43:56