Skip to content

Commit 05f4793

Browse files
committed
undo doc changes
1 parent a9c8a49 commit 05f4793

File tree

29 files changed

+63
-58
lines changed

29 files changed

+63
-58
lines changed

Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6859,8 +6859,8 @@ An arrangement data structure can be visualized by calling the \link PkgArrangem
68596859

68606860
\cgalExample{Arrangement_on_surface_2/draw_arr.cpp}
68616861

6862-
This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER_QT` is defined.
6863-
Linking with the cmake target `CGAL::CGAL_Basic_viewer_Qt` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER_QT`.
6862+
This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
6863+
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
68646864

68656865
\cgalFigureBegin{aos_fig-draw_arr,draw_arr.png}
68666866
A snapshot of the window created by the program

Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/draw_arrangement_2.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ namespace CGAL {
2929
* `CGAL::Arrangement_2` class template. Parameters of the drawing are taken
3030
* from the optional graphics scene options parameter.
3131
*
32-
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_QT` (Qt viewer) is defined.
33-
Linking with the cmake target `CGAL::CGAL_Basic_viewer_Qt` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER_QT`.
32+
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` (Qt viewer) is defined.
33+
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
3434
*
3535
* \tparam GeometryTraits_2 a geometry traits type, a model of a 2D arrangement
3636
* traits concept. At this point it must be an instance of either

Basic_viewer/doc/Basic_viewer/CGAL/Qt/Basic_viewer.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ namespace CGAL {
55
/*!
66
\ingroup PkgBasicViewerClasses
77
8-
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_QT` is defined. Linking with the cmake target `CGAL::CGAL_Basic_viewer_Qt` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER_QT`.
8+
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`.
99
1010
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>.
1111
*/
@@ -207,7 +207,7 @@ class Basic_viewer : public CGAL::QGLViewer
207207
208208
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.
209209
210-
This class requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER_QT` is defined. Linking with the cmake target `CGAL::CGAL_Basic_viewer_Qt` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER_QT`.
210+
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`.
211211
212212
*/
213213
class QApplication_and_basic_viewer
@@ -230,7 +230,7 @@ class QApplication_and_basic_viewer
230230
/*!
231231
\ingroup PkgBasicViewerClasses
232232
233-
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_QT` is defined. Linking with the cmake target `CGAL::CGAL_Basic_viewer_Qt` will link with `CGAL_Qt6` and add the definition CGAL_USE_BASIC_VIEWER_QT.
233+
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.
234234
*/
235235
void draw_graphics_scene(const Graphics_scene& graphic_scene,
236236
const char *title="CGAL Basic Viewer")

Basic_viewer/include/CGAL/Basic_viewer.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@
1616
#include <CGAL/license/GraphicsView.h>
1717
#include <CGAL/Graphics_scene.h>
1818

19+
// compatibility
20+
#if defined(CGAL_USE_BASIC_VIEWER) && !defined(CGAL_USE_BASIC_VIEWER_QT)
21+
#define CGAL_USE_BASIC_VIEWER 1
22+
#endif
23+
1924
#if defined(CGAL_USE_BASIC_VIEWER_QT)
2025
#include <CGAL/Qt/Basic_viewer.h>
2126
// #elif defined(CGAL_USE_BASIC_VIEWER_GLFW)
@@ -27,7 +32,7 @@ namespace CGAL
2732
void draw_graphics_scene(const Graphics_scene&,
2833
const char* ="CGAL Basic Viewer")
2934
{
30-
std::cerr<<"Impossible to draw, CGAL_USE_BASIC_VIEWER_QT is not defined."<<std::endl;
35+
std::cerr<<"Impossible to draw, CGAL_USE_BASIC_VIEWER is not defined."<<std::endl;
3136
}
3237
} // End namespace CGAL
3338
#endif

Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/draw_polygon_set_2.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ struct Graphics_scene_options_polygon_set_2: public CGAL::Graphics_scene_options
2727
2828
opens a new window and draws a 2D polygon set. Parameters of the drawing are taken from the optional graphics scene options parameter.
2929
30-
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`/`CGAL_USE_BASIC_VIEWER_QT` (Qt viewer) is defined.
31-
Linking with the cmake target `CGAL::CGAL_Basic_viewer`/`CGAL::CGAL_Basic_viewer_Qt` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`/`CGAL_USE_BASIC_VIEWER_QT`.
30+
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`/`CGAL_USE_BASIC_VIEWER` (Qt viewer) is defined.
31+
Linking with the cmake target `CGAL::CGAL_Basic_viewer`/`CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`/`CGAL_USE_BASIC_VIEWER`.
3232
3333
\tparam PS2 which must be an instantiation of a `CGAL::Polygon_set_2<...>`.
3434
\tparam GSOptions a model of `GraphicsSceneOptionsPolygonSet2` concept.

Documentation/doc/Documentation/Developer_manual/create_and_use_a_cmakelist.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This section describes a minimal example of a program that uses \cgal and Qt6 fo
4343

4444

4545
\skip if(CGAL_Qt6_FOUND)
46-
\until target_link_libraries(draw_surface_mesh PRIVATE CGAL::CGAL_Basic_viewer_Qt)
46+
\until target_link_libraries(draw_surface_mesh PRIVATE CGAL::CGAL_Basic_viewer)
4747
\skip endif
4848
\until #end of the file
4949

Linear_cell_complex/doc/Linear_cell_complex/CGAL/draw_linear_cell_complex.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ namespace CGAL {
55
66
opens a new window and draws a linear cell complex. Parameters of the drawing are taken from the optional graphics scene options parameter.
77
8-
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_QT` (Qt viewer) is defined.
9-
Linking with the cmake target `CGAL::CGAL_Basic_viewer_Qt` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER_QT`.
8+
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` (Qt viewer) is defined.
9+
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
1010
1111
\tparam LCC which must be an instantiation of a `CGAL::Linear_cell_complex_for_combinatorial_map<...>` or `CGAL::Linear_cell_complex_for_generalized_map<...>`.
1212
\tparam GSOptions a model of `GraphicsSceneOptions` concept.

Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,8 +265,8 @@ A linear cell complex can be visualized by calling the \link PkgDrawLinearCellCo
265265

266266
\cgalExample{Linear_cell_complex/draw_linear_cell_complex.cpp}
267267

268-
This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER_QT` is defined.
269-
Linking with the cmake target `CGAL::CGAL_Basic_viewer_Qt` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER_QT`.
268+
This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
269+
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
270270

271271
\cgalFigureBegin{fig_draw_lcc,draw_lcc.png}
272272
Result of the run of the draw_linear_cell_complex program. A window shows two 3D cubes and allows to navigate through the 3D scene.

Nef_3/doc/Nef_3/CGAL/draw_nef_3.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ namespace CGAL {
55
66
opens a new window and draws a nef polyhedron. Parameters of the drawing are taken from the optional graphics scene options parameter.
77
8-
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_QT` (Qt viewer) is defined.
9-
Linking with the cmake target `CGAL::CGAL_Basic_viewer_Qt` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER_QT`.
8+
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` (Qt viewer) is defined.
9+
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
1010
1111
\tparam NP3 which must be an instantiation of a `CGAL::Nef_polyhedron_3<...>`.
1212
\tparam GSOptions a model of `GraphicsSceneOptions` concept.

Nef_3/doc/Nef_3/Nef_3.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -424,8 +424,8 @@ A nef polyhedron can be visualized by calling the \link PkgDrawNef3 CGAL::draw<N
424424

425425
\cgalExample{Nef_3/draw_nef_3.cpp}
426426

427-
This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER_QT` is defined.
428-
Linking with the cmake target `CGAL::CGAL_Basic_viewer_Qt` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER_QT`.
427+
This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
428+
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
429429

430430
\cgalFigureBegin{fig_draw_nef_polyhedron, draw_nef_3.png}
431431
Result of the run of the draw_nef_3 program. A window shows the nef polyhedron and allows to navigate through the 3D scene.

0 commit comments

Comments
 (0)