From bdd645224938be292b1cd84d51f7324855f4e167 Mon Sep 17 00:00:00 2001 From: Michael Hemmer Date: Tue, 12 Aug 2014 10:33:38 -0300 Subject: [PATCH 1/2] precise def of general simple polygon at tag --- Visibility_2/doc/Visibility_2/Concepts/Visibility_2.h | 7 +++++++ Visibility_2/doc/Visibility_2/visibility_2.txt | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/Visibility_2/doc/Visibility_2/Concepts/Visibility_2.h b/Visibility_2/doc/Visibility_2/Concepts/Visibility_2.h index 6771de6dec1..4818bf63820 100644 --- a/Visibility_2/doc/Visibility_2/Concepts/Visibility_2.h +++ b/Visibility_2/doc/Visibility_2/Concepts/Visibility_2.h @@ -48,11 +48,18 @@ public: /*! Tag identifying whether general polygons (with holes) are supported (either \ref CGAL::Tag_true or \ref CGAL::Tag_false). + That is, the 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. */ typedef unspecified_type Supports_general_polygon_tag; /*! Tag identifying whether general simple polygons are supported (either \ref CGAL::Tag_true or \ref CGAL::Tag_false). + + That is, the 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. + Note that this allows \f$ f \f$ to touch a vertex from several sides. */ typedef unspecified_type Supports_simple_polygon_tag; /// @} diff --git a/Visibility_2/doc/Visibility_2/visibility_2.txt b/Visibility_2/doc/Visibility_2/visibility_2.txt index 3df0380f64f..b054000a908 100644 --- a/Visibility_2/doc/Visibility_2/visibility_2.txt +++ b/Visibility_2/doc/Visibility_2/visibility_2.txt @@ -71,7 +71,7 @@ However, this should be avoided as this also requires an update of the auxiliary data structures in the attached object. An actual query is then performed by giving the view point \f$ p \f$ and its containing face \f$ f \f$, which must represent a valid \cgalFootnote{See the package \ref PkgBooleanSetOperations2Summary for the precise definition} -polygon. Namely, in the face \f$ f \f$, there is no isolated vertex, and any edge of the face separates \f$ f \f$ with another face. +polygon. Namely, in the face \f$ f \f$, there is no isolated vertex, and any edge of \f$ f \f$ separates \f$ f \f$ from another face. For this purpose every model of the Visibility_2 concept provides two overloaded member functions, called `Visibility_2::compute_visibility()` , that compute the visibility region of \f$ p \f$ in a bounded polygonal face \f$ f \f$: one is for the case where \f$ p \f$ is in the interior of \f$ f \f$; the other one is for the case where \f$ p \f$ is on the boundary of \f$ f \f$. From 4e8f34f8800c41faa3d015e8b1d632ca6e6b3efc Mon Sep 17 00:00:00 2001 From: Michael Hemmer Date: Tue, 12 Aug 2014 11:43:48 -0300 Subject: [PATCH 2/2] added links to concepts for tags --- .../doc/Visibility_2/CGAL/Rotational_sweep_visibility_2.h | 4 ++-- .../doc/Visibility_2/CGAL/Simple_polygon_visibility_2.h | 4 ++-- .../doc/Visibility_2/CGAL/Triangular_expansion_visibility_2.h | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) 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 728ab77d649..68a80259738 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 @@ -45,12 +45,12 @@ public: typedef RegularizationTag Regularization_tag; /*! - Its value is \ref CGAL::Tag_true. + See also \ref Visibility_2::Supports_general_polygon_tag. */ typedef ::Tag_true Supports_general_polygon_tag; /*! - Its value is \ref CGAL::Tag_true. + See also \ref Visibility_2::Supports_simple_polygon_tag. */ typedef ::Tag_true Supports_simple_polygon_tag; /// @} 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 e17db313332..0a86241677b 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 @@ -51,12 +51,12 @@ public: typedef RegularizationTag Regularization_tag; /*! - Its value is \ref CGAL::Tag_false. + See also \ref Visibility_2::Supports_general_polygon_tag. */ typedef ::Tag_false Supports_general_polygon_tag; /*! - Its value is \ref CGAL::Tag_true. + See also \ref Visibility_2::Supports_simple_polygon_tag. */ typedef ::Tag_true Supports_simple_polygon_tag; /// @} 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 7f8a0381a69..8d7e446e832 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 @@ -47,12 +47,12 @@ public: typedef RegularizationTag Regularization_tag; /*! - Its value is \ref CGAL::Tag_true. + See also \ref Visibility_2::Supports_general_polygon_tag. */ typedef ::Tag_true Supports_general_polygon_tag; /*! - Its value is \ref CGAL::Tag_true. + See also \ref Visibility_2::Supports_simple_polygon_tag. */ typedef ::Tag_true Supports_simple_polygon_tag; /// @}