wip doc tetrahedral remeshing

This commit is contained in:
Jane Tournois 2019-10-03 15:36:29 +02:00
parent 0555674a97
commit e7c3ecc3c3
3 changed files with 93 additions and 0 deletions

View File

@ -3045,6 +3045,14 @@ pages = "207--221"
year={2012},
organization={Wiley Online Library}
}
@article{faraj2016mvr,
author = {Noura Faraj and Jean-Marc Thiery and Tamy Boubekeur},
title = {Multi-Material Adaptive Volume Remesher},
journal = {Compurer and Graphics Journal (proc. Shape Modeling International 2016)},
year = {2016},
}
% ----------------------------------------------------------------------------
% END OF BIBFILE
% ----------------------------------------------------------------------------

View File

@ -0,0 +1,56 @@
// Tetrahedral Remeshing
/// \defgroup PkgTetrahedralRemeshingRef Tetrahedral Remeshing Reference
/// \defgroup PkgTetrahedralRemeshingConcepts Concepts
/// \ingroup PkgTetrahedralRemeshingRef
/// \defgroup PkgPACKAGEAlgorithmFunctions Remeshing Function
/// \ingroup PkgPACKAGE
/// \defgroup PkgPACKAGETraitsClasses Traits Classes
/// \ingroup PkgPACKAGE
/// \defgroup PkgPACKAGEMiscellaneous Miscellaneous
/// \ingroup PkgPACKAGE
/*!
\addtogroup PkgTetrahedralRemeshingRef
\todo check generated documentation
\todo add pkg-small.png
\cgalPkgDescriptionBegin{Tetrahedral Remeshing,PkgTetrahedralRemeshing}
\cgalPkgPicture{pkg-small.png}
\cgalPkgSummaryBegin
\cgalPkgAuthors{Jane Tournois, Noura Faraj}
\cgalPkgDesc{PACKAGE DESCRIPTION.
The package provides a function for remeshing of tetrahedral meshes,
targetting high quality meshes with respect to dihedral angles.}
\cgalPkgManuals{Chapter_3D_Mesh_Generation,PkgTetrahedralRemeshingRef}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{5.0}
\cgalPkgDependsOn{\ref PkgTriangulation3}
\cgalPkgBib{faraj2016mvr}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyhedron demo,polyhedron_3.zip}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
\cgalCRPSection{Concepts}
Here are the main concepts of this package:
- `RemeshingTriangulation_3`
- `RemeshingCellBase_3`
- `RemeshingVertexBase_3`
\cgalCRPSection{Function Templates}
- `CGAL::tetrahedral_adaptive_remeshing()`
*/

View File

@ -0,0 +1,29 @@
namespace CGAL {
/*!
\mainpage User Manual
\anchor Chapter_Tetrahedral_Remeshing
\anchor userchaptertetrahedralremeshing
\authors Jane Tournois, Noura Faraj
\cgalAutoToc
This chapter describes the tetrahedral remeshing algorithm...
\section secmydefinitions Definitions
Section on definitions here ...
\section secmyexamples Examples
\subsection myFirstExample First Example
The following example shows ...
\cgalExample{ }
\cgalFigureBegin{figPck,bench.png}
Left: ...
\cgalFigureEnd
*/
} /* namespace CGAL */