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

Circulates counter-clockwise around a vertex and returns an index to the outgoing half-edge (the target). The best way to declare the circulator is to use the method pcl::geometry::MeshBase::getOutgoingHalfEdgeAroundVertexCirculator (). More...

#include <mesh_circulators.h>

List of all members.

Public Types

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

Public Member Functions

HalfEdgeIndex getCurrentHalfEdgeIndex () const
 Get the half-edge that is currently stored in the circulator.
HalfEdgeIndex getTargetIndex () const
 Get the index to the outgoing half-edge.
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): == !=.
 OutgoingHalfEdgeAroundVertexCirculator ()
 Constructor resulting in an invalid circulator.
 OutgoingHalfEdgeAroundVertexCirculator (const VertexIndex &idx_vertex, Mesh *const mesh)
 Construct from the vertex around which we want to circulate.
 OutgoingHalfEdgeAroundVertexCirculator (const HalfEdgeIndex &idx_outgoing_half_edge, Mesh *const mesh)
 Construct directly from the outgoing half-edge.

Public Attributes

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

Detailed Description

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

Circulates counter-clockwise around a vertex and returns an index to the outgoing half-edge (the target). The best way to declare the circulator is to use the method pcl::geometry::MeshBase::getOutgoingHalfEdgeAroundVertexCirculator ().

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


Member Typedef Documentation

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

Definition at line 180 of file mesh_circulators.h.

Definition at line 185 of file mesh_circulators.h.

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

Definition at line 183 of file mesh_circulators.h.

Definition at line 181 of file mesh_circulators.h.

Definition at line 184 of file mesh_circulators.h.


Constructor & Destructor Documentation

Constructor resulting in an invalid circulator.

Definition at line 188 of file mesh_circulators.h.

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

Construct from the vertex around which we want to circulate.

Definition at line 195 of file mesh_circulators.h.

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

Construct directly from the outgoing half-edge.

Definition at line 203 of file mesh_circulators.h.


Member Function Documentation

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

Definition at line 251 of file mesh_circulators.h.

template<class MeshT >
HalfEdgeIndex pcl::geometry::OutgoingHalfEdgeAroundVertexCirculator< MeshT >::getTargetIndex ( ) const [inline]

Get the index to the outgoing half-edge.

Definition at line 244 of file mesh_circulators.h.

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

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

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

Definition at line 228 of file mesh_circulators.h.

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

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

Definition at line 236 of file mesh_circulators.h.

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


Member Data Documentation

The outgoing half-edge of the vertex around which we want to circulate.

Definition at line 260 of file mesh_circulators.h.

The mesh to which this circulator belongs to.

Definition at line 257 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