OpenMesh::Iterators::FaceEdgeIterT< Mesh > Class Template Reference

#include <OpenMesh/Mesh/Iterators/CirculatorsT.hh>

Public Types
typedef std::ptrdiff_t	difference_type
typedef Mesh::HalfedgeHandle	HalfedgeHandle
typedef std::bidirectional_iterator_tag	iterator_category
typedef Mesh *	mesh_ptr
typedef Mesh &	mesh_ref
typedef Mesh::Edge *	pointer
typedef Mesh::Edge &	reference
typedef Mesh::EdgeHandle	value_handle
typedef Mesh::Edge	value_type
Public Member Functions
HalfedgeHandle	current_halfedge_handle () const
	FaceEdgeIterT (const FaceEdgeIterT &_rhs)
	Copy constructor.
	FaceEdgeIterT (mesh_ref _mesh, HalfedgeHandle _heh, bool _end=false)
	Construct with mesh and start halfedge.
	FaceEdgeIterT (mesh_ref _mesh, typename Mesh::FaceHandle _start, bool _end=false)
	Construct with mesh and a typename Mesh::FaceHandle.
	FaceEdgeIterT ()
	Default constructor.
Mesh::EdgeHandle	handle () const
	Return the handle of the current target.
	operator bool () const
	operator typename Mesh::EdgeHandle () const
	Cast to the handle of the current target.
bool	operator!= (const FaceEdgeIterT &_rhs) const
	Not equal ?
reference	operator* () const
	Return a reference to the current target.
FaceEdgeIterT &	operator++ ()
	Pre-Increment (next cw target).
FaceEdgeIterT &	operator-- ()
	Pre-Decrement (next ccw target).
pointer	operator-> () const
	Return a pointer to the current target.
FaceEdgeIterT &	operator= (const FaceEdgeIterT< Mesh > &_rhs)
	Assignment operator.
bool	operator== (const FaceEdgeIterT &_rhs) const
	Equal ?
Protected Attributes
HalfedgeHandle	heh_
int	lap_counter_
mesh_ptr	mesh_
HalfedgeHandle	start_
Friends
class	ConstFaceEdgeIterT< Mesh >

Detailed Description

template<class Mesh>
class OpenMesh::Iterators::FaceEdgeIterT< Mesh >

Circulator.

Definition at line 2812 of file CirculatorsT.hh.

Member Typedef Documentation

template<class Mesh>

typedef std::ptrdiff_t OpenMesh::Iterators::FaceEdgeIterT< Mesh >::difference_type

Definition at line 2833 of file CirculatorsT.hh.

template<class Mesh>

typedef Mesh::HalfedgeHandle OpenMesh::Iterators::FaceEdgeIterT< Mesh >::HalfedgeHandle

Definition at line 2819 of file CirculatorsT.hh.

template<class Mesh>

typedef std::bidirectional_iterator_tag OpenMesh::Iterators::FaceEdgeIterT< Mesh >::iterator_category

Definition at line 2832 of file CirculatorsT.hh.

template<class Mesh>

typedef Mesh* OpenMesh::Iterators::FaceEdgeIterT< Mesh >::mesh_ptr

Definition at line 2835 of file CirculatorsT.hh.

template<class Mesh>

typedef Mesh& OpenMesh::Iterators::FaceEdgeIterT< Mesh >::mesh_ref

Definition at line 2834 of file CirculatorsT.hh.

template<class Mesh>

typedef Mesh::Edge* OpenMesh::Iterators::FaceEdgeIterT< Mesh >::pointer

Definition at line 2837 of file CirculatorsT.hh.

template<class Mesh>

typedef Mesh::Edge& OpenMesh::Iterators::FaceEdgeIterT< Mesh >::reference

Definition at line 2836 of file CirculatorsT.hh.

template<class Mesh>

typedef Mesh::EdgeHandle OpenMesh::Iterators::FaceEdgeIterT< Mesh >::value_handle

Definition at line 2822 of file CirculatorsT.hh.

template<class Mesh>

typedef Mesh::Edge OpenMesh::Iterators::FaceEdgeIterT< Mesh >::value_type

Definition at line 2821 of file CirculatorsT.hh.

Constructor & Destructor Documentation

template<class Mesh>

OpenMesh::Iterators::FaceEdgeIterT< Mesh >::FaceEdgeIterT ( ) [inline]

Default constructor.

Definition at line 2843 of file CirculatorsT.hh.

template<class Mesh>

OpenMesh::Iterators::FaceEdgeIterT< Mesh >::FaceEdgeIterT	(	mesh_ref	_mesh,
		typename Mesh::FaceHandle	_start,
		bool	_end = `false`
	)			`[inline]`

Construct with mesh and a typename Mesh::FaceHandle.

Definition at line 2847 of file CirculatorsT.hh.

template<class Mesh>

OpenMesh::Iterators::FaceEdgeIterT< Mesh >::FaceEdgeIterT	(	mesh_ref	_mesh,
		HalfedgeHandle	_heh,
		bool	_end = `false`
	)			`[inline]`

Construct with mesh and start halfedge.

Definition at line 2856 of file CirculatorsT.hh.

template<class Mesh>

OpenMesh::Iterators::FaceEdgeIterT< Mesh >::FaceEdgeIterT ( const FaceEdgeIterT< Mesh > & _rhs ) [inline]

Copy constructor.

Definition at line 2865 of file CirculatorsT.hh.

Member Function Documentation

template<class Mesh>

HalfedgeHandle OpenMesh::Iterators::FaceEdgeIterT< Mesh >::current_halfedge_handle ( ) const [inline]

Get the current halfedge. There are Vertex*Iters and Face*Iters. For both the current state is defined by the current halfedge. This is what this method returns.

Definition at line 2945 of file CirculatorsT.hh.

template<class Mesh>

Mesh::EdgeHandle OpenMesh::Iterators::FaceEdgeIterT< Mesh >::handle ( ) const [inline]

Return the handle of the current target.

Definition at line 2951 of file CirculatorsT.hh.

template<class Mesh>

OpenMesh::Iterators::FaceEdgeIterT< Mesh >::operator bool ( ) const [inline]

Returns whether the circulator is still valid. After one complete round around a vertex/face the circulator becomes invalid, i.e. this function will return false. Nevertheless you can continue circulating. This method just tells you whether you have completed the first round.

Definition at line 2984 of file CirculatorsT.hh.

template<class Mesh>

OpenMesh::Iterators::FaceEdgeIterT< Mesh >::operator typename Mesh::EdgeHandle ( ) const [inline]

Cast to the handle of the current target.

Definition at line 2958 of file CirculatorsT.hh.

template<class Mesh>

bool OpenMesh::Iterators::FaceEdgeIterT< Mesh >::operator!= ( const FaceEdgeIterT< Mesh > & _rhs ) const [inline]

Not equal ?

Definition at line 2918 of file CirculatorsT.hh.

template<class Mesh>

reference OpenMesh::Iterators::FaceEdgeIterT< Mesh >::operator* ( ) const [inline]

Return a reference to the current target.

Definition at line 2965 of file CirculatorsT.hh.

template<class Mesh>

FaceEdgeIterT& OpenMesh::Iterators::FaceEdgeIterT< Mesh >::operator++ ( ) [inline]

Pre-Increment (next cw target).

Definition at line 2924 of file CirculatorsT.hh.

template<class Mesh>

FaceEdgeIterT& OpenMesh::Iterators::FaceEdgeIterT< Mesh >::operator-- ( ) [inline]

Pre-Decrement (next ccw target).

Definition at line 2933 of file CirculatorsT.hh.

template<class Mesh>

pointer OpenMesh::Iterators::FaceEdgeIterT< Mesh >::operator-> ( ) const [inline]

Return a pointer to the current target.

Definition at line 2972 of file CirculatorsT.hh.

template<class Mesh>

FaceEdgeIterT& OpenMesh::Iterators::FaceEdgeIterT< Mesh >::operator= ( const FaceEdgeIterT< Mesh > & _rhs ) [inline]

Assignment operator.

Definition at line 2874 of file CirculatorsT.hh.

template<class Mesh>

bool OpenMesh::Iterators::FaceEdgeIterT< Mesh >::operator== ( const FaceEdgeIterT< Mesh > & _rhs ) const [inline]

Equal ?

Definition at line 2909 of file CirculatorsT.hh.

Friends And Related Function Documentation

template<class Mesh>

friend class ConstFaceEdgeIterT< Mesh > [friend]

Definition at line 2904 of file CirculatorsT.hh.

Member Data Documentation

template<class Mesh>

HalfedgeHandle OpenMesh::Iterators::FaceEdgeIterT< Mesh >::heh_ [protected]

Definition at line 2992 of file CirculatorsT.hh.

template<class Mesh>

int OpenMesh::Iterators::FaceEdgeIterT< Mesh >::lap_counter_ [protected]

Definition at line 2993 of file CirculatorsT.hh.

template<class Mesh>

mesh_ptr OpenMesh::Iterators::FaceEdgeIterT< Mesh >::mesh_ [protected]

Definition at line 2991 of file CirculatorsT.hh.

template<class Mesh>

HalfedgeHandle OpenMesh::Iterators::FaceEdgeIterT< Mesh >::start_ [protected]

Definition at line 2992 of file CirculatorsT.hh.

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

CirculatorsT.hh

OpenMesh::Iterators::FaceEdgeIterT< Mesh > Class Template Reference

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

template<class Mesh> class OpenMesh::Iterators::FaceEdgeIterT< Mesh >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class Mesh>
class OpenMesh::Iterators::FaceEdgeIterT< Mesh >