Developer Documentation
OpenMesh::Decimater::McDecimaterT< MeshT > Class Template Reference

#include <OpenFlipper/libs_required/OpenMesh/src/OpenMesh/Tools/Decimater/McDecimaterT.hh>

Inheritance diagram for OpenMesh::Decimater::McDecimaterT< MeshT >:
OpenMesh::Decimater::BaseDecimaterT< MeshT > OpenMesh::Utils::Noncopyable OpenMesh::Decimater::MixedDecimaterT< MeshT >

Public Types

typedef McDecimaterT< MeshTSelf
 
typedef MeshT Mesh
 
typedef CollapseInfoT< MeshTCollapseInfo
 
typedef ModBaseT< MeshTModule
 
typedef std::vector< Module * > ModuleList
 
typedef ModuleList::iterator ModuleListIterator
 
- Public Types inherited from OpenMesh::Decimater::BaseDecimaterT< MeshT >
typedef BaseDecimaterT< MeshTSelf
 
typedef MeshT Mesh
 
typedef CollapseInfoT< MeshTCollapseInfo
 
typedef ModBaseT< MeshTModule
 
typedef std::vector< Module * > ModuleList
 
typedef ModuleList::iterator ModuleListIterator
 

Public Member Functions

 McDecimaterT (Mesh &_mesh)
 Constructor. More...
 
 ~McDecimaterT ()
 Destructor. More...
 
size_t decimate (size_t _n_collapses, bool _only_selected=false)
 Decimate (perform _n_collapses collapses). Return number of performed collapses. If _n_collapses is not given reduce as much as possible. More...
 
size_t decimate_to (size_t _n_vertices, bool _only_selected=false)
 Decimate the mesh to a desired target vertex complexity. More...
 
size_t decimate_to_faces (size_t _n_vertices=0, size_t _n_faces=0, bool _only_selected=false)
 Attempts to decimate the mesh until a desired vertex or face complexity is achieved. More...
 
size_t decimate_constraints_only (float _factor, bool _only_selected=false)
 
size_t samples ()
 
void set_samples (const size_t _value)
 
- Public Member Functions inherited from OpenMesh::Decimater::BaseDecimaterT< MeshT >
 BaseDecimaterT (Mesh &_mesh)
 
bool initialize ()
 
bool is_initialized () const
 Returns whether decimater has been successfully initialized. More...
 
void info (std::ostream &_os)
 Print information about modules to _os. More...
 
void set_observer (Observer *_o)
 Add observer. More...
 
Observerobserver ()
 Get current observer of a decimater. More...
 
Meshmesh ()
 access mesh. used in modules. More...
 
template<typename _Module >
bool add (ModHandleT< _Module > &_mh)
 add module to decimater More...
 
template<typename _Module >
bool remove (ModHandleT< _Module > &_mh)
 remove module More...
 
template<typename Module >
Modulemodule (ModHandleT< Module > &_mh)
 get module referenced by handle _mh More...
 

Private Attributes

Meshmesh_
 
size_t randomSamples_
 

Additional Inherited Members

- Protected Member Functions inherited from OpenMesh::Decimater::BaseDecimaterT< MeshT >
bool notify_observer (size_t _n_collapses)
 returns false, if abort requested by observer More...
 
void set_uninitialized ()
 Reset the initialized flag, and clear the bmodules_ and cmodule_. More...
 
void update_modules (CollapseInfo &_ci)
 
bool is_collapse_legal (const CollapseInfo &_ci)
 
float collapse_priority (const CollapseInfo &_ci)
 Calculate priority of an halfedge collapse (using the modules) More...
 
void preprocess_collapse (CollapseInfo &_ci)
 Pre-process a collapse. More...
 
void postprocess_collapse (CollapseInfo &_ci)
 Post-process a collapse. More...
 
void set_error_tolerance_factor (double _factor)
 
void reset ()
 

Detailed Description

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

Multiple choice decimater framework

See also
BaseModT, Mesh Decimation Framework

Definition at line 77 of file McDecimaterT.hh.

Member Typedef Documentation

◆ CollapseInfo

template<typename MeshT >
typedef CollapseInfoT<MeshT> OpenMesh::Decimater::McDecimaterT< MeshT >::CollapseInfo

Definition at line 83 of file McDecimaterT.hh.

◆ Mesh

template<typename MeshT >
typedef MeshT OpenMesh::Decimater::McDecimaterT< MeshT >::Mesh

Definition at line 82 of file McDecimaterT.hh.

◆ Module

template<typename MeshT >
typedef ModBaseT<MeshT> OpenMesh::Decimater::McDecimaterT< MeshT >::Module

Definition at line 84 of file McDecimaterT.hh.

◆ ModuleList

template<typename MeshT >
typedef std::vector< Module* > OpenMesh::Decimater::McDecimaterT< MeshT >::ModuleList

Definition at line 85 of file McDecimaterT.hh.

◆ ModuleListIterator

template<typename MeshT >
typedef ModuleList::iterator OpenMesh::Decimater::McDecimaterT< MeshT >::ModuleListIterator

Definition at line 86 of file McDecimaterT.hh.

◆ Self

template<typename MeshT >
typedef McDecimaterT< MeshT > OpenMesh::Decimater::McDecimaterT< MeshT >::Self

Definition at line 81 of file McDecimaterT.hh.

Constructor & Destructor Documentation

◆ McDecimaterT()

template<class Mesh >
OpenMesh::Decimater::McDecimaterT< Mesh >::McDecimaterT ( Mesh _mesh)

Constructor.

Definition at line 76 of file McDecimaterT_impl.hh.

◆ ~McDecimaterT()

Destructor.

Definition at line 91 of file McDecimaterT_impl.hh.

Member Function Documentation

◆ decimate()

template<class Mesh >
size_t OpenMesh::Decimater::McDecimaterT< Mesh >::decimate ( size_t  _n_collapses,
bool  _only_selected = false 
)

Decimate (perform _n_collapses collapses). Return number of performed collapses. If _n_collapses is not given reduce as much as possible.

Parameters
_n_collapsesDesired number of collapses. If zero (default), attempt to do as many collapses as possible.
_only_selectedOnly consider vertices which are selected for decimation
Returns
Number of collapses that were actually performed.
Note
This operation only marks the removed mesh elements for deletion. In order to actually remove the decimated elements from the mesh, a subsequent call to ArrayKernel::garbage_collection() is required.

Definition at line 102 of file McDecimaterT_impl.hh.

◆ decimate_constraints_only()

template<class Mesh >
size_t OpenMesh::Decimater::McDecimaterT< Mesh >::decimate_constraints_only ( float  _factor,
bool  _only_selected = false 
)

Decimate only with constraints, while _factor gives the percentage of the constraints that should be used

Definition at line 369 of file McDecimaterT_impl.hh.

◆ decimate_to()

template<typename MeshT >
size_t OpenMesh::Decimater::McDecimaterT< MeshT >::decimate_to ( size_t  _n_vertices,
bool  _only_selected = false 
)
inline

Decimate the mesh to a desired target vertex complexity.

Parameters
_n_verticesTarget complexity, i.e. desired number of remaining vertices after decimation.
_only_selectedOnly consider vertices which are selected for decimation
Returns
Number of collapses that were actually performed.
Note
This operation only marks the removed mesh elements for deletion. In order to actually remove the decimated elements from the mesh, a subsequent call to ArrayKernel::garbage_collection() is required.

Definition at line 122 of file McDecimaterT.hh.

◆ decimate_to_faces()

template<class Mesh >
size_t OpenMesh::Decimater::McDecimaterT< Mesh >::decimate_to_faces ( size_t  _n_vertices = 0,
size_t  _n_faces = 0,
bool  _only_selected = false 
)

Attempts to decimate the mesh until a desired vertex or face complexity is achieved.

Parameters
_n_verticesTarget vertex complexity.
_n_facesTarget face complexity.
_only_selectedOnly consider vertices which are selected for decimation
Returns
Number of collapses that were actually performed.
Note
Decimation stops as soon as either one of the two complexity bounds is satisfied.
This operation only marks the removed mesh elements for deletion. In order to actually remove the decimated elements from the mesh, a subsequent call to ArrayKernel::garbage_collection() is required.

Definition at line 226 of file McDecimaterT_impl.hh.

◆ samples()

template<typename MeshT >
size_t OpenMesh::Decimater::McDecimaterT< MeshT >::samples ( )
inline

Definition at line 149 of file McDecimaterT.hh.

◆ set_samples()

template<typename MeshT >
void OpenMesh::Decimater::McDecimaterT< MeshT >::set_samples ( const size_t  _value)
inline

Definition at line 150 of file McDecimaterT.hh.

Member Data Documentation

◆ mesh_

template<typename MeshT >
Mesh& OpenMesh::Decimater::McDecimaterT< MeshT >::mesh_
private

Definition at line 156 of file McDecimaterT.hh.

◆ randomSamples_

template<typename MeshT >
size_t OpenMesh::Decimater::McDecimaterT< MeshT >::randomSamples_
private

Definition at line 158 of file McDecimaterT.hh.


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