songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'gsoc2013-Visibility_doc-hemmer' of ssh://scm.cgal.org/var/git/cgal-gsoc into gsoc2013-Visibility_doc-hemmer

This commit is contained in:
Ning Xu 2014-08-18 20:17:59 -04:00
parent e3a5f7c2bf 4e8f34f880
commit f05792da93
5 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Visibility_2/doc/Visibility_2/CGAL/Rotational_sweep_visibility_2.h
View File

@ -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;
/// @}

4
Visibility_2/doc/Visibility_2/CGAL/Simple_polygon_visibility_2.h
View File

@ -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;
/// @}

4
Visibility_2/doc/Visibility_2/CGAL/Triangular_expansion_visibility_2.h
View File

@ -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;
/// @}

7
Visibility_2/doc/Visibility_2/Concepts/Visibility_2.h
View File

@ -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;
/// @}

2
Visibility_2/doc/Visibility_2/visibility_2.txt
View File

@ -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$.