#include <libs_required/OpenMesh/src/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.

	DECIMATER_MODNAME (ModBase)
	Set module's name (using DECIMATER_MODNAME macro)

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.

virtual float	collapse_priority (const CollapseInfoT< MeshT > &)

virtual void	preprocess_collapse (const CollapseInfoT< MeshT > &)

virtual void	postprocess_collapse (const CollapseInfoT< MeshT > &)

virtual void	set_error_tolerance_factor (double _factor)

Protected Member Functions
	ModBaseT (MeshT &_mesh, bool _is_binary)

MeshT &	mesh ()
	Access the mesh associated with the decimater.

Protected Attributes
double	error_tolerance_factor_

Private Member Functions
	ModBaseT (const ModBaseT &_cpy)

ModBaseT &	operator= (const ModBaseT &)

Private Attributes
MeshT &	mesh_

bool	is_binary_

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

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 also: collapse_priority()

Todo:: "Tutorial on building a custom decimation module."

Definition at line 197 of file ModBaseT.hh.

Member Enumeration Documentation

template<typename MeshT>

anonymous enum

Enumerator
ILLEGAL_COLLAPSE	indicates an illegal collapse
LEGAL_COLLAPSE	indicates a legal collapse

Definition at line 203 of file ModBaseT.hh.

Constructor & Destructor Documentation

template<typename MeshT>

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

inlineprotected

Default constructor

See also: Mesh Decimation Framework

Definition at line 212 of file ModBaseT.hh.

Member Function Documentation

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.

Definition at line 250 of file ModBaseT.hh.

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.

Definition at line 262 of file ModBaseT.hh.

template<typename MeshT>

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

inlinevirtual

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

Reimplemented in OpenMesh::Decimater::ModAspectRatioT< MeshT >, and OpenMesh::Decimater::ModAspectRatioT< TriMesh >.

Definition at line 256 of file ModBaseT.hh.

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

Definition at line 273 of file ModBaseT.hh.

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

libs_required/OpenMesh/src/OpenMesh/Tools/Decimater/ModBaseT.hh

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

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

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

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