ModBaseT.hh

Go to the documentation of this file.

/* ========================================================================= *
 *                                                                           *
 *                               OpenMesh                                    *
 *           Copyright (c) 2001-2025, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openmesh.org                               *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenMesh.                                            *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * 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 ModBaseT
//
//=============================================================================
 
#ifndef OPENMESH_DECIMATER_MODBASET_HH
#define OPENMESH_DECIMATER_MODBASET_HH
 
 
//== INCLUDES =================================================================
 
#include <OpenMesh/Core/Utils/Noncopyable.hh>
#include <OpenMesh/Tools/Decimater/CollapseInfoT.hh>
#include <string>
 
 
//== NAMESPACE ================================================================
 
namespace OpenMesh  {
namespace Decimater {
 
 
//== FORWARD DECLARATIONS =====================================================
 
template <typename Mesh> class BaseDecimaterT;
 
 
//== CLASS DEFINITION =========================================================
 
template <typename Module>
class ModHandleT : private Utils::Noncopyable
{
public:
 
  typedef ModHandleT<Module> Self;
  typedef Module module_type;
 
public:
 
  ModHandleT() : mod_(nullptr) {}
 
  ~ModHandleT() { /* don't delete mod_, since handle is not owner! */ }
 
  bool is_valid() const { return mod_ != nullptr; }
 
private:
 
#if defined(OM_CC_MSVC)
  friend class BaseDecimaterT;
#else
  template <typename Mesh> friend class BaseDecimaterT;
#endif
 
  void     clear()           { mod_ = nullptr; }
  void     init(Module* _m)  { mod_ = _m;   }
  Module*  module()          { return mod_; }
 
 
private:
 
  Module* mod_;
 
};
 
 
 
 
//== CLASS DEFINITION =========================================================
 
 
 
#define DECIMATER_MODNAME(_mod_name) \
 virtual const std::string& name() const override { \
  static std::string _s_modname_(#_mod_name); return _s_modname_; \
}
 
 
#define DECIMATING_MODULE(Classname, MeshT, Name)       \
  typedef Classname < MeshT >    Self;          \
  typedef OpenMesh::Decimater::ModHandleT< Self >     Handle; \
  typedef OpenMesh::Decimater::ModBaseT< MeshT > Base;   \
  typedef typename Base::Mesh         Mesh;             \
  typedef typename Base::CollapseInfo CollapseInfo;     \
  DECIMATER_MODNAME( Name )
 
 
 
//== CLASS DEFINITION =========================================================
 
 
template <typename MeshT>
class ModBaseT
{
public:
  typedef MeshT Mesh;
  typedef CollapseInfoT<MeshT>                 CollapseInfo;
 
  enum {
    ILLEGAL_COLLAPSE = -1, 
    LEGAL_COLLAPSE   = 0   
  };
 
protected:
 
  ModBaseT(MeshT& _mesh, bool _is_binary)
    : error_tolerance_factor_(1.0), mesh_(_mesh), is_binary_(_is_binary) {}
 
public:
 
  virtual ~ModBaseT() { }
 
  virtual const std::string& name() const { static std::string _s_modname_("ModBase"); return _s_modname_; }
 
 
  bool is_binary(void) const { return is_binary_; }
 
  void set_binary(bool _b)   { is_binary_ = _b; }
 
 
public: // common interface
 
   virtual void initialize() { }
 
   virtual float collapse_priority(const CollapseInfoT<MeshT>& /* _ci */)
   { return LEGAL_COLLAPSE; }
 
   virtual void preprocess_collapse(const CollapseInfoT<MeshT>& /* _ci */)
   {}
 
   virtual void postprocess_collapse(const CollapseInfoT<MeshT>& /* _ci */)
   {}
 
   virtual void set_error_tolerance_factor(double _factor) {
     if (_factor >= 0.0 && _factor <= 1.0)
       error_tolerance_factor_ = _factor;
   }
 
 
protected:
 
  MeshT& mesh() { return mesh_; }
 
  // current percentage of the original constraint
  double error_tolerance_factor_;
 
private:
 
  // hide copy constructor & assignemnt
  ModBaseT(const ModBaseT& _cpy);
  ModBaseT& operator=(const ModBaseT& );
 
  MeshT& mesh_;
 
  bool is_binary_;
};
 
 
//=============================================================================
} // namespace Decimater
} // namespace OpenMesh
//=============================================================================
#endif // OPENMESH_DECIMATER_MODBASE_HH defined
//=============================================================================