Pixyco-XYZ/openmesh
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated the documentation for the improved iterators and circulators

Browse Source 
git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@915 fdac6126-5c0c-442c-9429-916003d36597
This commit is contained in:
Isaak Lim
2013-08-08 09:22:50 +00:00
parent fe809dd665
commit 7bababee5c
4 changed files with 49 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
Doc/mesh.docu
View File

@@ -744,16 +744,16 @@ The corresponding \c const counterparts are
\arg \c ConstFaceIter.
The linear iterators are (almost) conformant to STL iterators. For a
The linear iterators are conformant to STL iterators. For a
description of their interface see OpenMesh::Concepts::IteratorT.
For efficiency reasons the \c operation++(int) (post-increment)
and \c operation--(int) (post-decrement) are not implemented.
Hence, when using iterators, use the pre-increment operation
(++it).
Additionally to the standard operations, each linear iterator
provides a method \c handle(), which returns the handle of the
item referred to by the iterator.
When using iterators, use the pre-increment operation (++it) for efficiency
reasons.
\deprecated
While it is possible to use \c handle() to get the handle of the item referred
to by the iterator, this function is deprecated. Simply dereference the iterator
instead.
\subsection deletedElements Deleted Elements
If no elements of a mesh are marked as deleted, the indices provided by \c idx()
@@ -842,9 +842,10 @@ All circulators provide the operations listed in
CirculatorT<Mesh>, which are basically the same as the
iterator funtions.
Furthermore, circulators provide \c operator \c bool(), which returns
true, as long as the circulator hasn't reached the end of the
sequence.
\deprecated
While it is possible to use \c operator \c bool(), which returns true, as long
as the circulator hasn't reached the end of the sequence, this function is
deprecated. Use the function \c is_valid() instead.
%OpenMesh provides the following functions (defined in OpenMesh::PolyConnectivity)
to get circulators around a specified center item:
@@ -889,7 +890,7 @@ MyMesh mesh;
MyMesh::FaceHalfedgeIter fh_it = mesh.fh_iter(faceHandle);
for(; fh_it; ++fh_it) {
for(; fh_it.is_valid(); ++fh_it) {
std::cout << "Halfedge has handle " << *fh_it << std::endl;
}