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.
This commit is contained in:
Andreas Fabri 2015-09-09 12:09:57 +02:00
parent 022d7325a3
commit 6692f993ce
15 changed files with 33 additions and 29 deletions

View File

@ -10,7 +10,7 @@
\cgalPkgPicture{barcoord_thumb.png} \cgalPkgPicture{barcoord_thumb.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Dmitry Anisimov, David Bommes, Kai Hormann, and Pierre Alliez} \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} \cgalPkgManuals{Chapter_2D_Generalized_Barycentric_Coordinates, PkgBarycentric_coordinates_2}
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin

View File

@ -47,6 +47,7 @@ h1 {
\package_listing{Straight_skeleton_2} \package_listing{Straight_skeleton_2}
\package_listing{Minkowski_sum_2} \package_listing{Minkowski_sum_2}
\package_listing{Polyline_simplification_2} \package_listing{Polyline_simplification_2}
\package_listing{Visibility_2}
\section PartPolyhedra Cell Complexes and Polyhedra \section PartPolyhedra Cell Complexes and Polyhedra
@ -68,7 +69,6 @@ h1 {
\package_listing{Snap_rounding_2} \package_listing{Snap_rounding_2}
\package_listing{Envelope_2} \package_listing{Envelope_2}
\package_listing{Envelope_3} \package_listing{Envelope_3}
\package_listing{Visibility_2}
\section PartTriangulationsAndDelaunayTriangulations Triangulations and Delaunay Triangulations \section PartTriangulationsAndDelaunayTriangulations Triangulations and Delaunay Triangulations

View File

@ -29,7 +29,7 @@
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.3} \cgalPkgSince{4.3}
\cgalPkgDependsOn{\ref PkgTDS2Summary and \ref PkgTriangulation2Summary} \cgalPkgDependsOn{\ref PkgTriangulation2Summary}
\cgalPkgBib{cgal:k-pt2-13} \cgalPkgBib{cgal:k-pt2-13}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Periodic Delaunay Triangulation,Periodic_2_Delaunay_triangulation_2.zip} \cgalPkgDemo{Periodic Delaunay Triangulation,Periodic_2_Delaunay_triangulation_2.zip}

View File

@ -23,7 +23,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.5} \cgalPkgSince{3.5}
\cgalPkgDependsOn{\ref PkgTriangulation3Summary and \ref PkgTDS3Summary} \cgalPkgDependsOn{\ref PkgTDS3Summary}
\cgalPkgBib{cgal:ct-pt3} \cgalPkgBib{cgal:ct-pt3}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{3D Periodic Delaunay Triangulation,periodic_3_triangulation_3.zip,3D Periodic Lloyd,periodic_3_lloyd.zip} \cgalPkgDemo{3D Periodic Delaunay Triangulation,periodic_3_triangulation_3.zip,3D Periodic Lloyd,periodic_3_lloyd.zip}

View File

@ -26,7 +26,7 @@ ranging from basic operations on simplices, to complex geometry processing algor
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.7} \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} \cgalPkgBib{cgal:lty-pmp}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} \cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip}

View File

@ -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 /// \defgroup PkgSurfaceMeshShortestPathConcepts Concepts
/// \ingroup PkgSurfaceMeshShortestPath /// \ingroup PkgSurfaceMeshShortestPath
@ -19,12 +19,11 @@
\cgalPkgPicture{shortestpathspackage-ico.png} \cgalPkgPicture{shortestpathspackage-ico.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Stephen Kiazyk, Sébastien Loriot, Éric Colin de Verdière} \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} \cgalPkgManuals{Chapter_Surface_mesh_shortest_path,PkgSurfaceMeshShortestPath}
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.7} \cgalPkgSince{4.7}
\cgalPkgDependsOn{\ref PkgBGLSummary and \ref PkgAABB_treeSummary for some convenience functions}
\cgalPkgBib{cgal:klcdv-tsmsp} \cgalPkgBib{cgal:klcdv-tsmsp}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} \cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip}

View File

@ -7,7 +7,7 @@ namespace CGAL {
\cgalAutoToc \cgalAutoToc
\author Stephen Kiazyk, Sébastien Loriot, and Éric Colin de Verdière \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} \cgalFigureBegin{Shortest_path_main,shortest_paths_overview.png}
Shortest paths on a terrain using one source point represented by a green square. 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: 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$. 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 \section Surface_mesh_shortest_pathHowToUse User Interface Description

View File

@ -13,8 +13,6 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.3} \cgalPkgSince{3.3}
\cgalPkgDependsOn{\ref PkgBGLSummary}
\cgalPkgDependsOn{\ref PkgPolyhedronSummary}
\cgalPkgBib{cgal:c-tsms-12} \cgalPkgBib{cgal:c-tsms-12}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} \cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip}

View File

@ -35,6 +35,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.2} \cgalPkgSince{3.2}
\cgalPkgDependsOn{\ref PkgTriangulation3Summary}
\cgalPkgBib{cgal:ry-smg} \cgalPkgBib{cgal:ry-smg}
\cgalPkgLicense{\ref licensesGPL} \cgalPkgLicense{\ref licensesGPL}
\cgalPkgDemo{Surface Mesh Generator,surface_mesher.zip} \cgalPkgDemo{Surface Mesh Generator,surface_mesher.zip}

View File

@ -25,6 +25,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{2.1} \cgalPkgSince{2.1}
\cgalPkgDependsOn{\ref PkgTDS3Summary}
\cgalPkgBib{cgal:pt-t3} \cgalPkgBib{cgal:pt-t3}
\cgalPkgLicense{\ref licensesGPL "GPL" } \cgalPkgLicense{\ref licensesGPL "GPL" }
\cgalPkgDemo{3D Triangulations,triangulation_3.zip} \cgalPkgDemo{3D Triangulations,triangulation_3.zip}

View File

@ -9,11 +9,11 @@ namespace CGAL {
\tparam Arrangement_2_ is the type used to represent the input environment. \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 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. `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 \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.

View File

@ -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. is the number of the vertices of the polygon.
\tparam Arrangement_2_ is the type used to represent the input environment. \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 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. `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 \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` \cgalModels `Visibility_2`

View File

@ -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. \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 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. `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 \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` \cgalModels `Visibility_2`

View File

@ -42,12 +42,12 @@ public:
/// \name Tags /// \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; 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 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. 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. 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; 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, 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. 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. 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. \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 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. must be mutual convertible to `Visibility_2::Traits_2`.
\param q is the query point \param q is the query point
\param f is the face of the arrangement in which the visibility region is computed \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. 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. \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 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. must be mutual convertible to `Visibility_2::Traits_2`.
\param q is the query point \param q is the query point
\param e the halfedge on which `q` is located \param e the halfedge on which `q` is located
\param out_arr is the output arrangement \param out_arr is the output arrangement

View File

@ -3,6 +3,9 @@
/// \defgroup PkgVisibility_2Concepts Concepts /// \defgroup PkgVisibility_2Concepts Concepts
/// \ingroup PkgVisibility_2 /// \ingroup PkgVisibility_2
/// \defgroup PkgVisibility_2Classes Classes
/// \ingroup PkgVisibility_2
/*! /*!
\addtogroup PkgVisibility_2 \addtogroup PkgVisibility_2
\cgalPkgDescriptionBegin{2D Visibility Computation,PkgVisibility_2Summary} \cgalPkgDescriptionBegin{2D Visibility Computation,PkgVisibility_2Summary}
@ -15,6 +18,8 @@ the visibility area of a point within polygonal regions in two dimensions.}
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.7} \cgalPkgSince{4.7}
\cgalPkgDependsOn{\ref PkgArrangement2Summary}
\cgalPkgDependsOn{\ref PkgTriangulation2Summary}
\cgalPkgBib{hhb-visibility-2} \cgalPkgBib{hhb-visibility-2}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd \cgalPkgShortInfoEnd