Aded multiple choice decimater (~4 times faster than the heap one)

git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@644 fdac6126-5c0c-442c-9429-916003d36597

src/OpenMesh/Tools/Decimater/DecimaterT.cc

@@ -211,12 +211,10 @@ bool DecimaterT<Mesh>::is_collapse_legal(const CollapseInfo& _ci) {
   // locked ? deleted ?
   if (mesh_.status(_ci.v0).locked() || mesh_.status(_ci.v0).deleted())
     return false;
-  /*
-   if (!mesh_.is_collapse_ok(_ci.v0v1))
-   {
-   return false;
-   }
-   */
+
+  if (!mesh_.is_collapse_ok(_ci.v0v1))
+    return false;
+
   if (_ci.vl.is_valid() && _ci.vr.is_valid()
       && mesh_.find_halfedge(_ci.vl, _ci.vr).is_valid()
       && mesh_.valence(_ci.vl) == 3 && mesh_.valence(_ci.vr) == 3) {

src/OpenMesh/Tools/Decimater/DecimaterT.hh

@@ -128,7 +128,7 @@ public: //--------------------------------------------------- module management
     all_modules_.push_back( _mh.module() );
 
     set_uninitialized();
-    
+
     return true;
   }
 
@@ -280,7 +280,7 @@ private: //------------------------------------------------------- private data
 
   // list of all allocated modules (including cmodule_ and all of bmodules_)
   ModuleList all_modules_;
-    
+
   bool       initialized_;
 
 

src/OpenMesh/Tools/Decimater/McDecimaterT.cc

+/*===========================================================================*\
+ *                                                                           *
+ *                               OpenMesh                                    *
+ *      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen      *
+ *                           www.openmesh.org                                *
+ *                                                                           *
+ *---------------------------------------------------------------------------* 
+ *  This file is part of OpenMesh.                                           *
+ *                                                                           *
+ *  OpenMesh is free software: you can redistribute it and/or modify         * 
+ *  it under the terms of the GNU Lesser General Public License as           *
+ *  published by the Free Software Foundation, either version 3 of           *
+ *  the License, or (at your option) any later version with the              *
+ *  following exceptions:                                                    *
+ *                                                                           *
+ *  If other files instantiate templates or use macros                       *
+ *  or inline functions from this file, or you compile this file and         *
+ *  link it with other files to produce an executable, this file does        *
+ *  not by itself cause the resulting executable to be covered by the        *
+ *  GNU Lesser General Public License. This exception does not however       *
+ *  invalidate any other reasons why the executable file might be            *
+ *  covered by the GNU Lesser General Public License.                        *
+ *                                                                           *
+ *  OpenMesh is distributed in the hope that it will be useful,              *
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
+ *  GNU Lesser General Public License for more details.                      *
+ *                                                                           *
+ *  You should have received a copy of the GNU LesserGeneral Public          *
+ *  License along with OpenMesh.  If not,                                    *
+ *  see <http://www.gnu.org/licenses/>.                                      *
+ *                                                                           *
+ \*===========================================================================*/
+
+/*===========================================================================*\
+ *                                                                           *             
+ *   $Revision: 460 $                                                         *
+ *   $Date: 2011-11-16 10:45:08 +0100 (Mi, 16 Nov 2011) $                   *
+ *                                                                           *
+ \*===========================================================================*/
+
+/** \file McDecimaterT.cc
+ */
+
+//=============================================================================
+//
+//  CLASS McDecimaterT - IMPLEMENTATION
+//
+//=============================================================================
+#define OPENMESH_MULTIPLE_CHOICE_DECIMATER_DECIMATERT_CC
+
+//== INCLUDES =================================================================
+
+#include <OpenMesh/Tools/Decimater/McDecimaterT.hh>
+
+#include <vector>
+#if defined(OM_CC_MIPS)
+#  include <float.h>
+#else
+#  include <cfloat>
+#endif
+
+//== NAMESPACE ===============================================================
+
+namespace OpenMesh {
+namespace Decimater {
+
+//== IMPLEMENTATION ==========================================================
+
+template<class Mesh>
+McDecimaterT<Mesh>::McDecimaterT(Mesh& _mesh) :
+    mesh_(_mesh), cmodule_(NULL), initialized_(false),randomSamples_(10) {
+
+  // default properties
+  mesh_.request_vertex_status();
+  mesh_.request_halfedge_status();
+  mesh_.request_edge_status();
+  mesh_.request_face_status();
+  mesh_.request_face_normals();
+
+}
+
+//-----------------------------------------------------------------------------
+
+template<class Mesh>
+McDecimaterT<Mesh>::~McDecimaterT() {
+  // default properties
+  mesh_.release_vertex_status();
+  mesh_.release_edge_status();
+  mesh_.release_halfedge_status();
+  mesh_.release_face_status();
+  mesh_.release_face_normals();
+
+  // dispose of modules
+  {
+    set_uninitialized();
+    typename ModuleList::iterator m_it, m_end = all_modules_.end();
+    for (m_it = all_modules_.begin(); m_it != m_end; ++m_it)
+      delete *m_it;
+    all_modules_.clear();
+  }
+}
+
+//-----------------------------------------------------------------------------
+
+template<class Mesh>
+void McDecimaterT<Mesh>::info(std::ostream& _os) {
+  if (initialized_) {
+    _os << "initialized : yes" << std::endl;
+    _os << "binary modules: " << bmodules_.size() << std::endl;
+    for (ModuleListIterator m_it = bmodules_.begin(); m_it != bmodules_.end();
+        ++m_it) {
+      _os << "  " << (*m_it)->name() << std::endl;
+    }
+    _os << "priority module: " << cmodule_->name().c_str() << std::endl;
+  } else {
+    _os << "initialized : no" << std::endl;
+    _os << "available modules: " << all_modules_.size() << std::endl;
+    for (ModuleListIterator m_it = all_modules_.begin();
+        m_it != all_modules_.end(); ++m_it) {
+      _os << "  " << (*m_it)->name() << " : ";
+      if ((*m_it)->is_binary()) {
+        _os << "binary";
+        if ((*m_it)->name() == "Quadric") {
+          _os << " and priority (special treatment)";
+        }
+      } else {
+        _os << "priority";
+      }
+      _os << std::endl;
+    }
+  }
+}
+
+//-----------------------------------------------------------------------------
+
+template<class Mesh>
+bool McDecimaterT<Mesh>::initialize() {
+  if (initialized_) {
+    return true;
+  }
+
+  // FIXME: quadric module shouldn't be treated specially.
+  // Q: Why?
+  // A: It isn't generic and breaks encapsulation. Also, using string
+  // name comparison is not reliable, since you can't guarantee that
+  // no one else will name their custom module "Quadric".
+  // Q: What should be done instead?
+  // A: ModBaseT API should support modules that can be both binary
+  // and priority, or BETTER YET, let the McDecimaterT API specify the
+  // priority module explicitly.
+
+  // find the priority module: either the only non-binary module in the list, or "Quadric"
+  Module *quadric = NULL;
+  Module *pmodule = NULL;
+  for (ModuleListIterator m_it = all_modules_.begin(), m_end =
+      all_modules_.end(); m_it != m_end; ++m_it) {
+    if ((*m_it)->name() == "Quadric")
+      quadric = *m_it;
+
+    if (!(*m_it)->is_binary()) {
+      if (pmodule) {
+        // only one priority module allowed!
+        set_uninitialized();
+        return false;
+      }
+      pmodule = *m_it;
+    }
+  }
+
+  // Quadric is used as default priority module (even if it is set to be binary)
+  if (!pmodule && quadric) {
+    pmodule = quadric;
+  }
+
+  if (!pmodule) {
+    // At least one priority module required
+    set_uninitialized();
+    return false;
+  }
+
+  // set pmodule as the current priority module
+  cmodule_ = pmodule;
+
+  for (ModuleListIterator m_it = all_modules_.begin(), m_end =
+      all_modules_.end(); m_it != m_end; ++m_it) {
+    // every module gets initialized
+    (*m_it)->initialize();
+
+    if (*m_it != pmodule) {
+      // all other modules are binary, and go into bmodules_ list
+      bmodules_.push_back(*m_it);
+    }
+  }
+
+  return initialized_ = true;
+}
+
+//-----------------------------------------------------------------------------
+
+template<class Mesh>
+bool McDecimaterT<Mesh>::is_collapse_legal(const CollapseInfo& _ci) {
+  //   std::clog << "McDecimaterT<>::is_collapse_legal()\n";
+
+  // locked ? deleted ?
+  if (mesh_.status(_ci.v0).locked() || mesh_.status(_ci.v0).deleted())
+    return false;
+
+  if (!mesh_.is_collapse_ok(_ci.v0v1))
+    return false;
+
+  if (_ci.vl.is_valid() && _ci.vr.is_valid()
+      && mesh_.find_halfedge(_ci.vl, _ci.vr).is_valid()
+      && mesh_.valence(_ci.vl) == 3 && mesh_.valence(_ci.vr) == 3) {
+    return false;
+  }
+  //--- feature test ---
+
+  if (mesh_.status(_ci.v0).feature()
+      && !mesh_.status(mesh_.edge_handle(_ci.v0v1)).feature())
+    return false;
+
+  //--- test one ring intersection ---
+
+  typename Mesh::VertexVertexIter vv_it;
+
+  for (vv_it = mesh_.vv_iter(_ci.v0); vv_it; ++vv_it)
+    mesh_.status(vv_it).set_tagged(false);
+
+  for (vv_it = mesh_.vv_iter(_ci.v1); vv_it; ++vv_it)
+    mesh_.status(vv_it).set_tagged(true);
+
+  for (vv_it = mesh_.vv_iter(_ci.v0); vv_it; ++vv_it)
+    if (mesh_.status(vv_it).tagged() && vv_it.handle() != _ci.vl
+        && vv_it.handle() != _ci.vr)
+      return false;
+
+  // if both are invalid OR equal -> fail
+  if (_ci.vl == _ci.vr)
+    return false;
+
+  //--- test boundary cases ---
+  if (mesh_.is_boundary(_ci.v0)) {
+    if (!mesh_.is_boundary(_ci.v1)) { // don't collapse a boundary vertex to an inner one
+      return false;
+    } else { // edge between two boundary vertices has to be a boundary edge
+      if (!(mesh_.is_boundary(_ci.v0v1) || mesh_.is_boundary(_ci.v1v0)))
+        return false;
+    }
+    // only one one ring intersection
+    if (_ci.vl.is_valid() && _ci.vr.is_valid())
+      return false;
+  }
+
+  // v0vl and v1vl must not both be boundary edges
+  if (_ci.vl.is_valid() && mesh_.is_boundary(_ci.vlv1)
+      && mesh_.is_boundary(_ci.v0vl))
+    return false;
+
+  // v0vr and v1vr must not be both boundary edges
+  if (_ci.vr.is_valid() && mesh_.is_boundary(_ci.vrv0)
+      && mesh_.is_boundary(_ci.v1vr))
+    return false;
+
+  // there have to be at least 2 incident faces at v0
+  if (mesh_.cw_rotated_halfedge_handle(
+      mesh_.cw_rotated_halfedge_handle(_ci.v0v1)) == _ci.v0v1)
+    return false;
+
+  // collapse passed all tests -> ok
+  return true;
+}
+
+//-----------------------------------------------------------------------------
+
+template<class Mesh>
+float McDecimaterT<Mesh>::collapse_priority(const CollapseInfo& _ci) {
+  typename ModuleList::iterator m_it, m_end = bmodules_.end();
+
+  for (m_it = bmodules_.begin(); m_it != m_end; ++m_it) {
+    if ((*m_it)->collapse_priority(_ci) < 0.0)
+      return ModBaseT<McDecimaterT<Mesh> >::ILLEGAL_COLLAPSE;
+  }
+  return cmodule_->collapse_priority(_ci);
+}
+
+//-----------------------------------------------------------------------------
+
+template<class Mesh>
+void McDecimaterT<Mesh>::postprocess_collapse(CollapseInfo& _ci) {
+  typename ModuleList::iterator m_it, m_end = bmodules_.end();
+
+  for (m_it = bmodules_.begin(); m_it != m_end; ++m_it)
+    (*m_it)->postprocess_collapse(_ci);
+
+  cmodule_->postprocess_collapse(_ci);
+}
+
+//-----------------------------------------------------------------------------
+
+template<class Mesh>
+void McDecimaterT<Mesh>::preprocess_collapse(CollapseInfo& _ci) {
+  typename ModuleList::iterator m_it, m_end = bmodules_.end();
+
+  for (m_it = bmodules_.begin(); m_it != m_end; ++m_it)
+    (*m_it)->preprocess_collapse(_ci);
+
+  cmodule_->preprocess_collapse(_ci);
+}
+
+//-----------------------------------------------------------------------------
+template<class Mesh>
+size_t McDecimaterT<Mesh>::decimate(size_t _n_collapses) {
+
+  if (!is_initialized())
+    return 0;
+
+  unsigned int n_collapses(0);
+
+  while ( n_collapses <  _n_collapses) {
+
+    // Optimal id and value will be collected during the random sampling
+    typename Mesh::HalfedgeHandle bestHandle(-1);
+    double bestEnergy = FLT_MAX;
+
+    // Generate random samples for collapses
+    for ( unsigned int i = 0; i < randomSamples_; ++i) {
+
+      // Random halfedge handle
+      typename Mesh::HalfedgeHandle tmpHandle = typename Mesh::HalfedgeHandle(double(rand()) / RAND_MAX * mesh_.n_halfedges() );
+
+      // if it is not deleted, we analyse it
+      if ( ! mesh_.status(tmpHandle).deleted()  ) {
+
+        CollapseInfo ci(mesh_, tmpHandle);
+
+        // Check if legal we analyze the priority of this collapse operation
+        if (is_collapse_legal(ci)) {
+          double energy = collapse_priority(ci);
+
+          // Check if the current samples energy is better than any energy before
+          if ( energy < bestEnergy ) {
+            bestEnergy = energy;
+            bestHandle = tmpHandle;
+          }
+        } else {
+          continue;
+        }
+      }
+
+    }
+
+    // Found the best energy?
+    if ( bestEnergy != FLT_MAX ) {
+
+      // setup collapse info
+      CollapseInfo ci(mesh_, bestHandle);
+
+      // check topological correctness AGAIN !
+      if (!is_collapse_legal(ci))
+        continue;
+
+      // pre-processing
+      preprocess_collapse(ci);
+
+      // perform collapse
+      mesh_.collapse(bestHandle);
+      ++n_collapses;
+
+      // update triangle normals
+      typename Mesh::VertexFaceIter vf_it = mesh_.vf_iter(ci.v1);
+      for (; vf_it; ++vf_it)
+        if (!mesh_.status(vf_it).deleted())
+          mesh_.set_normal(vf_it, mesh_.calc_face_normal(vf_it.handle()));
+
+      // post-process collapse
+      postprocess_collapse(ci);
+
+    }
+
+  }
+
+  // DON'T do garbage collection here! It's up to the application.
+  return n_collapses;
+}
+
+//-----------------------------------------------------------------------------
+
+template<class Mesh>
+size_t McDecimaterT<Mesh>::decimate_to_faces(size_t _nv, size_t _nf) {
+  if (!is_initialized())
+    return 0;
+
+  unsigned int nv = mesh_.n_vertices();
+  unsigned int nf = mesh_.n_faces();
+  unsigned int n_collapses(0);
+
+  while ( (_nv < nv) && (_nf < nf) ) {
+
+    // Optimal id and value will be collected during the random sampling
+    typename Mesh::HalfedgeHandle bestHandle(-1);
+    double bestEnergy = FLT_MAX;
+
+    // Generate random samples for collapses
+    for ( unsigned int i = 0; i < randomSamples_; ++i) {
+
+      // Random halfedge handle
+      typename Mesh::HalfedgeHandle tmpHandle = typename Mesh::HalfedgeHandle(double(rand()) / RAND_MAX * mesh_.n_halfedges() );
+
+      // if it is not deleted, we analyse it
+      if ( ! mesh_.status(tmpHandle).deleted()  ) {
+
+        CollapseInfo ci(mesh_, tmpHandle);
+
+        // Check if legal we analyze the priority of this collapse operation
+        if (is_collapse_legal(ci)) {
+          double energy = collapse_priority(ci);
+
+          // Check if the current samples energy is better than any energy before
+          if ( energy < bestEnergy ) {
+            bestEnergy = energy;
+            bestHandle = tmpHandle;
+          }
+        } else {
+          continue;
+        }
+      }
+
+    }
+
+    // Found the best energy?
+    if ( bestEnergy != FLT_MAX ) {
+
+      // setup collapse info
+      CollapseInfo ci(mesh_, bestHandle);
+
+      // check topological correctness AGAIN !
+      if (!is_collapse_legal(ci))
+        continue;
+
+      // adjust complexity in advance (need boundary status)
+      ++n_collapses;
+
+      // One vertex is killed by the collapse
+      --nv;
+
+      // If we are at a boundary, one face is lost,
+      // otherwise two
+      if (mesh_.is_boundary(ci.v0v1) || mesh_.is_boundary(ci.v1v0))
+        --nf;
+      else
+        nf -= 2;
+
+      // pre-processing
+      preprocess_collapse(ci);
+
+      // perform collapse
+      mesh_.collapse(bestHandle);
+      ++n_collapses;
+
+      // update triangle normals
+      typename Mesh::VertexFaceIter vf_it = mesh_.vf_iter(ci.v1);
+      for (; vf_it; ++vf_it)
+        if (!mesh_.status(vf_it).deleted())
+          mesh_.set_normal(vf_it, mesh_.calc_face_normal(vf_it.handle()));
+
+      // post-process collapse
+      postprocess_collapse(ci);
+
+    }
+
+  }
+
+  // DON'T do garbage collection here! It's up to the application.
+  return n_collapses;
+}
+
+//=============================================================================
+}// END_NS_MC_DECIMATER
+} // END_NS_OPENMESH
+//=============================================================================
+

src/OpenMesh/Tools/Decimater/McDecimaterT.hh

+/*===========================================================================*\
+ *                                                                           *
+ *                               OpenMesh                                    *
+ *      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen      *
+ *                           www.openmesh.org                                *
+ *                                                                           *
+ *---------------------------------------------------------------------------* 
+ *  This file is part of OpenMesh.                                           *
+ *                                                                           *
+ *  OpenMesh is free software: you can redistribute it and/or modify         * 
+ *  it under the terms of the GNU Lesser General Public License as           *
+ *  published by the Free Software Foundation, either version 3 of           *
+ *  the License, or (at your option) any later version with the              *
+ *  following exceptions:                                                    *
+ *                                                                           *
+ *  If other files instantiate templates or use macros                       *
+ *  or inline functions from this file, or you compile this file and         *
+ *  link it with other files to produce an executable, this file does        *
+ *  not by itself cause the resulting executable to be covered by the        *
+ *  GNU Lesser General Public License. This exception does not however       *
+ *  invalidate any other reasons why the executable file might be            *
+ *  covered by the GNU Lesser General Public License.                        *
+ *                                                                           *
+ *  OpenMesh is distributed in the hope that it will be useful,              *
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
+ *  GNU Lesser General Public License for more details.                      *
+ *                                                                           *
+ *  You should have received a copy of the GNU LesserGeneral Public          *
+ *  License along with OpenMesh.  If not,                                    *
+ *  see <http://www.gnu.org/licenses/>.                                      *
+ *                                                                           *
+\*===========================================================================*/ 
+
+/*===========================================================================*\
+ *                                                                           *             
+ *   $Revision: 448 $                                                         *
+ *   $Date: 2011-11-04 13:59:37 +0100 (Fr, 04 Nov 2011) $                   *
+ *                                                                           *
+\*===========================================================================*/
+
+/** \file McDecimaterT.hh
+ */
+
+//=============================================================================
+//
+//  CLASS McDecimaterT
+//
+//=============================================================================
+
+#ifndef OPENMESH_MC_DECIMATER_DECIMATERT_HH
+#define OPENMESH_MC_DECIMATER_DECIMATERT_HH
+
+
+//== INCLUDES =================================================================
+
+#include <memory>
+
+#include <OpenMesh/Core/Utils/Property.hh>
+#include <OpenMesh/Tools/Decimater/ModBaseT.hh>
+
+
+
+//== NAMESPACE ================================================================
+
+namespace OpenMesh  {
+namespace Decimater {
+
+
+//== CLASS DEFINITION =========================================================
+
+
+/** Multiple choice decimater framework
+    \see BaseModT, \ref decimater_docu
+*/
+template < typename MeshT >
+class McDecimaterT
+{
+public: //-------------------------------------------------------- public types
+
+  typedef McDecimaterT< MeshT >         Self;
+  typedef MeshT                         Mesh;
+  typedef CollapseInfoT<MeshT>          CollapseInfo;
+  typedef ModBaseT<Self>                Module;
+  typedef std::vector< Module* >        ModuleList;
+  typedef typename ModuleList::iterator ModuleListIterator;
+
+public: //------------------------------------------------------ public methods