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

doc draw arrangement; fix to doc face graph with path

This commit is contained in:
Guillaume Damiand 2023-12-07 17:21:54 +01:00
parent 3f3a21a949
commit 973fb082d5
2 changed files with 49 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/draw_arrangement_2.h
View File

@ -26,11 +26,11 @@ namespace CGAL {
/*! \ingroup PkgArrangementOnSurface2Draw
*
* opens a new window and draws `arr`, an instance of the `CGAL::Arrangement_2`
* class template. A call to this function is blocking; that is, the program
* continues only after 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`.
* class template. 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 GeometryTraits_2 a geometry traits type, a model of a 2D arrangement
* traits concept. At this point it must be an instance of either
@ -44,9 +44,39 @@ namespace CGAL {
* \sa `ArrangementDcel`
* \sa `ArrangementTraits_2`
*/
template <typename GeometryTraits_2, typename Dcel, typename GSOptions>
void draw(const Arrangement_2<GeometryTraits_2, Dcel>& arr, const GSOptions& gso);
/*! \ingroup PkgArrangementOnSurface2Draw
A shortcut to `CGAL::draw(arr, Graphics_scene_options{})`.
*/
template <typename GeometryTraits_2, typename Dcel>
void draw(const Arrangement_2<GeometryTraits_2, Dcel>& arr,
const char* title = "2D Arrangement Basic Viewer");
void draw(const Arrangement_2<GeometryTraits_2, Dcel>& arr);
/*! \ingroup PkgArrangementOnSurface2Draw
adds the vertices, edges and faces of `arr` 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 GeometryTraits_2 a geometry traits type, a model of a 2D arrangement traits concept. At this point it must be an instance of either `CGAL::Arr_segment_traits_2` or `CGAL::Arr_conic_traits_2`.
\tparam Dcel the \dcel type, a model of the `ArrangementDcel` concept.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param arr the 2D arrangement to draw.
\param gs the graphic scene to fill.
\param gso the graphics scene options parameter.
*/
template <typename GeometryTraits_2, typename Dcel, typename GSOptions>
void add_to_graphics_scene(const Arrangement_2<GeometryTraits_2, Dcel>& arr,
CGAL::Graphics_scene& gs, const GSOptions& gso);
/*! \ingroup PkgArrangementOnSurface2Draw
A shortcut to `CGAL::add_to_graphics_scene(arr, gs, Graphics_scene_options{})`.
*/
template <typename GeometryTraits_2, typename Dcel>
void add_to_graphics_scene(const Arrangement_2<GeometryTraits_2, Dcel>& arr,
CGAL::Graphics_scene& gs);
} /* namespace CGAL */

24
Surface_mesh_topology/doc/Surface_mesh_topology/CGAL/draw_face_graph_with_paths.h
View File

@ -23,7 +23,7 @@ void draw(const Mesh& amesh,
/*!
\ingroup PkgDrawFaceGraphWithPaths
A shortcut to `CGAL::draw(mesh, paths, Graphics_scene_options_face_graph_with_paths{})`.
A shortcut to `CGAL::draw(amesh, apaths, Graphics_scene_options_face_graph_with_paths{})`.
*/
template<class Mesh>
void draw(const Mesh& amesh,
@ -62,20 +62,20 @@ adds the vertices, edges and faces of `amesh`, either a 2D linear cell complex o
\param apaths the paths to draw, which should lie on `amesh`.
*/
template <class Mesh, class GSOptions>
void add_to_graphics_scene(const Mesh& mesh,
CGAL::Graphics_scene& graphics_scene,
void add_to_graphics_scene(const Mesh& amesh,
CGAL::Graphics_scene& gs,
const GSOptions& gso,
const std::vector<Surface_mesh_topology::Path_on_surface<Mesh>>& paths);
const std::vector<Surface_mesh_topology::Path_on_surface<Mesh>>& apaths);
/*!
\ingroup PkgDrawFaceGraphWithPaths
A shortcut to `CGAL::add_to_graphics_scene(mesh, graphics_scene, Graphics_scene_options_face_graph_with_paths{}, paths)`.
A shortcut to `CGAL::add_to_graphics_scene(amesh, gs, Graphics_scene_options_face_graph_with_paths{}, apaths)`.
*/
template <class Mesh>
void add_to_graphics_scene(const Mesh& mesh,
CGAL::Graphics_scene& graphics_scene,
const std::vector<Surface_mesh_topology::Path_on_surface<Mesh>>& paths);
void add_to_graphics_scene(const Mesh& amesh,
CGAL::Graphics_scene& gs,
const std::vector<Surface_mesh_topology::Path_on_surface<Mesh>>& apaths);
/*!
\ingroup PkgDrawFaceGraphWithPaths
@ -83,8 +83,8 @@ void add_to_graphics_scene(const Mesh& mesh,
Same function than <a href="#XXXX"><b>add_to_graphics_scene()</b></a> but taking the paths from a list instead from an std::vector.
*/
template <class Mesh, class GSOptions>
void add_to_graphics_scene(const Mesh& mesh,
CGAL::Graphics_scene& graphics_scene,
void add_to_graphics_scene(const Mesh& amesh,
CGAL::Graphics_scene& gs,
const GSOptions& gso,
std::initializer_list<Path_on_surface<Mesh> > apaths);
@ -94,8 +94,8 @@ void add_to_graphics_scene(const Mesh& mesh,
Same function than <a href="#XXXX"><b>add_to_graphics_scene()</b></a> but taking the paths from a list instead from an std::vector.
*/
template <class Mesh>
void add_to_graphics_scene(const Mesh& mesh,
CGAL::Graphics_scene& graphics_scene,
void add_to_graphics_scene(const Mesh& amesh,
CGAL::Graphics_scene& gs,
std::initializer_list<Path_on_surface<Mesh> > apaths);
} /* namespace CGAL */