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

Improve documentation of function draw()

This commit is contained in:
Andreas Fabri 2022-03-22 14:10:13 +01:00
parent 92aecad7d6
commit 109056d592
4 changed files with 26 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Mesh_2/examples/Mesh_2/mesh_marked_domain.cpp
View File

@ -4,7 +4,7 @@
#include <CGAL/Delaunay_mesh_face_base_2.h> #include <CGAL/Delaunay_mesh_face_base_2.h>
#include <CGAL/Delaunay_mesh_size_criteria_2.h> #include <CGAL/Delaunay_mesh_size_criteria_2.h>
#include <CGAL/mark_domain_in_triangulation.h> #include <CGAL/mark_domain_in_triangulation.h>
#include <CGAL/draw_constrained_triangulation_2.h> #include <CGAL/draw_triangulation_2.h>
#include <iostream> #include <iostream>

25
Triangulation_2/doc/Triangulation_2/CGAL/draw_triangulation_2.h
View File

@ -3,14 +3,33 @@ namespace CGAL {
/*! /*!
\ingroup PkgDrawTriangulation2 \ingroup PkgDrawTriangulation2
opens a new window and draws `at2`, a model of the `TriangulationDataStructure_2` concept. A call to this function is blocking, that is the program continues as soon as the user closes the window. This function requires `CGAL_Qt5`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined. opens a new window and draws a triangulation.
A call to this function is blocking, that is the program continues as soon as the user closes the window. This function requires `CGAL_Qt5`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt5` and add the definition `CGAL_USE_BASIC_VIEWER`. Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt5` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam T2 a model of the `TriangulationDataStructure_2` concept.
\tparam T2 a triangulation class derived from `Triangulation_2` or `Constrained_triangulation_2`
\param at2 the triangulation to draw. \param at2 the triangulation to draw.
*/ */
template<class T2> template<class T2>
void draw(const T2& at2); void draw(const T2& at2);
} /* namespace CGAL */ /*!
\ingroup PkgDrawTriangulation2
opens a new window and draws a triangulation.
A call to this function is blocking, that is the program continues as soon as the user closes the window. This function requires `CGAL_Qt5`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt5` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam CT a triangulation class derived from `Triangulation_2` or `Constrained_triangulation_2`
\tparam InDomainPMap a class model of `ReadWritePropertyMap` with
`CT::Face_handle` as key type and `bool` as value type.
\param at2 the triangulation to draw.
\param ipm the property map defining the faces which are in the domain.
*/
template<class CT, class InDomainPMap>
void draw(const CT2& act, InDomainPMap ipm);
} /* namespace CGAL */

2
Triangulation_2/examples/Triangulation_2/polygon_triangulation.cpp
View File

@ -1,6 +1,6 @@
#include <CGAL/Exact_predicates_inexact_constructions_kernel.h> #include <CGAL/Exact_predicates_inexact_constructions_kernel.h>
#include <CGAL/Constrained_Delaunay_triangulation_2.h> #include <CGAL/Constrained_Delaunay_triangulation_2.h>
#include <CGAL/draw_constrained_triangulation_2.h> #include <CGAL/draw_triangulation_2.h>
#include <CGAL/mark_domain_in_triangulation.h> #include <CGAL/mark_domain_in_triangulation.h>
#include <CGAL/Polygon_2.h> #include <CGAL/Polygon_2.h>

2
Triangulation_2/include/CGAL/draw_triangulation_2.h
View File

@ -21,6 +21,8 @@
#include <CGAL/Triangulation_2.h> #include <CGAL/Triangulation_2.h>
#include <CGAL/Random.h> #include <CGAL/Random.h>
#include <CGAL/draw_constrained_triangulation_2.h>
namespace CGAL namespace CGAL
{ {