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

doc: draw ct2

This commit is contained in:
Guillaume Damiand 2023-12-06 17:00:20 +01:00
parent b34fb266a4
commit 4d02be9db3
1 changed files with 29 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Triangulation_2/doc/Triangulation_2/CGAL/draw_constrained_triangulation_2.h
View File

@ -3,38 +3,54 @@ namespace CGAL {
/*!
\ingroup PkgDrawConstrainedTriangulation2
opens a new window and draws a constrained triangulation. If the triangulation has constraints they are drawn. The faces inside and outside of the domain, based on the property map, are drawn in different colors. Parameters of the drawing are taken from the optional graphics scene options parameter.
opens a new window and draws a constrained triangulation. If the triangulation has constraints they are drawn. The faces inside and outside of the domain, based on the property map, are drawn in different colors.
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, 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_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam CT2 which must be an instanciation of a `CGAL::Constrained_triangulation_2<...>`.
\tparam InDomainPMap a class model of `ReadablePropertyMap` with `CT2::Face_handle` as key type and `bool` as value type.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param ct2 the constrained triangulation to draw.
\param ipm the property map defining the faces which are in the domain.
\param gso the graphics scene options parameter.
\cgalAdvancedBegin
The real declaration of this function template is:
<code>
template<class Gt, class Tds, class Itag, class InDomainPMap, class GSOptions>
template<class Gt, class Tds, class Itag, class InDomainPMap>
void CGAL::draw(const CGAL::Constrained_triangulation_2<Gt, Tds, Itag>& ct2, InDomainPMap ipm, const GSOptions& gso);
void CGAL::draw(const CGAL::Constrained_triangulation_2<Gt, Tds, Itag>& ct2, InDomainPMap ipm);
</code>
\cgalAdvancedEnd
*/
template<class CT2, class InDomainPMap, class GSOptions>
void draw(const CT2& ct2, InDomainPMap ipm, const GSOptions& gso);
/*!
\ingroup PkgDrawConstrainedTriangulation2
A shortcut to `CGAL::draw(ct2, ipm, Graphics_scene_options{})`.
*/
template<class CT2, class InDomainPMap>
void draw(const CT2& ct2, InDomainPMap ipm);
/*!
\ingroup PkgDrawConstrainedTriangulation2
adds the vertices, edges and faces of `ct2` into the given graphic scene `gs`. If the triangulation has constraints they are drawn. The faces inside and outside of the domain, based on the property map, are drawn in different colors. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam CT2 which must be an instanciation of a `CGAL::Constrained_triangulation_2<...>`.
\tparam InDomainPMap a class model of `ReadablePropertyMap` with `CT2::Face_handle` as key type and `bool` as value type.
\param ct2 the constrained triangulation to draw.
\param ipm the property map defining the faces which are in the domain.
\param gs the graphic scene to fill.
\cgalAdvancedBegin
The real declaration of this function template is:
<code>
template<class Gt, class Tds, class Itag, class InDomainPMap>
void CGAL::add_to_graphics_scene(const CGAL::Constrained_triangulation_2<Gt, Tds, Itag>& ct2, InDomainPMap ipm, CGAL::Graphics_scene& gs);
</code>
\cgalAdvancedEnd
*/
template<class CT2, class InDomainPMap>
void add_to_graphics_scene(const CT2& ct2, InDomainPMap ipm,
CGAL::Graphics_scene& gs);
} /* namespace CGAL */