diff --git a/Basic_viewer/doc/Basic_viewer/CGAL/Qt/Basic_viewer.h b/Basic_viewer/doc/Basic_viewer/CGAL/Qt/Basic_viewer.h index 34c72f8c70a..2ed9bec56be 100644 --- a/Basic_viewer/doc/Basic_viewer/CGAL/Qt/Basic_viewer.h +++ b/Basic_viewer/doc/Basic_viewer/CGAL/Qt/Basic_viewer.h @@ -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 QGLViewer class which is A versatile 3D OpenGL viewer based on QOpenGLWidget. */ @@ -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") diff --git a/Basic_viewer/doc/Basic_viewer/PackageDescription.txt b/Basic_viewer/doc/Basic_viewer/PackageDescription.txt index d85d6ab1927..4e505a4b6a2 100644 --- a/Basic_viewer/doc/Basic_viewer/PackageDescription.txt +++ b/Basic_viewer/doc/Basic_viewer/PackageDescription.txt @@ -40,36 +40,38 @@ \cgalCRPSubsection{Draw for Different Packages} -- `Constrained_triangulation_2` \link PkgDrawTriangulation2 CGAL::draw() \endlink -- `Linear_cell_complex` \link PkgDrawLinearCellComplex CGAL::draw() \endlink -- `Nef_polyhedron_3` \link PkgDrawNef3 CGAL::draw() \endlink -- `Periodic_2_Triangulation_2` \link PkgDrawPeriodic2Triangulation2 CGAL::draw() \endlink -- `Point_set_3` \link PkgDrawPointSet3D CGAL::draw() \endlink -- `Polygon_2` \link PkgDrawPolygon2 CGAL::draw() \endlink -- `Polygon_set_2` \link PkgDrawPolygonSet2 CGAL::draw() \endlink -- `Polygon_with_holes_2` \link PkgDrawPolygonWithHoles2 CGAL::draw() \endlink -- `Polyhedron_3` \link PkgDrawPolyhedron CGAL::draw() \endlink -- `Surface_mesh` \link PkgDrawSurfaceMesh CGAL::draw() \endlink -- `Surface_mesh_topology` \link PkgDrawFaceGraphWithPaths CGAL::draw() \endlink -- `Triangulation_2` \link PkgDrawTriangulation2 CGAL::draw() \endlink -- `Triangulation_3` \link PkgDrawTriangulation3 CGAL::draw() \endlink -- `Voronoi_diagram_2` \link PkgDrawVoronoiDiagram2 CGAL::draw() \endlink +- `CGAL::Arrangement_2` \link PkgArrangementOnSurface2Draw CGAL::draw() \endlink +- `CGAL::Constrained_triangulation_2` \link PkgDrawTriangulation2 CGAL::draw() \endlink +- `CGAL::Linear_cell_complex` \link PkgDrawLinearCellComplex CGAL::draw() \endlink +- `CGAL::Nef_polyhedron_3` \link PkgDrawNef3 CGAL::draw() \endlink +- `CGAL::Periodic_2_Triangulation_2` \link PkgDrawPeriodic2Triangulation2 CGAL::draw() \endlink +- `CGAL::Point_set_3` \link PkgDrawPointSet3D CGAL::draw() \endlink +- `CGAL::Polygon_2` \link PkgDrawPolygon2 CGAL::draw() \endlink +- `CGAL::Polygon_set_2` \link PkgDrawPolygonSet2 CGAL::draw() \endlink +- `CGAL::Polygon_with_holes_2` \link PkgDrawPolygonWithHoles2 CGAL::draw() \endlink +- `CGAL::Polyhedron_3` \link PkgDrawPolyhedron CGAL::draw() \endlink +- `CGAL::Surface_mesh` \link PkgDrawSurfaceMesh CGAL::draw() \endlink +- `CGAL::Surface_mesh_topology` \link PkgDrawFaceGraphWithPaths CGAL::draw() \endlink +- `CGAL::Triangulation_2` \link PkgDrawTriangulation2 CGAL::draw() \endlink +- `CGAL::Triangulation_3` \link PkgDrawTriangulation3 CGAL::draw() \endlink +- `CGAL::Voronoi_diagram_2` \link PkgDrawVoronoiDiagram2 CGAL::draw() \endlink \cgalCRPSubsection{Fill Graphics Scene for Different Packages} -- Constrained_triangulation_2 \link PkgDrawTriangulation2 CGAL::add_to_graphics_scene() \endlink -- Linear_cell_complex \link PkgDrawLinearCellComplex CGAL::add_to_graphics_scene() \endlink -- Nef_polyhedron_3 \link PkgDrawNef3 CGAL::add_to_graphics_scene() \endlink -- Periodic_2_Triangulation_2 \link PkgDrawPeriodic2Triangulation2 CGAL::add_to_graphics_scene() \endlink -- Point_set_3 \link PkgDrawPointSet3D CGAL::add_to_graphics_scene() \endlink -- Polygon_2 \link PkgDrawPolygon2 CGAL::add_to_graphics_scene() \endlink -- Polygon_set_2 \link PkgDrawPolygonSet2 CGAL::add_to_graphics_scene() \endlink -- Polygon_with_holes_2 \link PkgDrawPolygonWithHoles2 CGAL::add_to_graphics_scene() \endlink -- Polyhedron_3 \link PkgDrawPolyhedron CGAL::add_to_graphics_scene() \endlink -- Surface_mesh \link PkgDrawSurfaceMesh CGAL::add_to_graphics_scene() \endlink -- Surface_mesh_topology \link PkgDrawFaceGraphWithPaths CGAL::add_to_graphics_scene() \endlink -- Triangulation_2 \link PkgDrawTriangulation2 CGAL::add_to_graphics_scene() \endlink -- Triangulation_3 \link PkgDrawTriangulation3 CGAL::add_to_graphics_scene() \endlink -- Voronoi_diagram_2 \link PkgDrawVoronoiDiagram2 CGAL::add_to_graphics_scene() \endlink +- `CGAL::Arrangement_2` \link PkgArrangementOnSurface2Draw CGAL::add_to_graphics_scene() \endlink +- `CGAL::Constrained_triangulation_2` \link PkgDrawTriangulation2 CGAL::add_to_graphics_scene() \endlink +- `CGAL::Linear_cell_complex` \link PkgDrawLinearCellComplex CGAL::add_to_graphics_scene() \endlink +- `CGAL::Nef_polyhedron_3` \link PkgDrawNef3 CGAL::add_to_graphics_scene() \endlink +- `CGAL::Periodic_2_Triangulation_2` \link PkgDrawPeriodic2Triangulation2 CGAL::add_to_graphics_scene() \endlink +- `CGAL::Point_set_3` \link PkgDrawPointSet3D CGAL::add_to_graphics_scene() \endlink +- `CGAL::Polygon_2` \link PkgDrawPolygon2 CGAL::add_to_graphics_scene() \endlink +- `CGAL::Polygon_set_2` \link PkgDrawPolygonSet2 CGAL::add_to_graphics_scene() \endlink +- `CGAL::Polygon_with_holes_2` \link PkgDrawPolygonWithHoles2 CGAL::add_to_graphics_scene() \endlink +- `CGAL::Polyhedron_3` \link PkgDrawPolyhedron CGAL::add_to_graphics_scene() \endlink +- `CGAL::Surface_mesh` \link PkgDrawSurfaceMesh CGAL::add_to_graphics_scene() \endlink +- `CGAL::Surface_mesh_topology` \link PkgDrawFaceGraphWithPaths CGAL::add_to_graphics_scene() \endlink +- `CGAL::Triangulation_2` \link PkgDrawTriangulation2 CGAL::add_to_graphics_scene() \endlink +- `CGAL::Triangulation_3` \link PkgDrawTriangulation3 CGAL::add_to_graphics_scene() \endlink +- `CGAL::Voronoi_diagram_2` \link PkgDrawVoronoiDiagram2 CGAL::add_to_graphics_scene() \endlink */