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

#include <pcl/geometry/mesh_circulators.h>

Inheritance diagram for pcl::geometry::VertexAroundVertexCirculator< MeshT >:

Collaboration diagram for pcl::geometry::VertexAroundVertexCirculator< MeshT >:

Public Types
using	Base = boost::equality_comparable< pcl::geometry::VertexAroundVertexCirculator< MeshT >, boost::unit_steppable< pcl::geometry::VertexAroundVertexCirculator< MeshT > >>

using	Self = pcl::geometry::VertexAroundVertexCirculator< MeshT >

using	Mesh = MeshT

using	VertexIndex = typename Mesh::VertexIndex

using	HalfEdgeIndex = typename Mesh::HalfEdgeIndex

Public Member Functions
	VertexAroundVertexCirculator ()
	Constructor resulting in an invalid circulator. More...

	VertexAroundVertexCirculator (const VertexIndex &idx_vertex, Mesh *const mesh)
	Construct from the vertex around which we want to circulate. More...

	VertexAroundVertexCirculator (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...

VertexIndex	getTargetIndex () const
	Get the index to the target vertex. 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::VertexAroundVertexCirculator< MeshT >

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

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

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).

Author: Martin Saelzle

Definition at line 67 of file mesh_circulators.h.

Member Typedef Documentation

◆ Base

template<class MeshT >

using pcl::geometry::VertexAroundVertexCirculator< MeshT >::Base = boost::equality_comparable< pcl::geometry::VertexAroundVertexCirculator<MeshT>, boost::unit_steppable<pcl::geometry::VertexAroundVertexCirculator<MeshT> >>

Definition at line 72 of file mesh_circulators.h.

◆ HalfEdgeIndex

template<class MeshT >

using pcl::geometry::VertexAroundVertexCirculator< MeshT >::HalfEdgeIndex = typename Mesh::HalfEdgeIndex

Definition at line 79 of file mesh_circulators.h.

◆ Mesh

template<class MeshT >

using pcl::geometry::VertexAroundVertexCirculator< MeshT >::Mesh = MeshT

Definition at line 77 of file mesh_circulators.h.

◆ Self

template<class MeshT >

using pcl::geometry::VertexAroundVertexCirculator< MeshT >::Self = pcl::geometry::VertexAroundVertexCirculator<MeshT>

Definition at line 75 of file mesh_circulators.h.

◆ VertexIndex

template<class MeshT >

using pcl::geometry::VertexAroundVertexCirculator< MeshT >::VertexIndex = typename Mesh::VertexIndex

Definition at line 78 of file mesh_circulators.h.

Constructor & Destructor Documentation

◆ VertexAroundVertexCirculator() [1/3]

template<class MeshT >

pcl::geometry::VertexAroundVertexCirculator< MeshT >::VertexAroundVertexCirculator ( )

inline

Constructor resulting in an invalid circulator.

Definition at line 82 of file mesh_circulators.h.

◆ VertexAroundVertexCirculator() [2/3]

template<class MeshT >

pcl::geometry::VertexAroundVertexCirculator< MeshT >::VertexAroundVertexCirculator	(	const VertexIndex &	idx_vertex,
		Mesh *const	mesh
	)

inline

Construct from the vertex around which we want to circulate.

Definition at line 85 of file mesh_circulators.h.

◆ VertexAroundVertexCirculator() [3/3]

template<class MeshT >

pcl::geometry::VertexAroundVertexCirculator< MeshT >::VertexAroundVertexCirculator	(	const HalfEdgeIndex &	idx_outgoing_half_edge,
		Mesh *const	mesh
	)

inline

Construct directly from the outgoing half-edge.

Definition at line 90 of file mesh_circulators.h.

Member Function Documentation

◆ getCurrentHalfEdgeIndex()

template<class MeshT >

HalfEdgeIndex pcl::geometry::VertexAroundVertexCirculator< MeshT >::getCurrentHalfEdgeIndex ( ) const

inline

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

Definition at line 140 of file mesh_circulators.h.

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

Referenced by pcl::geometry::MeshBase< DerivedT, MeshTraitsT, MeshTagT >::checkTopology1().

◆ getTargetIndex()

template<class MeshT >

VertexIndex pcl::geometry::VertexAroundVertexCirculator< MeshT >::getTargetIndex ( ) const

inline

Get the index to the target vertex.

Definition at line 133 of file mesh_circulators.h.

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

Referenced by pcl::geometry::MeshBase< DerivedT, MeshTraitsT, MeshTagT >::checkTopology1().

◆ isValid()

template<class MeshT >

bool pcl::geometry::VertexAroundVertexCirculator< 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 99 of file mesh_circulators.h.

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

◆ operator++()

template<class MeshT >

Self& pcl::geometry::VertexAroundVertexCirculator< MeshT >::operator++ ( )

inline

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

Definition at line 115 of file mesh_circulators.h.

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

◆ operator--()

template<class MeshT >

Self& pcl::geometry::VertexAroundVertexCirculator< MeshT >::operator-- ( )

inline

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

Definition at line 124 of file mesh_circulators.h.

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

◆ operator==()

template<class MeshT >

bool pcl::geometry::VertexAroundVertexCirculator< 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 108 of file mesh_circulators.h.

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

Member Data Documentation

◆ idx_outgoing_half_edge_

template<class MeshT >

HalfEdgeIndex pcl::geometry::VertexAroundVertexCirculator< MeshT >::idx_outgoing_half_edge_

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

Definition at line 149 of file mesh_circulators.h.

Referenced by pcl::geometry::VertexAroundVertexCirculator< MeshT >::getCurrentHalfEdgeIndex(), pcl::geometry::VertexAroundVertexCirculator< MeshT >::getTargetIndex(), pcl::geometry::VertexAroundVertexCirculator< MeshT >::isValid(), pcl::geometry::VertexAroundVertexCirculator< MeshT >::operator++(), pcl::geometry::VertexAroundVertexCirculator< MeshT >::operator--(), and pcl::geometry::VertexAroundVertexCirculator< MeshT >::operator==().

◆ mesh_

template<class MeshT >

Mesh* pcl::geometry::VertexAroundVertexCirculator< MeshT >::mesh_

The mesh to which this circulator belongs to.

Definition at line 146 of file mesh_circulators.h.

Referenced by pcl::geometry::VertexAroundVertexCirculator< MeshT >::getTargetIndex(), pcl::geometry::VertexAroundVertexCirculator< MeshT >::operator++(), and pcl::geometry::VertexAroundVertexCirculator< MeshT >::operator--().

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

pcl/geometry/mesh_circulators.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

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

Member Typedef Documentation

◆ Base

◆ HalfEdgeIndex

◆ Mesh

◆ Self

◆ VertexIndex

Constructor & Destructor Documentation

◆ VertexAroundVertexCirculator() [1/3]

◆ VertexAroundVertexCirculator() [2/3]

◆ VertexAroundVertexCirculator() [3/3]

Member Function Documentation

◆ getCurrentHalfEdgeIndex()

◆ getTargetIndex()

◆ isValid()

◆ operator++()

◆ operator--()

◆ operator==()

Member Data Documentation

◆ idx_outgoing_half_edge_

◆ mesh_

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