OpenMesh::Decimater::ModBaseT< MeshT > Class Template Reference

Base class for all decimation modules. More...

#include <OpenMesh/Tools/Decimater/ModBaseT.hh>

Inheritance diagram for OpenMesh::Decimater::ModBaseT< MeshT >:

Public Types
enum	{ ILLEGAL_COLLAPSE = -1 , LEGAL_COLLAPSE = 0 }
typedef MeshT	Mesh
typedef CollapseInfoT< MeshT >	CollapseInfo

Public Member Functions
virtual	~ModBaseT ()
	Virtual desctructor.
virtual const std::string &	name () const
	Set module's name. More...
bool	is_binary (void) const
	Returns true if criteria returns a binary value.
void	set_binary (bool _b)
	Set whether module is binary or not.
virtual void	initialize ()
	Initialize module-internal stuff. More...
virtual float	collapse_priority (const CollapseInfoT< MeshT > &)
	Return collapse priority. More...
virtual void	preprocess_collapse (const CollapseInfoT< MeshT > &)
	Before _from_vh has been collapsed into _to_vh, this method will be called.
virtual void	postprocess_collapse (const CollapseInfoT< MeshT > &)
	After _from_vh has been collapsed into _to_vh, this method will be called. More...
virtual void	set_error_tolerance_factor (double _factor)
	This provides a function that allows the setting of a percentage of the original contraint. More...

Protected Member Functions
	ModBaseT (MeshT &_mesh, bool _is_binary)
	Default constructor. More...
MeshT &	mesh ()
	Access the mesh associated with the decimater.

Protected Attributes
double	error_tolerance_factor_

Detailed Description

template<typename MeshT>
class OpenMesh::Decimater::ModBaseT< MeshT >

Base class for all decimation modules.

Each module has to implement this interface. To build your own module you have to

1. derive from this class.
2. create the basic settings with DECIMATING_MODULE().
3. override collapse_priority(), if necessary.
4. override initialize(), if necessary.
5. override postprocess_collapse(), if necessary.

A module has two major working modes:

1. binary mode
2. 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 also

collapse_priority()

Todo:

"Tutorial on building a custom decimation module."

Member Enumeration Documentation

anonymous enum

template<typename MeshT >

anonymous enum

Enumerator
ILLEGAL_COLLAPSE	indicates an illegal collapse
LEGAL_COLLAPSE	indicates a legal collapse

Constructor & Destructor Documentation

ModBaseT()

template<typename MeshT >

OpenMesh::Decimater::ModBaseT< MeshT >::ModBaseT ( MeshT &  _mesh, bool  _is_binary  )

inlineprotected

Default constructor.

See also

Mesh Decimation Framework

Member Function Documentation

collapse_priority()

template<typename MeshT >

virtual float OpenMesh::Decimater::ModBaseT< MeshT >::collapse_priority ( const CollapseInfoT< MeshT > &  )

inlinevirtual

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.

Returns

Collapse priority in the range [0,inf), LEGAL_COLLAPSE or ILLEGAL_COLLAPSE.

Reimplemented in OpenMesh::Decimater::ModEdgeLengthT< MeshT >, OpenMesh::Decimater::ModHausdorffT< MeshT >, OpenMesh::Decimater::ModNormalDeviationT< MeshT >, OpenMesh::Decimater::ModNormalFlippingT< MeshT >, OpenMesh::Decimater::ModQuadricT< MeshT >, OpenMesh::Decimater::ModQuadricT< D >, and OpenMesh::Decimater::ModRoundnessT< MeshT >.

initialize()

template<typename MeshT >

virtual void OpenMesh::Decimater::ModBaseT< MeshT >::initialize ( void  )

inlinevirtual

Initialize module-internal stuff.

Reimplemented in OpenMesh::Decimater::ModAspectRatioT< MeshT >, OpenMesh::Decimater::ModHausdorffT< MeshT >, OpenMesh::Decimater::ModNormalDeviationT< MeshT >, ModBalancerT< D >, OpenMesh::Decimater::ModQuadricT< MeshT >, and OpenMesh::Decimater::ModQuadricT< D >.

name()

template<typename MeshT >

virtual const std::string & OpenMesh::Decimater::ModBaseT< MeshT >::name ( ) const

inlinevirtual

Set module's name.

Reimplemented in ModBalancerT< D >, OpenMesh::Decimater::ModAspectRatioT< MeshT >, OpenMesh::Decimater::ModEdgeLengthT< MeshT >, OpenMesh::Decimater::ModHausdorffT< MeshT >, OpenMesh::Decimater::ModIndependentSetsT< MeshT >, OpenMesh::Decimater::ModNormalDeviationT< MeshT >, OpenMesh::Decimater::ModNormalFlippingT< MeshT >, OpenMesh::Decimater::ModProgMeshT< MeshT >, OpenMesh::Decimater::ModQuadricT< MeshT >, OpenMesh::Decimater::ModQuadricT< D >, and OpenMesh::Decimater::ModRoundnessT< MeshT >.

postprocess_collapse()

template<typename MeshT >

virtual void OpenMesh::Decimater::ModBaseT< MeshT >::postprocess_collapse ( const CollapseInfoT< MeshT > &  )

inlinevirtual

After _from_vh has been collapsed into _to_vh, this method will be called.

Reimplemented in OpenMesh::Decimater::ModHausdorffT< MeshT >, OpenMesh::Decimater::ModIndependentSetsT< MeshT >, OpenMesh::Decimater::ModNormalDeviationT< MeshT >, OpenMesh::Decimater::ModProgMeshT< MeshT >, OpenMesh::Decimater::ModQuadricT< MeshT >, and OpenMesh::Decimater::ModQuadricT< D >.

set_error_tolerance_factor()

template<typename MeshT >

virtual void OpenMesh::Decimater::ModBaseT< MeshT >::set_error_tolerance_factor ( double  _factor )

inlinevirtual

This provides a function that allows the setting of a percentage of the original contraint.

Note that the module might need to be re-initialized again after setting the percentage

Parameters

_factor

has to be in the closed interval between 0.0 and 1.0

Reimplemented in OpenMesh::Decimater::ModAspectRatioT< MeshT >, OpenMesh::Decimater::ModEdgeLengthT< MeshT >, OpenMesh::Decimater::ModHausdorffT< MeshT >, OpenMesh::Decimater::ModNormalDeviationT< MeshT >, OpenMesh::Decimater::ModNormalFlippingT< MeshT >, OpenMesh::Decimater::ModQuadricT< MeshT >, OpenMesh::Decimater::ModQuadricT< D >, and OpenMesh::Decimater::ModRoundnessT< MeshT >.

---

The documentation for this class was generated from the following file:

• OpenMesh/Tools/Decimater/ModBaseT.hh