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>
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... |
|
Self & | operator++ () |
Increment operators (with boost::operators): ++ (pre and post) More... |
|
Self & | operator-- () |
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 |
|
Mesh * | mesh_ |
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
-
MeshT Mesh 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).
Definition at line 383 of file mesh_circulators.h.
Member Typedef Documentation
Base
using pcl::geometry::FaceAroundVertexCirculator< MeshT >::Base = boost::equality_comparable< pcl::geometry::FaceAroundVertexCirculator<MeshT>, boost::unit_steppable<pcl::geometry::FaceAroundVertexCirculator<MeshT> >> |
Definition at line 390 of file mesh_circulators.h.
FaceIndex
using pcl::geometry::FaceAroundVertexCirculator< MeshT >::FaceIndex = typename Mesh::FaceIndex |
Definition at line 394 of file mesh_circulators.h.
HalfEdgeIndex
using pcl::geometry::FaceAroundVertexCirculator< MeshT >::HalfEdgeIndex = typename Mesh::HalfEdgeIndex |
Definition at line 396 of file mesh_circulators.h.
Mesh
using pcl::geometry::FaceAroundVertexCirculator< MeshT >::Mesh = MeshT |
Definition at line 393 of file mesh_circulators.h.
Self
using pcl::geometry::FaceAroundVertexCirculator< MeshT >::Self = pcl::geometry::FaceAroundVertexCirculator<MeshT> |
Definition at line 391 of file mesh_circulators.h.
VertexIndex
using pcl::geometry::FaceAroundVertexCirculator< MeshT >::VertexIndex = typename Mesh::VertexIndex |
Definition at line 395 of file mesh_circulators.h.
Constructor & Destructor Documentation
FaceAroundVertexCirculator() [1/3]
|
inline |
Constructor resulting in an invalid circulator.
Definition at line 399 of file mesh_circulators.h.
FaceAroundVertexCirculator() [2/3]
|
inline |
Construct from the vertex around which we want to circulate.
Definition at line 402 of file mesh_circulators.h.
FaceAroundVertexCirculator() [3/3]
|
inline |
Construct directly from the outgoing half-edge.
Definition at line 407 of file mesh_circulators.h.
Member Function Documentation
getCurrentHalfEdgeIndex()
|
inline |
Get the half-edge that is currently stored in the circulator.
Definition at line 457 of file mesh_circulators.h.
References pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_.
getTargetIndex()
|
inline |
Get the index to the target face.
Definition at line 450 of file mesh_circulators.h.
References pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_, and pcl::geometry::FaceAroundVertexCirculator< MeshT >::mesh_.
Referenced by pcl::geometry::MeshBase< QuadMesh< MeshTraitsT >, MeshTraitsT, QuadMeshTag >::deleteVertex().
isValid()
|
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 416 of file mesh_circulators.h.
References pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_.
operator++()
|
inline |
Increment operators (with boost::operators): ++ (pre and post)
Definition at line 432 of file mesh_circulators.h.
References pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_, and pcl::geometry::FaceAroundVertexCirculator< MeshT >::mesh_.
operator--()
|
inline |
Decrement operators (with boost::operators): – (pre and post)
Definition at line 441 of file mesh_circulators.h.
References pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_, and pcl::geometry::FaceAroundVertexCirculator< MeshT >::mesh_.
operator==()
|
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 425 of file mesh_circulators.h.
References pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_.
Member Data Documentation
idx_outgoing_half_edge_
HalfEdgeIndex pcl::geometry::FaceAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_ |
The outgoing half-edge of the vertex around which we want to circulate.
Definition at line 466 of file mesh_circulators.h.
Referenced by pcl::geometry::FaceAroundVertexCirculator< MeshT >::getCurrentHalfEdgeIndex(), pcl::geometry::FaceAroundVertexCirculator< MeshT >::getTargetIndex(), pcl::geometry::FaceAroundVertexCirculator< MeshT >::isValid(), pcl::geometry::FaceAroundVertexCirculator< MeshT >::operator++(), pcl::geometry::FaceAroundVertexCirculator< MeshT >::operator--(), and pcl::geometry::FaceAroundVertexCirculator< MeshT >::operator==().
mesh_
Mesh* pcl::geometry::FaceAroundVertexCirculator< MeshT >::mesh_ |
The mesh to which this circulator belongs to.
Definition at line 463 of file mesh_circulators.h.
Referenced by pcl::geometry::FaceAroundVertexCirculator< MeshT >::getTargetIndex(), pcl::geometry::FaceAroundVertexCirculator< MeshT >::operator++(), and pcl::geometry::FaceAroundVertexCirculator< MeshT >::operator--().
The documentation for this class was generated from the following file:
- pcl/geometry/mesh_circulators.h
© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/classpcl_1_1geometry_1_1_face_around_vertex_circulator.html