OpenMesh::Iterators::ConstFaceHalfedgeIterT< 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 const Mesh * mesh_ptr
typedef const Mesh & mesh_ref
typedef const Mesh::Halfedge * pointer
typedef const Mesh::Halfedge & reference
typedef Mesh::HalfedgeHandle value_handle
typedef Mesh::Halfedge value_type

Public Member Functions

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

Protected Attributes

HalfedgeHandle heh_
int lap_counter_
mesh_ptr mesh_
HalfedgeHandle start_

Detailed Description

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

Circulator.

Definition at line 2618 of file CirculatorsT.hh.


Member Typedef Documentation

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

Definition at line 2632 of file CirculatorsT.hh.

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

Definition at line 2625 of file CirculatorsT.hh.

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

Definition at line 2631 of file CirculatorsT.hh.

template<class Mesh>
typedef const Mesh* OpenMesh::Iterators::ConstFaceHalfedgeIterT< Mesh >::mesh_ptr

Definition at line 2634 of file CirculatorsT.hh.

template<class Mesh>
typedef const Mesh& OpenMesh::Iterators::ConstFaceHalfedgeIterT< Mesh >::mesh_ref

Definition at line 2633 of file CirculatorsT.hh.

template<class Mesh>
typedef const Mesh::Halfedge* OpenMesh::Iterators::ConstFaceHalfedgeIterT< Mesh >::pointer

Definition at line 2636 of file CirculatorsT.hh.

template<class Mesh>
typedef const Mesh::Halfedge& OpenMesh::Iterators::ConstFaceHalfedgeIterT< Mesh >::reference

Definition at line 2635 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh::HalfedgeHandle OpenMesh::Iterators::ConstFaceHalfedgeIterT< Mesh >::value_handle

Definition at line 2628 of file CirculatorsT.hh.

template<class Mesh>
typedef Mesh::Halfedge OpenMesh::Iterators::ConstFaceHalfedgeIterT< Mesh >::value_type

Definition at line 2627 of file CirculatorsT.hh.


Constructor & Destructor Documentation

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

Default constructor.

Definition at line 2649 of file CirculatorsT.hh.

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

Construct with mesh and a typename Mesh::FaceHandle.

Definition at line 2653 of file CirculatorsT.hh.

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

Construct with mesh and start halfedge.

Definition at line 2662 of file CirculatorsT.hh.

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

Copy constructor.

Definition at line 2671 of file CirculatorsT.hh.

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

construct from non-const circulator type

Definition at line 2692 of file CirculatorsT.hh.


Member Function Documentation

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

template<class Mesh>
Mesh::HalfedgeHandle OpenMesh::Iterators::ConstFaceHalfedgeIterT< Mesh >::handle (  )  const [inline]

Return the handle of the current target.

Definition at line 2757 of file CirculatorsT.hh.

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

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

Cast to the handle of the current target.

Definition at line 2764 of file CirculatorsT.hh.

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

Not equal ?

Definition at line 2724 of file CirculatorsT.hh.

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

Return a reference to the current target.

Definition at line 2771 of file CirculatorsT.hh.

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

Pre-Increment (next cw target).

Definition at line 2730 of file CirculatorsT.hh.

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

Pre-Decrement (next ccw target).

Definition at line 2739 of file CirculatorsT.hh.

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

Return a pointer to the current target.

Definition at line 2778 of file CirculatorsT.hh.

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

assign from non-const circulator

Definition at line 2701 of file CirculatorsT.hh.

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

Assignment operator.

Definition at line 2680 of file CirculatorsT.hh.

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

Equal ?

Definition at line 2715 of file CirculatorsT.hh.


Member Data Documentation

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

Definition at line 2798 of file CirculatorsT.hh.

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

Definition at line 2799 of file CirculatorsT.hh.

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

Definition at line 2797 of file CirculatorsT.hh.

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

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