OpenMesh::Iterators::FaceVertexIterT< 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::Vertex * pointer
typedef Mesh::Vertex & reference
typedef Mesh::VertexHandle value_handle
typedef Mesh::Vertex value_type

Public Member Functions

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

Protected Attributes

HalfedgeHandle heh_
int lap_counter_
mesh_ptr mesh_
HalfedgeHandle start_

Friends

class ConstFaceVertexIterT< Mesh >

Detailed Description

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

Circulator.

Definition at line 2036 of file CirculatorsT.hh.


Member Typedef Documentation

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

Definition at line 2057 of file CirculatorsT.hh.

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

Definition at line 2043 of file CirculatorsT.hh.

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

Definition at line 2056 of file CirculatorsT.hh.

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

Definition at line 2059 of file CirculatorsT.hh.

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

Definition at line 2058 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh::Vertex* OpenMesh::Iterators::FaceVertexIterT< Mesh >::pointer

Definition at line 2061 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh::Vertex& OpenMesh::Iterators::FaceVertexIterT< Mesh >::reference

Definition at line 2060 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh::VertexHandle OpenMesh::Iterators::FaceVertexIterT< Mesh >::value_handle

Definition at line 2046 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh::Vertex OpenMesh::Iterators::FaceVertexIterT< Mesh >::value_type

Definition at line 2045 of file CirculatorsT.hh.


Constructor & Destructor Documentation

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

Default constructor.

Definition at line 2067 of file CirculatorsT.hh.

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

Construct with mesh and a typename Mesh::FaceHandle.

Definition at line 2071 of file CirculatorsT.hh.

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

Construct with mesh and start halfedge.

Definition at line 2080 of file CirculatorsT.hh.

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

Copy constructor.

Definition at line 2089 of file CirculatorsT.hh.


Member Function Documentation

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

template<class Mesh>
Mesh::VertexHandle OpenMesh::Iterators::FaceVertexIterT< Mesh >::handle (  )  const [inline]

Return the handle of the current target.

Definition at line 2175 of file CirculatorsT.hh.

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

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

Cast to the handle of the current target.

Definition at line 2182 of file CirculatorsT.hh.

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

Not equal ?

Definition at line 2142 of file CirculatorsT.hh.

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

Return a reference to the current target.

Definition at line 2189 of file CirculatorsT.hh.

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

Pre-Increment (next cw target).

Definition at line 2148 of file CirculatorsT.hh.

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

Pre-Decrement (next ccw target).

Definition at line 2157 of file CirculatorsT.hh.

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

Return a pointer to the current target.

Definition at line 2196 of file CirculatorsT.hh.

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

Assignment operator.

Definition at line 2098 of file CirculatorsT.hh.

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

Equal ?

Definition at line 2133 of file CirculatorsT.hh.


Friends And Related Function Documentation

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

Definition at line 2128 of file CirculatorsT.hh.


Member Data Documentation

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

Definition at line 2216 of file CirculatorsT.hh.

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

Definition at line 2217 of file CirculatorsT.hh.

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

Definition at line 2215 of file CirculatorsT.hh.

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

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