Added some more explanations about the change of API

This commit is contained in:
Mael Rouxel-Labbé 2017-05-16 17:26:44 +02:00
parent ebd4e749df
commit ac05b500dc
2 changed files with 18 additions and 3 deletions

View File

@ -170,13 +170,23 @@ and <code>src/</code> directories).
<h3>Triangulated Surface Mesh Parameterization</h3>
<ul>
<li>
<b>Breaking change</b>: The package has been restructured and rewritten and
<b>Breaking change</b>: The package has been rewritten and
can operate on any model of the <code>MutableFaceGraph</code> concept. All
previous parameterization methods are still offered, although with a slightly
different API. Include headers have also be moved.
previous parameterization methods are still offered, although with a
different, simpler API.
The documentation has been updated and offers a gentle introduction to the new API.
Users who wish to use the former API must use a version prior to 4.11.
</li>
<li>
<b>Breaking change</b>:
The adapter to add virtual seams is now the class <code>CGAL::Seam_mesh</code>
in the package <em>CGAL and the BGL</em>.
</li>
<li>
<b>Breaking change</b>: The package has been restructured and most headers
have been moved. In a general manner, users should replace <code>&lt;CGAL/XXX.h&gt;</code>
with <code>&lt;CGAL/Surface_mesh_parameterization/XXX.h&gt;</code>
</li>
<li>
Add the <em>As Rigid As Possible Parameterization</em> method. This parameterization
allows the user to prioritize angle preservation, shape preservation, or a balance of both.

View File

@ -10,6 +10,11 @@ namespace CGAL {
\authors Laurent Saboret, Pierre Alliez, Bruno L&eacute;vy, Andreas Fabri, and
Mael Rouxel-Labbé
\warning The API and structure of this package have greatly changed with CGAL 4.11.
Users who wish to use the former API must use a version prior to 4.11</li>.
Section \ref Surface_mesh_parameterizationBasics gives a gentle introduction to
the new, much simpler, API.
\section Surface_mesh_parameterizationIntroduction Introduction
Parameterizing a surface amounts to finding a one-to-one mapping from