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

Public Member Functions

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

Protected Attributes

HalfedgeHandle heh_
int lap_counter_
mesh_ptr mesh_
HalfedgeHandle start_

Detailed Description

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

Circulator.

Definition at line 3392 of file CirculatorsT.hh.


Member Typedef Documentation

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

Definition at line 3406 of file CirculatorsT.hh.

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

Definition at line 3399 of file CirculatorsT.hh.

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

Definition at line 3405 of file CirculatorsT.hh.

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

Definition at line 3408 of file CirculatorsT.hh.

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

Definition at line 3407 of file CirculatorsT.hh.

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

Definition at line 3410 of file CirculatorsT.hh.

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

Definition at line 3409 of file CirculatorsT.hh.

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

Definition at line 3402 of file CirculatorsT.hh.

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

Definition at line 3401 of file CirculatorsT.hh.


Constructor & Destructor Documentation

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

Default constructor.

Definition at line 3423 of file CirculatorsT.hh.

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

Construct with mesh and a typename Mesh::FaceHandle.

Definition at line 3427 of file CirculatorsT.hh.

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

Construct with mesh and start halfedge.

Definition at line 3436 of file CirculatorsT.hh.

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

Copy constructor.

Definition at line 3445 of file CirculatorsT.hh.

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

construct from non-const circulator type

Definition at line 3466 of file CirculatorsT.hh.


Member Function Documentation

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

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

Return the handle of the current target.

Definition at line 3529 of file CirculatorsT.hh.

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

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

Cast to the handle of the current target.

Definition at line 3536 of file CirculatorsT.hh.

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

Not equal ?

Definition at line 3498 of file CirculatorsT.hh.

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

Return a reference to the current target.

Definition at line 3543 of file CirculatorsT.hh.

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

Pre-Increment (next cw target).

Definition at line 3504 of file CirculatorsT.hh.

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

Pre-Decrement (next ccw target).

Definition at line 3512 of file CirculatorsT.hh.

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

Return a pointer to the current target.

Definition at line 3550 of file CirculatorsT.hh.

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

assign from non-const circulator

Definition at line 3475 of file CirculatorsT.hh.

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

Assignment operator.

Definition at line 3454 of file CirculatorsT.hh.

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

Equal ?

Definition at line 3489 of file CirculatorsT.hh.


Member Data Documentation

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

Definition at line 3570 of file CirculatorsT.hh.

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

Definition at line 3571 of file CirculatorsT.hh.

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

Definition at line 3569 of file CirculatorsT.hh.

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

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