mirror of https://github.com/CGAL/cgal
doc: draw point set 3 and constrained triangulation 2
This commit is contained in:
Guillaume Damiand
parent
3d8037d7f6
commit
bfcb44bd8c
|
|
@ -26,14 +26,73 @@ namespace CGAL {
|
|||
/*!
|
||||
\ingroup PkgDrawPointSet3D
|
||||
|
||||
opens a new window and draws `aps`, an instance of the `CGAL::Point_set_3` class. A call to this function is blocking, that is the program continues as soon as the user closes the window. 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 PS an instance of the `CGAL::Point_set_3` class.
|
||||
\param aps the point set to draw.
|
||||
opens a new window and draws a point set. Parameters of the drawing are taken from the optional graphics scene options parameter.
|
||||
|
||||
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 PS which must be an instanciation of a `CGAL::Point_set_3<...>`.
|
||||
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
|
||||
|
||||
\param ps the point set to draw.
|
||||
\param gso the graphics scene options parameter.
|
||||
|
||||
\cgalAdvancedBegin
|
||||
The real declaration of this function template is:
|
||||
|
||||
<code>
|
||||
template<class P, class V, class GSOptions>
|
||||
|
||||
void CGAL::draw(const CGAL::Point_set_3<P, V>& ps, const GSOptions& gso);
|
||||
</code>
|
||||
\cgalAdvancedEnd
|
||||
*/
|
||||
template<class PS, class GSOptions>
|
||||
void draw(const PS& ps, const GSOptions& gso);
|
||||
|
||||
/*!
|
||||
\ingroup PkgDrawPointSet3D
|
||||
|
||||
A shortcut to `CGAL::draw(ps, Graphics_scene_options{})`.
|
||||
*/
|
||||
template<class PS>
|
||||
void draw(const PS& ps);
|
||||
|
||||
/*!
|
||||
\ingroup PkgDrawPointSet3D
|
||||
|
||||
adds the vertices, edges and faces of `ps` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso` . Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
|
||||
|
||||
\tparam PS which must be an instanciation of a `CGAL::Point_set_3<...>`.
|
||||
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
|
||||
|
||||
\param ps the point set to draw.
|
||||
\param gs the graphic scene to fill.
|
||||
\param gso the graphics scene options parameter.
|
||||
|
||||
\cgalAdvancedBegin
|
||||
The real declaration of this function template is:
|
||||
|
||||
<code>
|
||||
template<class P, class V, class GSOptions>
|
||||
|
||||
void CGAL::add_to_graphics_scene(const CGAL::Point_set_3<P, V>& ps, CGAL::Graphics_scene& gs, const GSOptions& gso);
|
||||
</code>
|
||||
\cgalAdvancedEnd
|
||||
*/
|
||||
template<class PS, class GSOptions>
|
||||
void add_to_graphics_scene(const PS& ps,
|
||||
CGAL::Graphics_scene& gs,
|
||||
const GSOptions& gso);
|
||||
|
||||
/*!
|
||||
\ingroup PkgDrawPointSet3D
|
||||
|
||||
A shortcut to `CGAL::add_to_graphics_scene(ps, gs, Graphics_scene_options{})`.
|
||||
*/
|
||||
template<class PS>
|
||||
void draw(const PS& aps);
|
||||
void add_to_graphics_scene(const PS& ps,
|
||||
CGAL::Graphics_scene& gs);
|
||||
|
||||
} /* namespace CGAL */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -1,43 +1,40 @@
|
|||
namespace CGAL {
|
||||
|
||||
/*!
|
||||
\ingroup PkgDrawConstrainedTriangulation2
|
||||
|
||||
opens a new window and draws a triangulation. If the triangulation
|
||||
has constraints they are drawn. If the face type has a member
|
||||
function `bool is_in_domain()` the faces inside and outside of the
|
||||
domain are drawn in different colors.
|
||||
|
||||
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 T2 a triangulation class derived from `Triangulation_2` or `Constrained_triangulation_2`
|
||||
\param at2 the triangulation to draw.
|
||||
|
||||
*/
|
||||
template<class T2>
|
||||
void draw(const T2& at2, TODO);
|
||||
|
||||
/*!
|
||||
\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.
|
||||
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.
|
||||
|
||||
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`.
|
||||
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 a triangulation class derived from `Constrained_triangulation_2`
|
||||
\tparam InDomainPMap a class model of `ReadablePropertyMap` with
|
||||
`CT::Face_handle` as key type and `bool` as value type.
|
||||
\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 act2 the constrained triangulation to draw.
|
||||
\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>
|
||||
|
||||
void CGAL::draw(const CGAL::Constrained_triangulation_2<Gt, Tds, Itag>& ct2, InDomainPMap ipm, const GSOptions& gso);
|
||||
</code>
|
||||
\cgalAdvancedEnd
|
||||
*/
|
||||
template<class CT2, class InDomainPMap>
|
||||
void draw(const CT2& act2, InDomainPMap ipm);
|
||||
template<class CT2, class InDomainPMap, class GSOptions>
|
||||
void draw(const CT2& act2, InDomainPMap ipm, const GSOptions& gso);
|
||||
|
||||
/*!
|
||||
\ingroup PkgDrawConstrainedTriangulation2
|
||||
|
||||
A shortcut to `CGAL::draw(at2, ipm, Graphics_scene_options{})`.
|
||||
*/
|
||||
template<class T2, class InDomainPMap>
|
||||
void draw(const T2& at2, InDomainPMap ipm);
|
||||
|
||||
} /* namespace CGAL */
|
||||
|
|
|
|||
Loading…
Reference in New Issue