diff --git a/Doc/tools.docu b/Doc/tools.docu index 5da44bcd..7ae8c68a 100644 --- a/Doc/tools.docu +++ b/Doc/tools.docu @@ -6,6 +6,7 @@ \li \subpage subdivider_docu \li \subpage vdpm_docu \li \subpage smoother_docu +\li \subpage smarttagger_docu \li Miscellaneous OpenMesh::StripifierT diff --git a/src/OpenMesh/Tools/SmartTagger/SmartTaggerT.hh b/src/OpenMesh/Tools/SmartTagger/SmartTaggerT.hh index accabc8d..fb69f587 100644 --- a/src/OpenMesh/Tools/SmartTagger/SmartTaggerT.hh +++ b/src/OpenMesh/Tools/SmartTagger/SmartTaggerT.hh @@ -80,6 +80,31 @@ template< class Mesh> class SmartTaggerHT; //== CLASS DEFINITION ========================================================= +/** \page smarttagger_docu Smart Tagger + +The smart tagger can be used to tag vertices/halfedges/edges/faces on the mesh. It provides +an O(1) reset function to untag all primitives at once. + +Usage: + +\code +SmartTaggerVT< MeshType > tagger(mesh); + +// Reset tagged flag on all vertices +tagger.untag_all(); + +// Check if something is tagged +bool tag = tagger.is_tagged(vh); + +// Set tagged: +tagger.set_tag(vh); +\endcode + +For details see OpenMesh::SmartTaggerT + +*/ + + /** \brief Smart Tagger * * A tagger class to be used on OpenMesh. It provides an O(1) reset function for the property.