OpenMesh::Iterators::FaceFaceIterT< 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
 FaceFaceIterT (const FaceFaceIterT &_rhs)
 Copy constructor.
 FaceFaceIterT (mesh_ref _mesh, HalfedgeHandle _heh, bool _end=false)
 Construct with mesh and start halfedge.
 FaceFaceIterT (mesh_ref _mesh, typename Mesh::FaceHandle _start, bool _end=false)
 Construct with mesh and a typename Mesh::FaceHandle.
 FaceFaceIterT ()
 Default constructor.
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 FaceFaceIterT &_rhs) const
 Not equal ?
reference operator* () const
 Return a reference to the current target.
FaceFaceIterToperator++ ()
 Pre-Increment (next cw target).
FaceFaceIterToperator-- ()
 Pre-Decrement (next ccw target).
pointer operator-> () const
 Return a pointer to the current target.
FaceFaceIterToperator= (const FaceFaceIterT< Mesh > &_rhs)
 Assignment operator.
bool operator== (const FaceFaceIterT &_rhs) const
 Equal ?

Protected Attributes

HalfedgeHandle heh_
int lap_counter_
mesh_ptr mesh_
HalfedgeHandle start_

Friends

class ConstFaceFaceIterT< Mesh >

Detailed Description

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

Circulator.

Definition at line 3200 of file CirculatorsT.hh.


Member Typedef Documentation

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

Definition at line 3221 of file CirculatorsT.hh.

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

Definition at line 3207 of file CirculatorsT.hh.

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

Definition at line 3220 of file CirculatorsT.hh.

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

Definition at line 3223 of file CirculatorsT.hh.

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

Definition at line 3222 of file CirculatorsT.hh.

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

Definition at line 3225 of file CirculatorsT.hh.

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

Definition at line 3224 of file CirculatorsT.hh.

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

Definition at line 3210 of file CirculatorsT.hh.

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

Definition at line 3209 of file CirculatorsT.hh.


Constructor & Destructor Documentation

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

Default constructor.

Definition at line 3231 of file CirculatorsT.hh.

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

Construct with mesh and a typename Mesh::FaceHandle.

Definition at line 3235 of file CirculatorsT.hh.

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

Construct with mesh and start halfedge.

Definition at line 3244 of file CirculatorsT.hh.

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

Copy constructor.

Definition at line 3253 of file CirculatorsT.hh.


Member Function Documentation

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

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

Return the handle of the current target.

Definition at line 3337 of file CirculatorsT.hh.

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

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

Cast to the handle of the current target.

Definition at line 3344 of file CirculatorsT.hh.

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

Not equal ?

Definition at line 3306 of file CirculatorsT.hh.

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

Return a reference to the current target.

Definition at line 3351 of file CirculatorsT.hh.

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

Pre-Increment (next cw target).

Definition at line 3312 of file CirculatorsT.hh.

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

Pre-Decrement (next ccw target).

Definition at line 3320 of file CirculatorsT.hh.

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

Return a pointer to the current target.

Definition at line 3358 of file CirculatorsT.hh.

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

Assignment operator.

Definition at line 3262 of file CirculatorsT.hh.

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

Equal ?

Definition at line 3297 of file CirculatorsT.hh.


Friends And Related Function Documentation

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

Definition at line 3292 of file CirculatorsT.hh.


Member Data Documentation

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

Definition at line 3378 of file CirculatorsT.hh.

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

Definition at line 3379 of file CirculatorsT.hh.

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

Definition at line 3377 of file CirculatorsT.hh.

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

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