Iterator.hh 3.72 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
#ifndef OPENMESH_PYTHON_ITERATOR_HH
#define OPENMESH_PYTHON_ITERATOR_HH

#include "Python/Bindings.hh"

namespace OpenMesh {
namespace Python {

/**
 * Wrapper for mesh item iterators.
 *
 * This class template is used to wrap mesh item iterators for %Python. It
 * implements %Python's iterator protocol (the magic methods \_\_iter\_\_ and
 * \_\_next\_\_).
 *
 * @tparam Iterator An iterator type.
 * @tparam n_items A member function pointer that points to the mesh function
 * that returns the number of items to iterate over (e.g. n_vertices).
 */
template<class Iterator, size_t (OpenMesh::ArrayKernel::*n_items)() const>
class IteratorWrapperT {
	public:

		/**
		 * Constructor
		 *
		 * @param _mesh The mesh that contains the items to iterate over.
		 * @param _hnd The handle of the first item to iterate over.
		 * @param _skip Specifies if deleted/hidden elements are skipped.
		 */
		IteratorWrapperT(const PolyMesh& _mesh, typename Iterator::value_type _hnd, bool _skip = false) :
			mesh_(_mesh), n_items_(n_items),
			iterator_(_mesh, _hnd, _skip),
			iterator_end_(_mesh, typename Iterator::value_type(int((_mesh.*n_items)()))) {
		}

		/**
		 * Constructor
		 *
		 * @param _mesh The mesh that contains the items to iterate over.
		 * @param _hnd The handle of the first item to iterate over.
		 * @param _skip Specifies if deleted/hidden elements are skipped.
		 */
		IteratorWrapperT(const TriMesh& _mesh, typename Iterator::value_type _hnd, bool _skip = false) :
			mesh_(_mesh), n_items_(n_items),
			iterator_(_mesh, _hnd, _skip),
			iterator_end_(_mesh, typename Iterator::value_type(int((_mesh.*n_items)()))) {
		}

		/**
		 * Implementation of %Python's \_\_iter\_\_ magic method.
		 *
		 * @return This iterator.
		 */
		IteratorWrapperT iter() const {
			return *this;
		}

		/**
		 * Implementation of %Python's \_\_next\_\_ magic method.
		 *
		 * @return The next item. Raises a %Python StopIteration exception if
		 * there are no more items.
		 */
		typename Iterator::value_type next() {
			if (iterator_ != iterator_end_) {
				typename Iterator::value_type res = *iterator_;
				++iterator_;
				return res;
			}
			else {
				PyErr_SetString(PyExc_StopIteration, "No more data.");
				boost::python::throw_error_already_set();
			}
			return typename Iterator::value_type();
		}

		/**
		 * Implementation of %Python's \_\_len\_\_ magic method.
		 *
		 * @return The number of items in the mesh.
		 */
		unsigned int len() const {
			return (mesh_.*n_items_)();
		}

	private:
		const OpenMesh::PolyConnectivity& mesh_;
		size_t (OpenMesh::ArrayKernel::*n_items_)() const;
		Iterator iterator_;
		Iterator iterator_end_;
};

/**
 * Expose an iterator type to %Python.
 *
 * @tparam Iterator An iterator type.
 * @tparam n_items A member function pointer that points to the mesh function
 * that returns the number of items to iterate over (e.g. n_vertices).
 *
 * @param _name The name of the iterator type to be exposed.
 *
 * @note %Iterators are wrapped by IteratorWrapperT before they are exposed to
 * %Python, i.e. they are not exposed directly. This means that iterators
 * that are passed from %Python to C++ are instances of IteratorWrapperT.
 */
template<class Iterator, size_t (OpenMesh::ArrayKernel::*n_items)() const>
void expose_iterator(const char *_name) {
	class_<IteratorWrapperT<Iterator, n_items> >(_name, init<PolyMesh&, typename Iterator::value_type, optional<bool> >())
		.def(init<TriMesh&, typename Iterator::value_type, optional<bool> >())
		.def("__iter__", &IteratorWrapperT<Iterator, n_items>::iter)
		.def("__next__", &IteratorWrapperT<Iterator, n_items>::next)
		.def("__len__", &IteratorWrapperT<Iterator, n_items>::len)
		.def("next", &IteratorWrapperT<Iterator, n_items>::next)
		;
}

} // namespace OpenMesh
} // namespace Python

#endif