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

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

List of all members.

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::Face * pointer
typedef Mesh::Face & reference
typedef Mesh::FaceHandle value_handle
typedef Mesh::Face value_type

Public Member Functions

HalfedgeHandle current_halfedge_handle () const
Mesh::FaceHandle handle () const
 Return the handle of the current target.
 operator bool () const
 operator typename Mesh::FaceHandle () const
 Cast to the handle of the current target.
bool operator!= (const VertexFaceIterT &_rhs) const
 Not equal ?
reference operator* () const
 Return a reference to the current target.
VertexFaceIterToperator++ ()
 Pre-Increment (next cw target).
VertexFaceIterToperator-- ()
 Pre-Decrement (next ccw target).
pointer operator-> () const
 Return a pointer to the current target.
VertexFaceIterToperator= (const VertexFaceIterT< Mesh > &_rhs)
 Assignment operator.
bool operator== (const VertexFaceIterT &_rhs) const
 Equal ?
 VertexFaceIterT (const VertexFaceIterT &_rhs)
 Copy constructor.
 VertexFaceIterT (mesh_ref _mesh, HalfedgeHandle _heh, bool _end=false)
 Construct with mesh and start halfedge.
 VertexFaceIterT (mesh_ref _mesh, typename Mesh::VertexHandle _start, bool _end=false)
 Construct with mesh and a typename Mesh::VertexHandle.
 VertexFaceIterT ()
 Default constructor.

Protected Attributes

HalfedgeHandle heh_
int lap_counter_
mesh_ptr mesh_
HalfedgeHandle start_

Friends

class ConstVertexFaceIterT< Mesh >

Detailed Description

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

Circulator.

Definition at line 1652 of file CirculatorsT.hh.


Member Typedef Documentation

template<class Mesh>
typedef std::ptrdiff_t OpenMesh::Iterators::VertexFaceIterT< Mesh >::difference_type

Definition at line 1673 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh::HalfedgeHandle OpenMesh::Iterators::VertexFaceIterT< Mesh >::HalfedgeHandle

Definition at line 1659 of file CirculatorsT.hh.

template<class Mesh>
typedef std::bidirectional_iterator_tag OpenMesh::Iterators::VertexFaceIterT< Mesh >::iterator_category

Definition at line 1672 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh* OpenMesh::Iterators::VertexFaceIterT< Mesh >::mesh_ptr

Definition at line 1675 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh& OpenMesh::Iterators::VertexFaceIterT< Mesh >::mesh_ref

Definition at line 1674 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh::Face* OpenMesh::Iterators::VertexFaceIterT< Mesh >::pointer

Definition at line 1677 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh::Face& OpenMesh::Iterators::VertexFaceIterT< Mesh >::reference

Definition at line 1676 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh::FaceHandle OpenMesh::Iterators::VertexFaceIterT< Mesh >::value_handle

Definition at line 1662 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh::Face OpenMesh::Iterators::VertexFaceIterT< Mesh >::value_type

Definition at line 1661 of file CirculatorsT.hh.


Constructor & Destructor Documentation

template<class Mesh>
OpenMesh::Iterators::VertexFaceIterT< Mesh >::VertexFaceIterT (  )  [inline]

Default constructor.

Definition at line 1683 of file CirculatorsT.hh.

template<class Mesh>
OpenMesh::Iterators::VertexFaceIterT< Mesh >::VertexFaceIterT ( mesh_ref  _mesh,
typename Mesh::VertexHandle  _start,
bool  _end = false 
) [inline]

Construct with mesh and a typename Mesh::VertexHandle.

Definition at line 1687 of file CirculatorsT.hh.

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

Construct with mesh and start halfedge.

Definition at line 1696 of file CirculatorsT.hh.

template<class Mesh>
OpenMesh::Iterators::VertexFaceIterT< Mesh >::VertexFaceIterT ( const VertexFaceIterT< Mesh > &  _rhs  )  [inline]

Copy constructor.

Definition at line 1705 of file CirculatorsT.hh.


Member Function Documentation

template<class Mesh>
HalfedgeHandle OpenMesh::Iterators::VertexFaceIterT< 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 1783 of file CirculatorsT.hh.

template<class Mesh>
Mesh::FaceHandle OpenMesh::Iterators::VertexFaceIterT< Mesh >::handle (  )  const [inline]

Return the handle of the current target.

Definition at line 1789 of file CirculatorsT.hh.

template<class Mesh>
OpenMesh::Iterators::VertexFaceIterT< 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 1822 of file CirculatorsT.hh.

template<class Mesh>
OpenMesh::Iterators::VertexFaceIterT< Mesh >::operator typename Mesh::FaceHandle (  )  const [inline]

Cast to the handle of the current target.

Definition at line 1796 of file CirculatorsT.hh.

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

Not equal ?

Definition at line 1758 of file CirculatorsT.hh.

template<class Mesh>
reference OpenMesh::Iterators::VertexFaceIterT< Mesh >::operator* (  )  const [inline]

Return a reference to the current target.

Definition at line 1803 of file CirculatorsT.hh.

template<class Mesh>
VertexFaceIterT& OpenMesh::Iterators::VertexFaceIterT< Mesh >::operator++ (  )  [inline]

Pre-Increment (next cw target).

Definition at line 1764 of file CirculatorsT.hh.

template<class Mesh>
VertexFaceIterT& OpenMesh::Iterators::VertexFaceIterT< Mesh >::operator-- (  )  [inline]

Pre-Decrement (next ccw target).

Definition at line 1772 of file CirculatorsT.hh.

template<class Mesh>
pointer OpenMesh::Iterators::VertexFaceIterT< Mesh >::operator-> (  )  const [inline]

Return a pointer to the current target.

Definition at line 1810 of file CirculatorsT.hh.

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

Assignment operator.

Definition at line 1714 of file CirculatorsT.hh.

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

Equal ?

Definition at line 1749 of file CirculatorsT.hh.


Friends And Related Function Documentation

template<class Mesh>
friend class ConstVertexFaceIterT< Mesh > [friend]

Definition at line 1744 of file CirculatorsT.hh.


Member Data Documentation

template<class Mesh>
HalfedgeHandle OpenMesh::Iterators::VertexFaceIterT< Mesh >::heh_ [protected]

Definition at line 1830 of file CirculatorsT.hh.

template<class Mesh>
int OpenMesh::Iterators::VertexFaceIterT< Mesh >::lap_counter_ [protected]

Definition at line 1831 of file CirculatorsT.hh.

template<class Mesh>
mesh_ptr OpenMesh::Iterators::VertexFaceIterT< Mesh >::mesh_ [protected]

Definition at line 1829 of file CirculatorsT.hh.

template<class Mesh>
HalfedgeHandle OpenMesh::Iterators::VertexFaceIterT< Mesh >::start_ [protected]

Definition at line 1830 of file CirculatorsT.hh.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


openmesh
Author(s): Benjamin Pitzer
autogenerated on Fri Jan 11 12:11:18 2013