SmartTaggerT.hh 8.37 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1
/* ========================================================================= *
Jan Möbius's avatar
Jan Möbius committed
2
 *                                                                           *
Jan Möbius's avatar
Jan Möbius committed
3
 *                               OpenMesh                                    *
Jan Möbius's avatar
Jan Möbius committed
4 5 6
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
Jan Möbius's avatar
Jan Möbius committed
7
 *                            www.openmesh.org                               *
Jan Möbius's avatar
Jan Möbius committed
8 9
 *                                                                           *
 *---------------------------------------------------------------------------*
Jan Möbius's avatar
Jan Möbius committed
10
 * This file is part of OpenMesh.                                            *
Jan Möbius's avatar
Jan Möbius committed
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
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
 *                                                                           *
Jan Möbius's avatar
Jan Möbius committed
40
 * ========================================================================= */
Jan Möbius's avatar
Jan Möbius committed
41

Jan Möbius's avatar
Jan Möbius committed
42
#pragma once
Jan Möbius's avatar
Jan Möbius committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57


//== INCLUDES =================================================================

// OpenMesh
#include <OpenMesh/Core/Utils/Property.hh>
#include <OpenMesh/Core/System/omstream.hh>


//== DEFINES ==================================================================

#define STV_DEBUG_CHECKS

//== NAMESPACES ===============================================================

Jan Möbius's avatar
Jan Möbius committed
58
namespace OpenMesh {
Jan Möbius's avatar
Jan Möbius committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74

//== FORWARD DECLARATIONS =====================================================

// Smarttagging for vertices
template< class Mesh> class SmartTaggerVT;
// Smarttagging for edges
template< class Mesh> class SmartTaggerET;
// Smarttagging for faces
template< class Mesh> class SmartTaggerFT;
// Smarttagging for halfedges
template< class Mesh> class SmartTaggerHT;


//== CLASS DEFINITION =========================================================


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
/** \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

*/


Jan Möbius's avatar
Jan Möbius committed
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
/** \brief Smart Tagger
 *
 * A tagger class to be used on OpenMesh. It provides an O(1) reset function for the property.
 * - Smarttagging for vertices:  SmartTaggerVT;
 * - Smarttagging for edges:     SmartTaggerET;
 * - Smarttagging for faces:     SmartTaggerFT;
 * - Smarttagging for halfedges: SmartTaggerHT;
 *
 * Usage:
 *
 * \code
 * SmartTaggerVT< MeshType >* tagger = new SmartTaggerVT< MeshType > (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
 */
template <class Mesh, class EHandle, class EPHandle>
class SmartTaggerT
{
public:
   
  /// Constructor
  SmartTaggerT(Mesh& _mesh, unsigned int _tag_range = 1);
 
  /// Destructor
  ~SmartTaggerT();

  /** \brief untag all elements
   *
   */
  inline void untag_all();

  /** \brief untag all elements and set new tag_range
   *
   * @param _new_tag_range  New tag range of the tagger
   */
  inline void untag_all( const unsigned int _new_tag_range);
  
  /** \brief set tag to a value in [0..tag_range]
   *
   * @param _eh  Edge handle for the tag
   * @param _tag Tag value
   */
150
  inline void set_tag  ( const EHandle _eh, unsigned int _tag = 1);
Jan Möbius's avatar
Jan Möbius committed
151 152 153 154 155 156 157 158 159 160 161 162 163

  /** \brief get tag value in range [0..tag_range]
   *
   * @param _eh  Edge handle for the tag
   * @return Current tag value at that edge
   */
  inline unsigned int get_tag  ( const EHandle _eh) const;

  /** \brief  overloaded member for boolean tags
   *
   * @param _eh Edge handle for the tag
   * @return Current tag value at that edge
   */
164
  inline bool is_tagged( const EHandle _eh) const;
Jan Möbius's avatar
Jan Möbius committed
165 166 167 168 169 170 171

  /** \brief set new tag range and untag_all
   *
   * Set new tag range and reset tagger
   *
   * @param _tag_range  New tag range of the tagger
   */
172
  inline void set_tag_range( const unsigned int _tag_range);
Jan Möbius's avatar
Jan Möbius committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
  
protected:

  inline void all_tags_to_zero();

protected:

  // Reference to Mesh
  Mesh& mesh_;

  // property which holds the current tags
  EPHandle ep_tag_;

  // current tags range is [current_base_+1...current_base_+tag_range_]
  unsigned int current_base_;

  // number of different tagvalues available
  unsigned int tag_range_;
};


//== SPECIALIZATION ===========================================================

Jan Möbius's avatar
Jan Möbius committed
196 197 198
// define standard Tagger
template< class Mesh>
class SmartTaggerVT
Jan Möbius's avatar
Jan Möbius committed
199
    : public SmartTaggerT< Mesh, typename Mesh::VertexHandle, OpenMesh::VPropHandleT<unsigned int> > 
Jan Möbius's avatar
Jan Möbius committed
200 201 202 203 204 205 206 207
{
public:
  typedef SmartTaggerT< Mesh, typename Mesh::VertexHandle, OpenMesh::VPropHandleT<unsigned int> > BaseType;
  SmartTaggerVT(Mesh& _mesh, unsigned int _tag_range = 1) : BaseType(_mesh, _tag_range) {}
};

template< class Mesh>
class SmartTaggerET
Jan Möbius's avatar
Jan Möbius committed
208
    : public SmartTaggerT< Mesh, typename Mesh::EdgeHandle, OpenMesh::EPropHandleT<unsigned int> > 
Jan Möbius's avatar
Jan Möbius committed
209 210 211 212 213 214 215 216
{
public:
  typedef SmartTaggerT< Mesh, typename Mesh::EdgeHandle, OpenMesh::EPropHandleT<unsigned int> > BaseType;
  SmartTaggerET(Mesh& _mesh, unsigned int _tag_range = 1) : BaseType(_mesh, _tag_range) {}
};

template< class Mesh>
class SmartTaggerFT
Jan Möbius's avatar
Jan Möbius committed
217
    : public SmartTaggerT< Mesh, typename Mesh::FaceHandle, OpenMesh::FPropHandleT<unsigned int> > 
Jan Möbius's avatar
Jan Möbius committed
218 219 220 221 222 223 224 225
{
public:
  typedef SmartTaggerT< Mesh, typename Mesh::FaceHandle, OpenMesh::FPropHandleT<unsigned int> > BaseType;
  SmartTaggerFT(Mesh& _mesh, unsigned int _tag_range = 1): BaseType(_mesh, _tag_range) {}
};

template< class Mesh>
class SmartTaggerHT
Jan Möbius's avatar
Jan Möbius committed
226
    : public SmartTaggerT< Mesh, typename Mesh::HalfedgeHandle, OpenMesh::HPropHandleT<unsigned int> >
Jan Möbius's avatar
Jan Möbius committed
227 228 229 230 231
{
public:
  typedef SmartTaggerT< Mesh, typename Mesh::HalfedgeHandle, OpenMesh::HPropHandleT<unsigned int> > BaseType;
  SmartTaggerHT(Mesh& _mesh, unsigned int _tag_range = 1): BaseType(_mesh, _tag_range){}
};
Jan Möbius's avatar
Jan Möbius committed
232 233 234


//=============================================================================
Jan Möbius's avatar
Jan Möbius committed
235
} // namespace OpenMesh
Jan Möbius's avatar
Jan Möbius committed
236
//=============================================================================
Jan Möbius's avatar
Jan Möbius committed
237 238
#if defined(OM_INCLUDE_TEMPLATES) && !defined(OPENMESH_SMARTTAGGERT_C)
#define OPENMESH_SMARTTAGGERT_TEMPLATES
239
#include "SmartTaggerT_impl.hh"
Jan Möbius's avatar
Jan Möbius committed
240 241
#endif