W3cubDocs

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>

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

Author: Martin Saelzle

Definition at line 790 of file mesh_circulators.h.

Member Typedef Documentation

Base

template<class MeshT >

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

Definition at line 797 of file mesh_circulators.h.

FaceIndex

template<class MeshT >

using pcl::geometry::FaceAroundFaceCirculator< MeshT >::FaceIndex = typename Mesh::FaceIndex

Definition at line 801 of file mesh_circulators.h.

HalfEdgeIndex

template<class MeshT >

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

Definition at line 802 of file mesh_circulators.h.

Mesh

template<class MeshT >

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

Definition at line 800 of file mesh_circulators.h.

Self

template<class MeshT >

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

Definition at line 798 of file mesh_circulators.h.

Constructor & Destructor Documentation

FaceAroundFaceCirculator() [1/3]

template<class MeshT >

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

inline

Constructor resulting in an invalid circulator.

Definition at line 805 of file mesh_circulators.h.

FaceAroundFaceCirculator() [2/3]

template<class MeshT >

pcl::geometry::FaceAroundFaceCirculator< MeshT >::FaceAroundFaceCirculator	(	const FaceIndex &	idx_face,
		Mesh *const	mesh
	)

inline

Construct from the face around which we want to circulate.

Definition at line 808 of file mesh_circulators.h.

FaceAroundFaceCirculator() [3/3]

template<class MeshT >

pcl::geometry::FaceAroundFaceCirculator< MeshT >::FaceAroundFaceCirculator	(	const HalfEdgeIndex &	idx_inner_half_edge,
		Mesh *const	mesh
	)

inline

Construct directly from the inner half-edge.

Definition at line 813 of file mesh_circulators.h.

Member Function Documentation

getCurrentHalfEdgeIndex()

template<class MeshT >

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

inline

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

Definition at line 860 of file mesh_circulators.h.

References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_.

getTargetIndex()

template<class MeshT >

FaceIndex pcl::geometry::FaceAroundFaceCirculator< MeshT >::getTargetIndex ( ) const

inline

Get the index to the target face.

Definition at line 853 of file mesh_circulators.h.

References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_, and pcl::geometry::FaceAroundFaceCirculator< MeshT >::mesh_.

isValid()

template<class MeshT >

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

References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_.

operator++()

template<class MeshT >

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

inline

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

Definition at line 837 of file mesh_circulators.h.

References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_, and pcl::geometry::FaceAroundFaceCirculator< MeshT >::mesh_.

operator--()

template<class MeshT >

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

inline

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

Definition at line 845 of file mesh_circulators.h.

References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_, and pcl::geometry::FaceAroundFaceCirculator< MeshT >::mesh_.

operator==()

template<class MeshT >

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

References pcl::geometry::FaceAroundFaceCirculator< MeshT >::idx_inner_half_edge_.

Member Data Documentation

idx_inner_half_edge_

template<class MeshT >

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 869 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_

template<class MeshT >

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

The mesh to which this circulator belongs to.

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

© 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_face_circulator.html

Public Types

Public Member Functions

Public Attributes

Detailed Description

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

Member Typedef Documentation

Base

FaceIndex

HalfEdgeIndex

Mesh

Self

Constructor & Destructor Documentation

FaceAroundFaceCirculator() [1/3]

FaceAroundFaceCirculator() [2/3]

FaceAroundFaceCirculator() [3/3]

Member Function Documentation

getCurrentHalfEdgeIndex()

getTargetIndex()

isValid()

operator++()

operator--()

operator==()

Member Data Documentation

idx_inner_half_edge_

mesh_

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