Circulates clockwise around a face and returns an index to the face of the outer half-edge (the target). More...
#include <pcl/geometry/mesh_circulators.h>
Inheritance diagram for pcl::geometry::FaceAroundFaceCirculator< MeshT >:
Collaboration diagram for pcl::geometry::FaceAroundFaceCirculator< MeshT >:
Public Types | |
| using | Base = boost::equality_comparable< pcl::geometry::FaceAroundFaceCirculator< MeshT >, boost::unit_steppable< pcl::geometry::FaceAroundFaceCirculator< MeshT > >> |
| using | Self = pcl::geometry::FaceAroundFaceCirculator< MeshT > |
| using | Mesh = MeshT |
| using | FaceIndex = typename Mesh::FaceIndex |
| using | HalfEdgeIndex = typename Mesh::HalfEdgeIndex |
Public Member Functions | |
| FaceAroundFaceCirculator () | |
| Constructor resulting in an invalid circulator. More... | |
| FaceAroundFaceCirculator (const FaceIndex &idx_face, Mesh *const mesh) | |
| Construct from the face around which we want to circulate. More... | |
| FaceAroundFaceCirculator (const HalfEdgeIndex &idx_inner_half_edge, Mesh *const mesh) | |
| Construct directly from the inner 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_inner_half_edge_ |
| The inner half-edge of the face around which we want to circulate. More... | |
Detailed Description
template<class MeshT>
class pcl::geometry::FaceAroundFaceCirculator< MeshT >
Circulates clockwise around a face and returns an index to the face of the outer half-edge (the target).
The best way to declare the circulator is to use the method pcl::geometry::MeshBase::getFaceAroundFaceCirculator ().
- 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 791 of file mesh_circulators.h.
Member Typedef Documentation
◆ Base
| using pcl::geometry::FaceAroundFaceCirculator< MeshT >::Base = boost::equality_comparable< pcl::geometry::FaceAroundFaceCirculator<MeshT>, boost::unit_steppable<pcl::geometry::FaceAroundFaceCirculator<MeshT> >> |
Definition at line 796 of file mesh_circulators.h.
◆ FaceIndex
| using pcl::geometry::FaceAroundFaceCirculator< MeshT >::FaceIndex = typename Mesh::FaceIndex |
Definition at line 802 of file mesh_circulators.h.
◆ HalfEdgeIndex
| using pcl::geometry::FaceAroundFaceCirculator< MeshT >::HalfEdgeIndex = typename Mesh::HalfEdgeIndex |
Definition at line 803 of file mesh_circulators.h.
◆ Mesh
| using pcl::geometry::FaceAroundFaceCirculator< MeshT >::Mesh = MeshT |
Definition at line 801 of file mesh_circulators.h.
◆ Self
| using pcl::geometry::FaceAroundFaceCirculator< MeshT >::Self = pcl::geometry::FaceAroundFaceCirculator<MeshT> |
Definition at line 799 of file mesh_circulators.h.
Constructor & Destructor Documentation
◆ FaceAroundFaceCirculator() [1/3]
|
inline |
Constructor resulting in an invalid circulator.
Definition at line 806 of file mesh_circulators.h.
◆ FaceAroundFaceCirculator() [2/3]
|
inline |
Construct from the face around which we want to circulate.
Definition at line 809 of file mesh_circulators.h.
◆ FaceAroundFaceCirculator() [3/3]
|
inline |
Construct directly from the inner half-edge.
Definition at line 814 of file mesh_circulators.h.
Member Function Documentation
◆ getCurrentHalfEdgeIndex()
|
inline |
Get the half-edge that is currently stored in the circulator.
Definition at line 861 of file mesh_circulators.h.
References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_.
◆ getTargetIndex()
|
inline |
Get the index to the target face.
Definition at line 854 of file mesh_circulators.h.
References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_, and pcl::geometry::FaceAroundFaceCirculator< MeshT >::mesh_.
◆ 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 822 of file mesh_circulators.h.
References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_.
◆ operator++()
|
inline |
Increment operators (with boost::operators): ++ (pre and post)
Definition at line 838 of file mesh_circulators.h.
References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_, and pcl::geometry::FaceAroundFaceCirculator< MeshT >::mesh_.
◆ operator--()
|
inline |
Decrement operators (with boost::operators): – (pre and post)
Definition at line 846 of file mesh_circulators.h.
References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_, and pcl::geometry::FaceAroundFaceCirculator< 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 831 of file mesh_circulators.h.
References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_.
Member Data Documentation
◆ idx_inner_half_edge_
| HalfEdgeIndex pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_ |
The inner half-edge of the face around which we want to circulate.
Definition at line 870 of file mesh_circulators.h.
Referenced by pcl::geometry::FaceAroundFaceCirculator< MeshT >::getCurrentHalfEdgeIndex(), pcl::geometry::FaceAroundFaceCirculator< MeshT >::getTargetIndex(), pcl::geometry::FaceAroundFaceCirculator< MeshT >::isValid(), pcl::geometry::FaceAroundFaceCirculator< MeshT >::operator++(), pcl::geometry::FaceAroundFaceCirculator< MeshT >::operator--(), and pcl::geometry::FaceAroundFaceCirculator< MeshT >::operator==().
◆ mesh_
| Mesh* pcl::geometry::FaceAroundFaceCirculator< MeshT >::mesh_ |
The mesh to which this circulator belongs to.
Definition at line 867 of file mesh_circulators.h.
Referenced by pcl::geometry::FaceAroundFaceCirculator< MeshT >::getTargetIndex(), pcl::geometry::FaceAroundFaceCirculator< MeshT >::operator++(), and pcl::geometry::FaceAroundFaceCirculator< MeshT >::operator--().
The documentation for this class was generated from the following file:
- pcl/geometry/mesh_circulators.h