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

Doc basic viewer

This commit is contained in:
Guillaume Damiand 2023-12-07 08:11:27 +01:00
parent bd04b2a68d
commit ac1fcdec13
2 changed files with 35 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Basic_viewer/doc/Basic_viewer/CGAL/Qt/Basic_viewer.h
View File

@ -5,7 +5,7 @@ namespace CGAL {
/*!
\ingroup PkgBasicViewerClasses
The class `Basic_viewer` is a Qt widget based on `QGLViewer` that allows to visualize 3D elements: points, segments, triangles, rays and lines. This class stores a reference to a `Graphics_scene`. Elements are added through the scene. This class 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`.
The class `Basic_viewer` is a Qt widget based on `QGLViewer` that allows to visualize 3D elements: points, segments, triangles, rays and lines. This class stores a reference to a `Graphics_scene`. Elements are added through the scene. This class 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`.
CGAL::QGLViewer is our internal fork of <a href="https://github.com/GillesDebunne/libQGLViewer">QGLViewer class</a> which is <em>A versatile 3D OpenGL viewer based on QOpenGLWidget</em>.
*/
@ -142,7 +142,9 @@ public:
/*!
\ingroup PkgBasicViewerClasses
The class `QApplication_and_basic_viewer` regroups a `Basic_viewer` and Qt `QApplication`. The `QApplication` is created in the constructor, but started by the `run()` method. This allows for example users to modify the `on_key_pressed` method of the `Basic_viewer` to define their own behavior. This class 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`.
The class `QApplication_and_basic_viewer` regroups a `Basic_viewer` and Qt `QApplication`. The `QApplication` is created in the constructor, but started by the `run()` method. This allows for example users to modify the `on_key_pressed` method of the `Basic_viewer` to define their own behavior.
This class 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 QApplication_and_basic_viewer
@ -165,7 +167,7 @@ public:
/*!
\ingroup PkgBasicViewerClasses
opens a new window and draws the given `Graphics_scene` (which must have been filled before). `title` will be the title of the window. A call to this method 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.
opens a new window and draws the given `Graphics_scene` (which must have been filled before). `title` will be the title of the window. A call to this method 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.
*/
void draw_graphics_scene(const Graphics_scene& graphic_scene,
const char *title="CGAL Basic Viewer")

58
Basic_viewer/doc/Basic_viewer/PackageDescription.txt
View File

@ -40,36 +40,38 @@
\cgalCRPSubsection{Draw for Different Packages}
- `Constrained_triangulation_2` \link PkgDrawTriangulation2 CGAL::draw<CT2>() \endlink
- `Linear_cell_complex` \link PkgDrawLinearCellComplex CGAL::draw<LCC>() \endlink
- `Nef_polyhedron_3` \link PkgDrawNef3 CGAL::draw<Nef3>() \endlink
- `Periodic_2_Triangulation_2` \link PkgDrawPeriodic2Triangulation2 CGAL::draw<P2T2>() \endlink
- `Point_set_3` \link PkgDrawPointSet3D CGAL::draw<PS>() \endlink
- `Polygon_2` \link PkgDrawPolygon2 CGAL::draw<P2>() \endlink
- `Polygon_set_2` \link PkgDrawPolygonSet2 CGAL::draw<PS>() \endlink
- `Polygon_with_holes_2` \link PkgDrawPolygonWithHoles2 CGAL::draw<PH2>() \endlink
- `Polyhedron_3` \link PkgDrawPolyhedron CGAL::draw<POLY>() \endlink
- `Surface_mesh` \link PkgDrawSurfaceMesh CGAL::draw<SM>() \endlink
- `Surface_mesh_topology` \link PkgDrawFaceGraphWithPaths CGAL::draw<SMT>() \endlink
- `Triangulation_2` \link PkgDrawTriangulation2 CGAL::draw<T2>() \endlink
- `Triangulation_3` \link PkgDrawTriangulation3 CGAL::draw<T3>() \endlink
- `Voronoi_diagram_2` \link PkgDrawVoronoiDiagram2 CGAL::draw<V2>() \endlink
- `CGAL::Arrangement_2` \link PkgArrangementOnSurface2Draw CGAL::draw<ARR>() \endlink
- `CGAL::Constrained_triangulation_2` \link PkgDrawTriangulation2 CGAL::draw<CT2>() \endlink
- `CGAL::Linear_cell_complex` \link PkgDrawLinearCellComplex CGAL::draw<LCC>() \endlink
- `CGAL::Nef_polyhedron_3` \link PkgDrawNef3 CGAL::draw<Nef3>() \endlink
- `CGAL::Periodic_2_Triangulation_2` \link PkgDrawPeriodic2Triangulation2 CGAL::draw<P2T2>() \endlink
- `CGAL::Point_set_3` \link PkgDrawPointSet3D CGAL::draw<PS>() \endlink
- `CGAL::Polygon_2` \link PkgDrawPolygon2 CGAL::draw<P2>() \endlink
- `CGAL::Polygon_set_2` \link PkgDrawPolygonSet2 CGAL::draw<PS>() \endlink
- `CGAL::Polygon_with_holes_2` \link PkgDrawPolygonWithHoles2 CGAL::draw<PH2>() \endlink
- `CGAL::Polyhedron_3` \link PkgDrawPolyhedron CGAL::draw<POLY>() \endlink
- `CGAL::Surface_mesh` \link PkgDrawSurfaceMesh CGAL::draw<SM>() \endlink
- `CGAL::Surface_mesh_topology` \link PkgDrawFaceGraphWithPaths CGAL::draw<SMT>() \endlink
- `CGAL::Triangulation_2` \link PkgDrawTriangulation2 CGAL::draw<T2>() \endlink
- `CGAL::Triangulation_3` \link PkgDrawTriangulation3 CGAL::draw<T3>() \endlink
- `CGAL::Voronoi_diagram_2` \link PkgDrawVoronoiDiagram2 CGAL::draw<V2>() \endlink
\cgalCRPSubsection{Fill Graphics Scene for Different Packages}
- Constrained_triangulation_2 \link PkgDrawTriangulation2 CGAL::add_to_graphics_scene<CT2>() \endlink
- Linear_cell_complex \link PkgDrawLinearCellComplex CGAL::add_to_graphics_scene<LCC>() \endlink
- Nef_polyhedron_3 \link PkgDrawNef3 CGAL::add_to_graphics_scene<Nef3>() \endlink
- Periodic_2_Triangulation_2 \link PkgDrawPeriodic2Triangulation2 CGAL::add_to_graphics_scene<P2T2>() \endlink
- Point_set_3 \link PkgDrawPointSet3D CGAL::add_to_graphics_scene<PS>() \endlink
- Polygon_2 \link PkgDrawPolygon2 CGAL::add_to_graphics_scene<P2>() \endlink
- Polygon_set_2 \link PkgDrawPolygonSet2 CGAL::add_to_graphics_scene<PS>() \endlink
- Polygon_with_holes_2 \link PkgDrawPolygonWithHoles2 CGAL::add_to_graphics_scene<PH2>() \endlink
- Polyhedron_3 \link PkgDrawPolyhedron CGAL::add_to_graphics_scene<POLY>() \endlink
- Surface_mesh \link PkgDrawSurfaceMesh CGAL::add_to_graphics_scene<SM>() \endlink
- Surface_mesh_topology \link PkgDrawFaceGraphWithPaths CGAL::add_to_graphics_scene<SMT>() \endlink
- Triangulation_2 \link PkgDrawTriangulation2 CGAL::add_to_graphics_scene<T2>() \endlink
- Triangulation_3 \link PkgDrawTriangulation3 CGAL::add_to_graphics_scene<T3>() \endlink
- Voronoi_diagram_2 \link PkgDrawVoronoiDiagram2 CGAL::add_to_graphics_scene<V2>() \endlink
- `CGAL::Arrangement_2` \link PkgArrangementOnSurface2Draw CGAL::add_to_graphics_scene<ARR>() \endlink
- `CGAL::Constrained_triangulation_2` \link PkgDrawTriangulation2 CGAL::add_to_graphics_scene<CT2>() \endlink
- `CGAL::Linear_cell_complex` \link PkgDrawLinearCellComplex CGAL::add_to_graphics_scene<LCC>() \endlink
- `CGAL::Nef_polyhedron_3` \link PkgDrawNef3 CGAL::add_to_graphics_scene<Nef3>() \endlink
- `CGAL::Periodic_2_Triangulation_2` \link PkgDrawPeriodic2Triangulation2 CGAL::add_to_graphics_scene<P2T2>() \endlink
- `CGAL::Point_set_3` \link PkgDrawPointSet3D CGAL::add_to_graphics_scene<PS>() \endlink
- `CGAL::Polygon_2` \link PkgDrawPolygon2 CGAL::add_to_graphics_scene<P2>() \endlink
- `CGAL::Polygon_set_2` \link PkgDrawPolygonSet2 CGAL::add_to_graphics_scene<PS>() \endlink
- `CGAL::Polygon_with_holes_2` \link PkgDrawPolygonWithHoles2 CGAL::add_to_graphics_scene<PH2>() \endlink
- `CGAL::Polyhedron_3` \link PkgDrawPolyhedron CGAL::add_to_graphics_scene<POLY>() \endlink
- `CGAL::Surface_mesh` \link PkgDrawSurfaceMesh CGAL::add_to_graphics_scene<SM>() \endlink
- `CGAL::Surface_mesh_topology` \link PkgDrawFaceGraphWithPaths CGAL::add_to_graphics_scene<SMT>() \endlink
- `CGAL::Triangulation_2` \link PkgDrawTriangulation2 CGAL::add_to_graphics_scene<T2>() \endlink
- `CGAL::Triangulation_3` \link PkgDrawTriangulation3 CGAL::add_to_graphics_scene<T3>() \endlink
- `CGAL::Voronoi_diagram_2` \link PkgDrawVoronoiDiagram2 CGAL::add_to_graphics_scene<V2>() \endlink
*/