SmartTaggerT.hh

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * 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.              *
 *                                                                           *
\*===========================================================================*/

//=============================================================================
//
//  CLASS SmartTaggerVT
//
//
//   original Author:  David Bommes <bommes@cs.rwth-aachen.de>
//   $Revision$
//   $Author$
//   $Date$
//
//=============================================================================


#ifndef ACG_SMARTTAGGERT_HH
#define ACG_SMARTTAGGERT_HH


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

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


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

#define STV_DEBUG_CHECKS

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

namespace ACG {

//== 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 =========================================================


template <class Mesh, class EHandle, class EPHandle>
class SmartTaggerT
{
public:
   
  SmartTaggerT(Mesh& _mesh, unsigned int _tag_range = 1);
 
  ~SmartTaggerT();

  inline void untag_all();

  inline void untag_all( const unsigned int _new_tag_range);
  
  inline void         set_tag  ( const EHandle _eh, unsigned int _tag = 1);

  inline unsigned int get_tag  ( const EHandle _eh) const;

  inline bool         is_tagged( const EHandle _eh) const;

  inline void         set_tag_range( const unsigned int _tag_range);
  
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 ===========================================================

  // define standard Tagger  
  template< class Mesh>
  class SmartTaggerVT 
    : public SmartTaggerT< Mesh, typename Mesh::VertexHandle, OpenMesh::VPropHandleT<unsigned int> > 
  {
  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 
    : public SmartTaggerT< Mesh, typename Mesh::EdgeHandle, OpenMesh::EPropHandleT<unsigned int> > 
  {
  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 
    : public SmartTaggerT< Mesh, typename Mesh::FaceHandle, OpenMesh::FPropHandleT<unsigned int> > 
  {
  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 
    : public SmartTaggerT< Mesh, typename Mesh::HalfedgeHandle, OpenMesh::HPropHandleT<unsigned int> >
  {
  public:
    typedef SmartTaggerT< Mesh, typename Mesh::HalfedgeHandle, OpenMesh::HPropHandleT<unsigned int> > BaseType;
    SmartTaggerHT(Mesh& _mesh, unsigned int _tag_range = 1): BaseType(_mesh, _tag_range){}
  };


//=============================================================================
} // namespace ACG
//=============================================================================
#if defined(INCLUDE_TEMPLATES) && !defined(ACG_SMARTTAGGERT_C)
#define ACG_SMARTTAGGERT_TEMPLATES
#include "SmartTaggerT.cc"
#endif
//=============================================================================
#endif // ACG_SMARTTAGGERT_HH defined
//=============================================================================