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

Document behaviour of circulators on deleted elements

Browse Source 
git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@426 fdac6126-5c0c-442c-9429-916003d36597
This commit is contained in:
Jan Möbius
2011-10-10 12:52:28 +00:00
parent cc7141f28e
commit 1d363599e9
2 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Doc/mesh.docu
View File

@@ -840,7 +840,7 @@ to get circulators around a specified center item:
\include circulator_functions.cc
Note that for every circulator there also exists a constant version.
\note For every circulator there also exists a constant version.
To make use of these constant circulators just add the prefix<br />
"Const" to the type specifier and add the prefix "c" to the function used to request
the circulator of an item. Example:<br/>
@@ -849,6 +849,16 @@ the circulator of an item. Example:<br/>
ConstVertexVertexIter cvvit = mesh.cvv_iter(some_vertex_handle);
\endcode
\note When constructing Circulators from iterators, make sure you don't create
a circulator of an deleted element(e.g. FaceVertexiter of a deleted Face), as
this will lead to unpredictable behaviour. Using skipping iterators for iterating over
the elements and creating circulators from them is safe as they don't contain
deleted elements.
\code
\endcode
\section it_circs_h How to use circulators in OpenMesh
The following code example now shows how to enumerate the 1-ring of each vertex: