diff --git a/Doc/smoother.docu b/Doc/smoother.docu new file mode 100644 index 00000000..2e5797d5 --- /dev/null +++ b/Doc/smoother.docu @@ -0,0 +1,54 @@ +//----------------------------------------------------------------------------- + +/** \page smoother_docu Smoother Tools + +\section OM_Smoother_Overview Overview + +The %OpenMesh library provides tools for smoothing Triangle- and Polymeshes + +-# Smoother: + -# OpenMesh::Smoother::SmootherT + -# OpenMesh::Smoother::LaplaceSmootherT + -# OpenMesh::Smoother::JacobiLaplaceSmootherT + +\section OM_Smoother_Usage Usage +The smoothers directly work on an OpenMesh. The following example shows how to use them: + +\code + #include + + // Initialize smoother with input mesh + OpenMesh::Smoother::SmootherT smoother(mesh); + + smoother.initialize( C0, //Continuity + Tangential_and_Normal) //Smooth direction + + // Execute 3 smooth steps + smoother.smooth(3); +\endcode + +\section Options + +\subsection Continuity +\li C0: shape is continuous, but not the tangent +\li C1: shape and tangent are continuous +\li C2: preserves curvature + +\subsection Component +\li Tangential: Smooth in tangential direction +\li Normal: Smooth in normal direction +\li Tangential_and_Normal: Smooth in tangential and normal direction + +\subsection localError Local Error +By default, this option is disabled. +You can set local max. local errors (absolute or relative) via following functions: +\code + void OpenMesh::Smoother::SmootherT::set_relative_local_error(Scalar _err); + void OpenMesh::Smoother::SmootherT::set_absolute_local_error(Scalar _err); + void OpenMesh::Smoother::SmootherT::disable_local_error_check(); +\endcode + + +*/ + +//----------------------------------------------------------------------------- diff --git a/Doc/tools.docu b/Doc/tools.docu index 6e0f4745..5da44bcd 100644 --- a/Doc/tools.docu +++ b/Doc/tools.docu @@ -5,6 +5,7 @@ \li \subpage decimater_docu \li \subpage subdivider_docu \li \subpage vdpm_docu +\li \subpage smoother_docu \li Miscellaneous OpenMesh::StripifierT