From c4ab20e8b22846094b17d33e729b47dc5e9d0d35 Mon Sep 17 00:00:00 2001 From: Dmitry Anisimov Date: Mon, 31 May 2021 11:18:53 +0200 Subject: [PATCH] better user manual --- Weights/doc/Weights/Weights.txt | 12 ++++++------ Weights/examples/Weights/projection_traits.cpp | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Weights/doc/Weights/Weights.txt b/Weights/doc/Weights/Weights.txt index 43cf89c3e3c..3e968a7967c 100644 --- a/Weights/doc/Weights/Weights.txt +++ b/Weights/doc/Weights/Weights.txt @@ -182,11 +182,11 @@ The used type of barycentric weights is `Wachspress_weights_2`. \subsection Weights_Examples_ProjectionTraits Computing 2D Weights in 3D If you have a 2D polygon in 3D plane that is not an XY plane, you can still compute -the 2D weights, however you need to provide a special projection traits class. This example -shows how to achieve that when using the `Mean_value_weights_2` type of barycentric weights. -We also show how to use these traits for computing the \ref PkgWeightsRefWachspressWeights "Wachspress weight" -for 3D points, which are not strictly coplanar. The common plane that is used in this example is -projectable to the XY plane. +the 2D weights, however you need to provide a special projection traits class. +The common plane that is used in this example is projectable to the XY plane. We first +compute `Mean_value_weights_2` for a 3D polygon in this plane. We then also show how to use +the projection traits to compute the \ref PkgWeightsRefWachspressWeights "2D Wachspress weight" +for 3D points, which are not strictly coplanar. \cgalExample{Weights/projection_traits.cpp} @@ -221,7 +221,7 @@ the mixed Voronoi cells around each mesh vertex. This little example shows how to use the family of weights which includes multiple types of weights in one function. In particular, we show how, by changing an input parameter, -we converge from the Wachspress weights to the mean value weights. +we converge from the `Wachspress_weights_2` to the `Mean_value_weights_2`. \cgalExample{Weights/convergence.cpp} diff --git a/Weights/examples/Weights/projection_traits.cpp b/Weights/examples/Weights/projection_traits.cpp index 1267da02ea4..92b88ee03c0 100644 --- a/Weights/examples/Weights/projection_traits.cpp +++ b/Weights/examples/Weights/projection_traits.cpp @@ -43,7 +43,7 @@ int main() { const Point_3 r3( 0, -1, 1); const Point_3 p3( 1, 0, 1.0 + eps); const Point_3 q3( 0, 0, 1); - std::cout << "3D Wachspress weight: " << + std::cout << "2D Wachspress weight: " << CGAL::Weights::wachspress_weight(t3, r3, p3, q3, ptraits) << std::endl; return EXIT_SUCCESS; }