Developer Documentation
Public Types | Public Member Functions | Private Attributes | Friends | List of all members
OpenMesh::Iterators::GenericCirculatorT_DEPRECATED< GenericCirculatorT_DEPRECATED_TraitsT > Class Template Reference
Inheritance diagram for OpenMesh::Iterators::GenericCirculatorT_DEPRECATED< GenericCirculatorT_DEPRECATED_TraitsT >:
OpenMesh::Iterators::GenericCirculatorBaseT< GenericCirculatorT_DEPRECATED_TraitsT::Mesh >

Public Types

using Mesh = typename GenericCirculatorT_DEPRECATED_TraitsT::Mesh
 
using CenterEntityHandle = typename GenericCirculatorT_DEPRECATED_TraitsT::CenterEntityHandle
 
using value_type = typename GenericCirculatorT_DEPRECATED_TraitsT::ValueHandle
 
using smart_value_type = decltype(make_smart(std::declval< value_type >(), std::declval< Mesh >()))
 
typedef std::ptrdiff_t difference_type
 
typedef const value_type & reference
 
typedef const smart_value_type * pointer
 
typedef std::bidirectional_iterator_tag iterator_category
 
typedef GenericCirculatorBaseT< Mesh >::mesh_ptr mesh_ptr
 
typedef GenericCirculatorBaseT< Mesh >::mesh_ref mesh_ref
 
typedef GenericCirculator_ValueHandleFnsT_DEPRECATED< Mesh, CenterEntityHandle, value_type > GenericCirculator_ValueHandleFns
 

Public Member Functions

 GenericCirculatorT_DEPRECATED (mesh_ref mesh, CenterEntityHandle start, bool end=false)
 
 GenericCirculatorT_DEPRECATED (mesh_ref mesh, HalfedgeHandle heh, bool end=false)
 
 GenericCirculatorT_DEPRECATED (const GenericCirculatorT_DEPRECATED &rhs)
 
GenericCirculatorT_DEPRECATED & operator++ ()
 
GenericCirculatorT_DEPRECATED & operator-- ()
 
GenericCirculatorT_DEPRECATED operator++ (int)
 Post-increment.
 
GenericCirculatorT_DEPRECATED operator-- (int)
 Post-decrement.
 
smart_value_type operator* () const
 Standard dereferencing operator.
 
pointer operator-> () const
 Pointer dereferentiation. More...
 
GenericCirculatorT_DEPRECATED & operator= (const GenericCirculatorT_DEPRECATED &rhs)
 
bool operator== (const GenericCirculatorT_DEPRECATED &rhs) const
 
bool operator!= (const GenericCirculatorT_DEPRECATED &rhs) const
 
bool is_valid () const
 
const HalfedgeHandle & current_halfedge_handle () const
 
 operator bool () const
 
smart_value_type handle () const
 Return the handle of the current target. More...
 
 operator value_type () const
 Cast to the handle of the current target. More...
 

Private Attributes

smart_value_type pointer_deref_value
 

Friends

template<typename STREAM >
STREAM & operator<< (STREAM &s, const GenericCirculatorT_DEPRECATED &self)
 

Additional Inherited Members

- Protected Types inherited from OpenMesh::Iterators::GenericCirculatorBaseT< GenericCirculatorT_DEPRECATED_TraitsT::Mesh >
typedef const GenericCirculatorT_DEPRECATED_TraitsT::Mesh * mesh_ptr
 
typedef const GenericCirculatorT_DEPRECATED_TraitsT::Mesh & mesh_ref
 
- Protected Member Functions inherited from OpenMesh::Iterators::GenericCirculatorBaseT< GenericCirculatorT_DEPRECATED_TraitsT::Mesh >
 GenericCirculatorBaseT (mesh_ref mesh, HalfedgeHandle heh, bool end=false)
 
 GenericCirculatorBaseT (const GenericCirculatorBaseT &rhs)
 
GenericCirculatorT_DEPRECATED_TraitsT::Mesh ::FaceHandle toFaceHandle () const
 
GenericCirculatorT_DEPRECATED_TraitsT::Mesh ::FaceHandle toOppositeFaceHandle () const
 
GenericCirculatorT_DEPRECATED_TraitsT::Mesh ::EdgeHandle toEdgeHandle () const
 
GenericCirculatorT_DEPRECATED_TraitsT::Mesh ::HalfedgeHandle toHalfedgeHandle () const
 
GenericCirculatorT_DEPRECATED_TraitsT::Mesh ::HalfedgeHandle toOppositeHalfedgeHandle () const
 
GenericCirculatorT_DEPRECATED_TraitsT::Mesh ::VertexHandle toVertexHandle () const
 
GenericCirculatorBaseT & operator= (const GenericCirculatorBaseT &rhs)
 
bool operator== (const GenericCirculatorBaseT &rhs) const
 
bool operator!= (const GenericCirculatorBaseT &rhs) const
 
- Protected Attributes inherited from OpenMesh::Iterators::GenericCirculatorBaseT< GenericCirculatorT_DEPRECATED_TraitsT::Mesh >
mesh_ptr mesh_
 
GenericCirculatorT_DEPRECATED_TraitsT::Mesh ::HalfedgeHandle start_
 
GenericCirculatorT_DEPRECATED_TraitsT::Mesh ::HalfedgeHandle heh_
 
int lap_counter_
 

Detailed Description

template<typename GenericCirculatorT_DEPRECATED_TraitsT>
class OpenMesh::Iterators::GenericCirculatorT_DEPRECATED< GenericCirculatorT_DEPRECATED_TraitsT >

Definition at line 428 of file CirculatorsT.hh.

Member Function Documentation

◆ current_halfedge_handle()

template<typename GenericCirculatorT_DEPRECATED_TraitsT >
const HalfedgeHandle& OpenMesh::Iterators::GenericCirculatorT_DEPRECATED< GenericCirculatorT_DEPRECATED_TraitsT >::current_halfedge_handle ( ) const
inline
Deprecated:
current_halfedge_handle() is an implementation detail and should not be accessed from outside the iterator class.

Definition at line 551 of file CirculatorsT.hh.

◆ handle()

template<typename GenericCirculatorT_DEPRECATED_TraitsT >
smart_value_type OpenMesh::Iterators::GenericCirculatorT_DEPRECATED< GenericCirculatorT_DEPRECATED_TraitsT >::handle ( ) const
inline

Return the handle of the current target.

Deprecated:
This function clutters your code. Use dereferencing operators -> and * instead.

Definition at line 571 of file CirculatorsT.hh.

◆ operator bool()

template<typename GenericCirculatorT_DEPRECATED_TraitsT >
OpenMesh::Iterators::GenericCirculatorT_DEPRECATED< GenericCirculatorT_DEPRECATED_TraitsT >::operator bool ( ) const
inline
Deprecated:
Do not use this error prone implicit cast. Compare to the end-iterator or use is_valid() instead.

Definition at line 561 of file CirculatorsT.hh.

◆ operator value_type()

template<typename GenericCirculatorT_DEPRECATED_TraitsT >
OpenMesh::Iterators::GenericCirculatorT_DEPRECATED< GenericCirculatorT_DEPRECATED_TraitsT >::operator value_type ( ) const
inline

Cast to the handle of the current target.

Deprecated:
Implicit casts of iterators are unsafe. Use dereferencing operators -> and * instead.

Definition at line 582 of file CirculatorsT.hh.

◆ operator->()

template<typename GenericCirculatorT_DEPRECATED_TraitsT >
pointer OpenMesh::Iterators::GenericCirculatorT_DEPRECATED< GenericCirculatorT_DEPRECATED_TraitsT >::operator-> ( ) const
inline

Pointer dereferentiation.

This returns a pointer which points to a handle that loses its validity once this dereferentiation is invoked again. Thus, do not store the result of this operation.

Definition at line 523 of file CirculatorsT.hh.

The documentation for this class was generated from the following file: