| OpenMesh

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
OpenMesh::Python::CirculatorWrapperT< Circulator, CenterEntityHandle > Class Template Reference

Wrapper for circulators. More...

`#include <Python/Circulator.hh>`

## Public Member Functions
| CirculatorWrapperT (PolyMesh &_mesh, CenterEntityHandle _center)
| Constructor. More...
| CirculatorWrapperT (TriMesh &_mesh, CenterEntityHandle _center)
| Constructor. More...
CirculatorWrapperT | iter () const
| Implementation of Python's __iter__ magic method. More...
Circulator::value_type | next ()
| Implementation of Python's __next__ magic method. More...

## Detailed Description

### template<class Circulator, class CenterEntityHandle>
class OpenMesh::Python::CirculatorWrapperT< Circulator, CenterEntityHandle >

Wrapper for circulators.

This class template is used to wrap circulators for Python. It implements Python's iterator protocol (the magic methods __iter__ and __next__).

Template Parameters

  Circulator | A circulator type.

## Constructor & Destructor Documentation

template<class Circulator, class CenterEntityHandle>

OpenMesh::Python::CirculatorWrapperT< Circulator, CenterEntityHandle >::CirculatorWrapperT | ( | PolyMesh & | _mesh,
|  | CenterEntityHandle | _center
| ) |  |
| inline

Constructor.

Parameters

  _mesh | The mesh that contains the items to iterate over.
  _center | The handle to the center item.

template<class Circulator, class CenterEntityHandle>

OpenMesh::Python::CirculatorWrapperT< Circulator, CenterEntityHandle >::CirculatorWrapperT | ( | TriMesh & | _mesh,
|  | CenterEntityHandle | _center
| ) |  |
| inline

Constructor.

Parameters

  _mesh | The mesh that contains the items to iterate over.
  _center | The handle to the center item.

## Member Function Documentation

template<class Circulator, class CenterEntityHandle>

CirculatorWrapperT OpenMesh::Python::CirculatorWrapperT< Circulator, CenterEntityHandle >::iter | ( |  | ) | const
| inline

Implementation of Python's __iter__ magic method.

Returns
  This circulator.

template<class Circulator, class CenterEntityHandle>

Circulator::value_type OpenMesh::Python::CirculatorWrapperT< Circulator, CenterEntityHandle >::next | ( |  | ) |
| inline

Implementation of Python's __next__ magic method.

Returns
  The next item. Raises a Python StopIteration exception if there are no more items.

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

- Python/Circulator.hh