From 6692f993ce5df372a4564ab933ef406268402ce8 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Wed, 9 Sep 2015 12:09:57 +0200 Subject: [PATCH] Add/Remove some cgalPkgDependsOn Move Visibility package from Arrangements to Polygons Add some `` in the Visibility package Add the keyword 'Geodesic' to the Shortest Path package. --- .../PackageDescription.txt | 2 +- Documentation/doc/Documentation/packages.txt | 2 +- .../PackageDescription.txt | 2 +- .../PackageDescription.txt | 2 +- .../Polygon_mesh_processing/PackageDescription.txt | 2 +- .../PackageDescription.txt | 7 +++---- .../Surface_mesh_shortest_path.txt | 4 ++-- .../PackageDescription.txt | 2 -- .../doc/Surface_mesher/PackageDescription.txt | 1 + .../doc/Triangulation_3/PackageDescription.txt | 1 + .../CGAL/Rotational_sweep_visibility_2.h | 6 +++--- .../CGAL/Simple_polygon_visibility_2.h | 6 +++--- .../CGAL/Triangular_expansion_visibility_2.h | 6 +++--- .../doc/Visibility_2/Concepts/Visibility_2.h | 14 +++++++------- .../doc/Visibility_2/PackageDescription.txt | 5 +++++ 15 files changed, 33 insertions(+), 29 deletions(-) diff --git a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt index 5eb0ab1b4b4..a74f83709c8 100644 --- a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt +++ b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt @@ -10,7 +10,7 @@ \cgalPkgPicture{barcoord_thumb.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Dmitry Anisimov, David Bommes, Kai Hormann, and Pierre Alliez} -\cgalPkgDesc{The package 2D Generalized Barycentric Coordinates offers an efficient and robust implementation of two-dimensional closed-form generalized barycentric coordinates defined for simple two-dimensional polygons. If coordinates with respect to multivariate scattered points instead of a polygon are required, please refer to natural neighbour coordinates from the package 2D and Surface Function Interpolation.} +\cgalPkgDesc{The package 2D Generalized Barycentric Coordinates offers an efficient and robust implementation of two-dimensional closed-form generalized barycentric coordinates defined for simple two-dimensional polygons. If coordinates with respect to multivariate scattered points instead of a polygon are required, please refer to natural neighbor coordinates from the Package \ref PkgInterpolation2Summary.} \cgalPkgManuals{Chapter_2D_Generalized_Barycentric_Coordinates, PkgBarycentric_coordinates_2} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin diff --git a/Documentation/doc/Documentation/packages.txt b/Documentation/doc/Documentation/packages.txt index 96a7f4eb2aa..863a75f0c76 100644 --- a/Documentation/doc/Documentation/packages.txt +++ b/Documentation/doc/Documentation/packages.txt @@ -47,6 +47,7 @@ h1 { \package_listing{Straight_skeleton_2} \package_listing{Minkowski_sum_2} \package_listing{Polyline_simplification_2} +\package_listing{Visibility_2} \section PartPolyhedra Cell Complexes and Polyhedra @@ -68,7 +69,6 @@ h1 { \package_listing{Snap_rounding_2} \package_listing{Envelope_2} \package_listing{Envelope_3} -\package_listing{Visibility_2} \section PartTriangulationsAndDelaunayTriangulations Triangulations and Delaunay Triangulations diff --git a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt index 0a161f010c8..3964f68c68c 100644 --- a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt +++ b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt @@ -29,7 +29,7 @@ \cgalPkgShortInfoBegin \cgalPkgSince{4.3} -\cgalPkgDependsOn{\ref PkgTDS2Summary and \ref PkgTriangulation2Summary} +\cgalPkgDependsOn{\ref PkgTriangulation2Summary} \cgalPkgBib{cgal:k-pt2-13} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{Periodic Delaunay Triangulation,Periodic_2_Delaunay_triangulation_2.zip} diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt index 33167b5ceff..a8cc0b0288f 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt @@ -23,7 +23,7 @@ \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} -\cgalPkgDependsOn{\ref PkgTriangulation3Summary and \ref PkgTDS3Summary} +\cgalPkgDependsOn{\ref PkgTDS3Summary} \cgalPkgBib{cgal:ct-pt3} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{3D Periodic Delaunay Triangulation,periodic_3_triangulation_3.zip,3D Periodic Lloyd,periodic_3_lloyd.zip} diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt index 42e804d2088..7202d61c109 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt @@ -26,7 +26,7 @@ ranging from basic operations on simplices, to complex geometry processing algor \cgalPkgShortInfoBegin \cgalPkgSince{4.7} -\cgalPkgDependsOn{\ref PkgTriangulation3Summary, Sparse square solver such as those from \ref thirdpartyEigen} +\cgalPkgDependsOn{documented for each function; Sparse square solver such as those from \ref thirdpartyEigen} \cgalPkgBib{cgal:lty-pmp} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} diff --git a/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt b/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt index 50a6a2d8d36..a788dd0c007 100644 --- a/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt +++ b/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt @@ -1,6 +1,6 @@ -// Triangulated Surface Mesh Shortest Paths +// Triangulated Surface Mesh Geodesic Shortest Paths -/// \defgroup PkgSurfaceMeshShortestPath Triangulated Surface Mesh Shortest Paths Reference +/// \defgroup PkgSurfaceMeshShortestPath Triangulated Surface Mesh Geodesic Shortest Paths Reference /// \defgroup PkgSurfaceMeshShortestPathConcepts Concepts /// \ingroup PkgSurfaceMeshShortestPath @@ -19,12 +19,11 @@ \cgalPkgPicture{shortestpathspackage-ico.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Stephen Kiazyk, Sébastien Loriot, Éric Colin de Verdière} -\cgalPkgDesc{The package provides methods for computing shortest path on triangulated surface meshes. The algorithm used is based on a paper by Xin and Wang \cgalCite{XinWang2009improvingchenandhan} . The input of this package can be any model of the `FaceListGraph` concept. } +\cgalPkgDesc{The package provides methods for computing geodesic shortest path on triangulated surface meshes. The algorithm used is based on a paper by Xin and Wang \cgalCite{XinWang2009improvingchenandhan} . The input of this package can be any model of the `FaceListGraph` concept. } \cgalPkgManuals{Chapter_Surface_mesh_shortest_path,PkgSurfaceMeshShortestPath} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.7} -\cgalPkgDependsOn{\ref PkgBGLSummary and \ref PkgAABB_treeSummary for some convenience functions} \cgalPkgBib{cgal:klcdv-tsmsp} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} diff --git a/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/Surface_mesh_shortest_path.txt b/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/Surface_mesh_shortest_path.txt index 083c6b2191f..4d5b8a364f1 100644 --- a/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/Surface_mesh_shortest_path.txt +++ b/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/Surface_mesh_shortest_path.txt @@ -7,7 +7,7 @@ namespace CGAL { \cgalAutoToc \author Stephen Kiazyk, Sébastien Loriot, and Éric Colin de Verdière -This package provides an algorithm to compute shortest paths on a triangulated surface mesh. +This package provides an algorithm to compute geodesic shortest paths on a triangulated surface mesh. \cgalFigureBegin{Shortest_path_main,shortest_paths_overview.png} Shortest paths on a terrain using one source point represented by a green square. @@ -21,7 +21,7 @@ Using a 2-dimensional approximation would fail to capture anything interesting a The algorithm implemented in this package builds a data structure to efficiently answer queries of the following form: Given a triangulated surface mesh \f$\cal{M}\f$, a set of source points \f$S\f$ on \f$\cal{M}\f$, and a target point \f$t\f$ also on \f$\cal{M}\f$, find a shortest path \f$\lambda\f$ between \f$t\f$ and any element in \f$ S \f$, where \f$\lambda\f$ is constrained to the surface of \f$\cal{M}\f$. -The algorithm used is based on a paper by Xin and Wang \cgalCite{XinWang2009improvingchenandhan}, a fast and practical algorithm for exact computation of shortest paths. It is an extension of earlier results by Chen and Han \cgalCite{ch-spp-96} and Mitchell, Mount, and Papadimitriou \cgalCite{mmp-dgp-87} . +The algorithm used is based on a paper by Xin and Wang \cgalCite{XinWang2009improvingchenandhan}, a fast and practical algorithm for exact computation of geodesic shortest paths. It is an extension of earlier results by Chen and Han \cgalCite{ch-spp-96} and Mitchell, Mount, and Papadimitriou \cgalCite{mmp-dgp-87} . \section Surface_mesh_shortest_pathHowToUse User Interface Description diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt index a2cc7b8e568..3944e8ab49c 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt @@ -13,8 +13,6 @@ \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} -\cgalPkgDependsOn{\ref PkgBGLSummary} -\cgalPkgDependsOn{\ref PkgPolyhedronSummary} \cgalPkgBib{cgal:c-tsms-12} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} diff --git a/Surface_mesher/doc/Surface_mesher/PackageDescription.txt b/Surface_mesher/doc/Surface_mesher/PackageDescription.txt index a675d0f22a3..9bc0d7cb8a9 100644 --- a/Surface_mesher/doc/Surface_mesher/PackageDescription.txt +++ b/Surface_mesher/doc/Surface_mesher/PackageDescription.txt @@ -35,6 +35,7 @@ \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} +\cgalPkgDependsOn{\ref PkgTriangulation3Summary} \cgalPkgBib{cgal:ry-smg} \cgalPkgLicense{\ref licensesGPL} \cgalPkgDemo{Surface Mesh Generator,surface_mesher.zip} diff --git a/Triangulation_3/doc/Triangulation_3/PackageDescription.txt b/Triangulation_3/doc/Triangulation_3/PackageDescription.txt index f20577bc02b..a88e0da5726 100644 --- a/Triangulation_3/doc/Triangulation_3/PackageDescription.txt +++ b/Triangulation_3/doc/Triangulation_3/PackageDescription.txt @@ -25,6 +25,7 @@ \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.1} +\cgalPkgDependsOn{\ref PkgTDS3Summary} \cgalPkgBib{cgal:pt-t3} \cgalPkgLicense{\ref licensesGPL "GPL" } \cgalPkgDemo{3D Triangulations,triangulation_3.zip} diff --git a/Visibility_2/doc/Visibility_2/CGAL/Rotational_sweep_visibility_2.h b/Visibility_2/doc/Visibility_2/CGAL/Rotational_sweep_visibility_2.h index 8a384730b7d..d5ea4df164a 100644 --- a/Visibility_2/doc/Visibility_2/CGAL/Rotational_sweep_visibility_2.h +++ b/Visibility_2/doc/Visibility_2/CGAL/Rotational_sweep_visibility_2.h @@ -9,11 +9,11 @@ namespace CGAL { \tparam Arrangement_2_ is the type used to represent the input environment. -It must be an instance of CGAL::Arrangement_2, where its CGAL::Arrangement_2::Traits_2 must be an instance of -CGAL::Arr_segment_traits_2, or of CGAL::Arr_non_caching_segment_traits_2. +It must be an instance of `CGAL::Arrangement_2`, where its `CGAL::Arrangement_2::Traits_2` must be an instance of +`CGAL::Arr_segment_traits_2`, or of `CGAL::Arr_non_caching_segment_traits_2`. \tparam RegularizationCategory indicates whether the output should be regularized. It can be -specified by one of the following: ::Tag_true or ::Tag_false, where ::Tag_false is the default value. +specified by one of the following: `CGAL::Tag_true` or `CGAL::Tag_false`, where `CGAL::Tag_false` is the default value. diff --git a/Visibility_2/doc/Visibility_2/CGAL/Simple_polygon_visibility_2.h b/Visibility_2/doc/Visibility_2/CGAL/Simple_polygon_visibility_2.h index 22095c24516..75ab4d2f311 100644 --- a/Visibility_2/doc/Visibility_2/CGAL/Simple_polygon_visibility_2.h +++ b/Visibility_2/doc/Visibility_2/CGAL/Simple_polygon_visibility_2.h @@ -16,11 +16,11 @@ algorithm are \f$ O(n) \f$ even in case of degeneracies such as needles, where \ is the number of the vertices of the polygon. \tparam Arrangement_2_ is the type used to represent the input environment. -It must be an instance of CGAL::Arrangement_2, where its CGAL::Arrangement_2::Traits_2 must be an instance of -CGAL::Arr_segment_traits_2, or of CGAL::Arr_non_caching_segment_traits_2. +It must be an instance of `CGAL::Arrangement_2`, where its `CGAL::Arrangement_2::Traits_2` must be an instance of +`CGAL::Arr_segment_traits_2`, or of `CGAL::Arr_non_caching_segment_traits_2`. \tparam RegularizationCategory indicates whether the output should be regularized. It can be -specified by one of the following: ::Tag_true or ::Tag_false, where ::Tag_false is the default value. +specified by one of the following: `CGAL::Tag_true` or `CGAL::Tag_false`, where `CGAL::Tag_false` is the default value. \cgalModels `Visibility_2` diff --git a/Visibility_2/doc/Visibility_2/CGAL/Triangular_expansion_visibility_2.h b/Visibility_2/doc/Visibility_2/CGAL/Triangular_expansion_visibility_2.h index 6a8b5fcccf8..909ed74d016 100644 --- a/Visibility_2/doc/Visibility_2/CGAL/Triangular_expansion_visibility_2.h +++ b/Visibility_2/doc/Visibility_2/CGAL/Triangular_expansion_visibility_2.h @@ -11,11 +11,11 @@ The query time is \f$ O(nh)\f$, where \f$ h \f$ is the number of holes+1 of inpu \tparam Arrangement_2_ is the type used to represent the input environment. -It must be an instance of CGAL::Arrangement_2, where its CGAL::Arrangement_2::Traits_2 must be an instance of -CGAL::Arr_segment_traits_2, or of CGAL::Arr_non_caching_segment_traits_2. +It must be an instance of `CGAL::Arrangement_2`, where its `CGAL::Arrangement_2::Traits_2` must be an instance of +`CGAL::Arr_segment_traits_2`, or of `CGAL::Arr_non_caching_segment_traits_2`. \tparam RegularizationCategory indicates whether the output should be regularized. It can be -specified by one of the following: ::Tag_true or ::Tag_false, where ::Tag_false is the default value. +specified by one of the following: \ref `CGAL::Tag_true` or \ref `CGAL::Tag_false`, where `CGAL::Tag_false` is the default value. \cgalModels `Visibility_2` diff --git a/Visibility_2/doc/Visibility_2/Concepts/Visibility_2.h b/Visibility_2/doc/Visibility_2/Concepts/Visibility_2.h index cc7f935ee2f..52940ab582a 100644 --- a/Visibility_2/doc/Visibility_2/Concepts/Visibility_2.h +++ b/Visibility_2/doc/Visibility_2/Concepts/Visibility_2.h @@ -42,12 +42,12 @@ public: /// \name Tags /// @{ /*! - identifies whether the regularized visibility area is computed (either \ref CGAL::Tag_true or \ref CGAL::Tag_false). + identifies whether the regularized visibility area is computed (either \ref `CGAL::Tag_true` or \ref `CGAL::Tag_false`). */ typedef unspecified_type Regularization_category; /*! - identifies whether general polygons (with holes) are supported (either \ref CGAL::Tag_true or \ref CGAL::Tag_false). + identifies whether general polygons (with holes) are supported (either \ref `CGAL::Tag_true` or \ref `CGAL::Tag_false`). A general polygon is represented by a face \f$ f \f$ with no isolated vertex and any edge of \f$ f \f$ separates \f$ f \f$ from another face. Note that this allows \f$ f \f$ to touch a vertex from several sides. @@ -55,7 +55,7 @@ public: typedef unspecified_type Supports_general_polygon_category; /*! - identifies whether simple polygons are supported (either \ref CGAL::Tag_true or \ref CGAL::Tag_false). + identifies whether simple polygons are supported (either \ref` CGAL::Tag_true` or \ref `CGAL::Tag_false`). A simple polygon is represented by a face \f$ f \f$ with no holes, no isolated vertex and any edge of \f$ f \f$ separates \f$ f \f$ from another face. @@ -114,8 +114,8 @@ The visibility region of `q` is stored in `out_arr`, that is, all features but the unbounded face of `out_arr` represent the visibility region. \tparam VisibilityArrangement_2 is the type of the output arrangement representing the visibility polygon. -It must be an instance of CGAL::Arrangement_2, where its CGAL::Arrangement_2::Traits_2 -must be mutual convertible to Visibility_2::Traits_2. +It must be an instance of `CGAL::Arrangement_2`, where its `CGAL::Arrangement_2::Traits_2` +must be mutual convertible to `Visibility_2::Traits_2`. \param q is the query point \param f is the face of the arrangement in which the visibility region is computed @@ -138,8 +138,8 @@ The visibility region of `q` is stored in `out_arr`, that is, all features but the unbounded face of `out_arr` represent the visibility region. \tparam VisibilityArrangement_2 is the type of the output arrangement representing the visibility polygon. -It must be an instance of CGAL::Arrangement_2, where its CGAL::Arrangement_2::Traits_2 -must be mutual convertible to Visibility_2::Traits_2. +It must be an instance of `CGAL::Arrangement_2`, where its `CGAL::Arrangement_2::Traits_2` +must be mutual convertible to `Visibility_2::Traits_2`. \param q is the query point \param e the halfedge on which `q` is located \param out_arr is the output arrangement diff --git a/Visibility_2/doc/Visibility_2/PackageDescription.txt b/Visibility_2/doc/Visibility_2/PackageDescription.txt index d02550f511e..3b3a2ad8672 100644 --- a/Visibility_2/doc/Visibility_2/PackageDescription.txt +++ b/Visibility_2/doc/Visibility_2/PackageDescription.txt @@ -3,6 +3,9 @@ /// \defgroup PkgVisibility_2Concepts Concepts /// \ingroup PkgVisibility_2 +/// \defgroup PkgVisibility_2Classes Classes +/// \ingroup PkgVisibility_2 + /*! \addtogroup PkgVisibility_2 \cgalPkgDescriptionBegin{2D Visibility Computation,PkgVisibility_2Summary} @@ -15,6 +18,8 @@ the visibility area of a point within polygonal regions in two dimensions.} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.7} +\cgalPkgDependsOn{\ref PkgArrangement2Summary} +\cgalPkgDependsOn{\ref PkgTriangulation2Summary} \cgalPkgBib{hhb-visibility-2} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgShortInfoEnd