1af3dcac53
- add decimater base class git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@645 fdac6126-5c0c-442c-9429-916003d36597
284 lines
9.4 KiB
C++
284 lines
9.4 KiB
C++
/*===========================================================================*\
|
|
* *
|
|
* 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$ *
|
|
* $Date$ *
|
|
* *
|
|
\*===========================================================================*/
|
|
|
|
/** \file ModBaseT.hh
|
|
Base class for all decimation modules.
|
|
*/
|
|
|
|
//=============================================================================
|
|
//
|
|
// 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 =========================================================
|
|
|
|
/** Handle for mesh decimation modules
|
|
\internal
|
|
*/
|
|
|
|
template <typename Module>
|
|
class ModHandleT : private Utils::Noncopyable
|
|
{
|
|
public:
|
|
|
|
typedef ModHandleT<Module> Self;
|
|
typedef Module module_type;
|
|
|
|
public:
|
|
|
|
/// Default constructor
|
|
ModHandleT() : mod_(NULL) {}
|
|
|
|
/// Destructor
|
|
~ModHandleT() { /* don't delete mod_, since handle is not owner! */ }
|
|
|
|
/// Check handle status
|
|
/// \return \c true, if handle is valid, else \c false.
|
|
bool is_valid() const { return mod_ != NULL; }
|
|
|
|
private:
|
|
|
|
#if defined(OM_CC_MSVC)
|
|
friend class BaseDecimaterT;
|
|
#else
|
|
template <typename Mesh> friend class BaseDecimaterT;
|
|
#endif
|
|
|
|
void clear() { mod_ = NULL; }
|
|
void init(Module* _m) { mod_ = _m; }
|
|
Module* module() { return mod_; }
|
|
|
|
|
|
private:
|
|
|
|
Module* mod_;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
//== CLASS DEFINITION =========================================================
|
|
|
|
|
|
|
|
/// Macro that sets up the name() function
|
|
/// \internal
|
|
#define DECIMATER_MODNAME(_mod_name) \
|
|
virtual const std::string& name() const { \
|
|
static std::string _s_modname_(#_mod_name); return _s_modname_; \
|
|
}
|
|
|
|
|
|
/** Convenience macro, to be used in derived modules
|
|
* The macro defines the types
|
|
* - \c Handle, type of the module's handle.
|
|
* - \c Base, type of ModBaseT<>.
|
|
* - \c Mesh, type of the associated mesh passed by the decimater type.
|
|
* - \c CollapseInfo, to your convenience
|
|
* and uses DECIMATER_MODNAME() to define the name of the module.
|
|
*
|
|
* \param Classname The name of the derived class.
|
|
* \param DecimaterT Pass here the decimater type, which is the
|
|
* template parameter passed to ModBaseT.
|
|
* \param Name Give the module a name.
|
|
*/
|
|
#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 =========================================================
|
|
|
|
|
|
/** Base class for all decimation modules.
|
|
|
|
Each module has to implement this interface.
|
|
To build your own module you have to
|
|
-# derive from this class.
|
|
-# create the basic settings with DECIMATING_MODULE().
|
|
-# override collapse_priority(), if necessary.
|
|
-# override initialize(), if necessary.
|
|
-# override postprocess_collapse(), if necessary.
|
|
|
|
A module has two major working modes:
|
|
-# binary mode
|
|
-# non-binary mode
|
|
|
|
In the binary mode collapse_priority() checks a constraint and
|
|
returns LEGAL_COLLAPSE or ILLEGAL_COLLAPSE.
|
|
|
|
In the non-binary mode the module computes a float error value in
|
|
the range [0, inf) and returns it. In the case a constraint has
|
|
been set, e.g. the error must be lower than a upper bound, and the
|
|
constraint is violated, collapse_priority() must return
|
|
ILLEGAL_COLLAPSE.
|
|
|
|
\see collapse_priority()
|
|
|
|
\todo "Tutorial on building a custom decimation module."
|
|
|
|
*/
|
|
|
|
template <typename MeshT>
|
|
class ModBaseT
|
|
{
|
|
public:
|
|
typedef MeshT Mesh;
|
|
typedef CollapseInfoT<MeshT> CollapseInfo;
|
|
|
|
enum {
|
|
ILLEGAL_COLLAPSE = -1, ///< indicates an illegal collapse
|
|
LEGAL_COLLAPSE = 0 ///< indicates a legal collapse
|
|
};
|
|
|
|
protected:
|
|
|
|
/// Default constructor
|
|
/// \see \ref decimater_docu
|
|
ModBaseT(MeshT& _mesh, bool _is_binary)
|
|
: mesh_(_mesh), is_binary_(_is_binary) {}
|
|
|
|
public:
|
|
|
|
/// Virtual desctructor
|
|
virtual ~ModBaseT() { }
|
|
|
|
/// Set module's name (using DECIMATER_MODNAME macro)
|
|
DECIMATER_MODNAME(ModBase);
|
|
|
|
|
|
/// Returns true if criteria returns a binary value.
|
|
bool is_binary(void) const { return is_binary_; }
|
|
|
|
/// Set whether module is binary or not.
|
|
void set_binary(bool _b) { is_binary_ = _b; }
|
|
|
|
|
|
public: // common interface
|
|
|
|
/// Initialize module-internal stuff
|
|
virtual void initialize() { }
|
|
|
|
/** Return collapse priority.
|
|
*
|
|
* In the binary mode collapse_priority() checks a constraint and
|
|
* returns LEGAL_COLLAPSE or ILLEGAL_COLLAPSE.
|
|
*
|
|
* In the non-binary mode the module computes a float error value in
|
|
* the range [0, inf) and returns it. In the case a constraint has
|
|
* been set, e.g. the error must be lower than a upper bound, and the
|
|
* constraint is violated, collapse_priority() must return
|
|
* ILLEGAL_COLLAPSE.
|
|
*
|
|
* \return Collapse priority in the range [0,inf),
|
|
* \c LEGAL_COLLAPSE or \c ILLEGAL_COLLAPSE.
|
|
*/
|
|
virtual float collapse_priority(const CollapseInfoT<MeshT>& /* _ci */)
|
|
{ return LEGAL_COLLAPSE; }
|
|
|
|
/** Before _from_vh has been collapsed into _to_vh, this method
|
|
will be called.
|
|
*/
|
|
virtual void preprocess_collapse(const CollapseInfoT<MeshT>& /* _ci */)
|
|
{}
|
|
|
|
/** After _from_vh has been collapsed into _to_vh, this method
|
|
will be called.
|
|
*/
|
|
virtual void postprocess_collapse(const CollapseInfoT<MeshT>& /* _ci */)
|
|
{}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
/// Access the mesh associated with the decimater.
|
|
MeshT& mesh() { return mesh_; }
|
|
|
|
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
|
|
//=============================================================================
|
|
|