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

doc

This commit is contained in:
Guillaume Damiand 2023-06-23 13:24:38 +02:00
parent 0fe120ba20
commit b9a4f86dbc
6 changed files with 29 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Basic_viewer/doc/Basic_viewer/Basic_viewer.txt
View File

@ -29,7 +29,7 @@ Drawing_functor
\subsection Basic_viewerExamples_simple_draw Basic draw \subsection Basic_viewerExamples_simple_draw Basic draw
\cgalExample{Linear_cell_complex/draw_linear_cell_complex.cpp} \cgalExample{Surface_mesh/draw_surface_mesh.cpp}
\subsection Basic_viewerExamples_custom_color Change Face Colors \subsection Basic_viewerExamples_custom_color Change Face Colors

3
Basic_viewer/doc/Basic_viewer/CGAL/Qt/Basic_viewer_qt.h
View File

@ -246,7 +246,8 @@ public:
*/ */
template <typename BufferType=float> template <typename BufferType=float>
void draw_graphic_storage(Graphic_storage<BufferType>& graphic_buffer, void draw_graphic_storage(Graphic_storage<BufferType>& graphic_buffer,
const char *title="CGAL Basic Viewer"); const char *title="CGAL Basic Viewer")
{}
} // End namespace CGAL } // End namespace CGAL

2
Basic_viewer/doc/Basic_viewer/Doxyfile.in
View File

@ -1,3 +1,5 @@
@INCLUDE = ${CGAL_DOC_PACKAGE_DEFAULTS} @INCLUDE = ${CGAL_DOC_PACKAGE_DEFAULTS}
PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - CGAL Basic Viewer" PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - CGAL Basic Viewer"
EXAMPLE_PATH += ${CGAL_Surface_mesh_EXAMPLE_DIR}

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

@ -10,7 +10,7 @@
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Guillaume Damiand} \cgalPkgAuthor{Guillaume Damiand}
\cgalPkgDesc{This package implements basic viewer class.} \cgalPkgDesc{This package implements basic viewer class.}
\cgalPkgManuals{Chapter_Basic_Viewer,PkgBasicViewerRef} \cgalPkgManuals{Chapter_Basic_viewer,PkgBasicViewerRef}
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{6.0} \cgalPkgSince{6.0}
@ -28,12 +28,12 @@
- `CGAL::Basic_viewer_qt<BufferType>` - `CGAL::Basic_viewer_qt<BufferType>`
- `CGAL::QApplication_and_basic_viewer<BufferType>` - `CGAL::QApplication_and_basic_viewer<BufferType>`
\cgalCRPSubsection{Draw functions of a graphic storage} \cgalCRPSubsection{Draw a Graphic Storage}
- `CGAL::draw_graphic_storage()` - `CGAL::draw_graphic_storage()`
\cgalCRPSubsection{Draw functions for different packages} \cgalCRPSubsection{Draw for Different Packages}
- \link PkgDrawTriangulation2 Constrained_triangulation_2 CGAL::draw<CT2>() \endlink - \link PkgDrawTriangulation2 Constrained_triangulation_2 CGAL::draw<CT2>() \endlink
- \link PkgDrawLinearCellComplex Linear_cell_complex CGAL::draw<LCC>() \endlink - \link PkgDrawLinearCellComplex Linear_cell_complex CGAL::draw<LCC>() \endlink
@ -50,8 +50,22 @@
- \link PkgDrawTriangulation3 Triangulation_3 CGAL::draw<T3>() \endlink - \link PkgDrawTriangulation3 Triangulation_3 CGAL::draw<T3>() \endlink
- \link PkgDrawVoronoiDiagram2 Voronoi_diagram_2 CGAL::draw<V2>() \endlink - \link PkgDrawVoronoiDiagram2 Voronoi_diagram_2 CGAL::draw<V2>() \endlink
\cgalCRPSubsection{Fill graphic storage functions} \cgalCRPSubsection{Fill Graphic Storage for Different Packages}
- \link PkgDrawLinearCellComplex CGAL::CGAL::add_in_graphic_storage<LCC, BufferType, DrawingFunctor>() \endlink
- \link PkgDrawTriangulation2 Constrained_triangulation_2 CGAL::add_in_graphic_storage<CT2>() \endlink
- \link PkgDrawLinearCellComplex Linear_cell_complex CGAL::add_in_graphic_storage<LCC>() \endlink
- \link PkgDrawNef3 Nef_polyhedron_3 CGAL::add_in_graphic_storage<Nef3>() \endlink
- \link PkgDrawPeriodic2Triangulation2 Periodic_2_Triangulation_2 CGAL::add_in_graphic_storage<P2T2>() \endlink
- \link PkgDrawPointSet3D Point_set_3 CGAL::add_in_graphic_storage<PS>() \endlink
- \link PkgDrawPolygon2 Polygon_2 CGAL::add_in_graphic_storage<P2>() \endlink
- \link PkgDrawPolygonSet2 Polygon_set_2 CGAL::add_in_graphic_storage<PS>() \endlink
- \link PkgDrawPolygonWithHoles2 Polygon_with_holes_2 CGAL::add_in_graphic_storage<PH2>() \endlink
- \link PkgDrawPolyhedron Polyhedron_3 CGAL::add_in_graphic_storage<POLY>() \endlink
- \link PkgDrawSurfaceMesh Surface_mesh CGAL::add_in_graphic_storage<SM>() \endlink
- \link PkgDrawFaceGraphWithPaths Surface_mesh_topology CGAL::add_in_graphic_storage<SMT>() \endlink
- \link PkgDrawTriangulation2 Triangulation_2 CGAL::add_in_graphic_storage<T2>() \endlink
- \link PkgDrawTriangulation3 Triangulation_3 CGAL::add_in_graphic_storage<T3>() \endlink
- \link PkgDrawVoronoiDiagram2 Voronoi_diagram_2 CGAL::add_in_graphic_storage<V2>() \endlink
*/ */

9
Basic_viewer/doc/Basic_viewer/dependencies
View File

@ -1,12 +1,11 @@
Manual Manual
Boolean_set_operations_2 Boolean_set_operations_2
Constrained_triangulation_2
Linear_cell_complex Linear_cell_complex
Nef_polyhedron_3 Nef_3
Periodic_2_Triangulation_2 Periodic_2_triangulation_2
Point_set_3 Point_set_3
Polygon_2 Polygon
Polyhedron_3 Polyhedron
Surface_mesh Surface_mesh
Surface_mesh_topology Surface_mesh_topology
Triangulation_2 Triangulation_2

2
Basic_viewer/doc/Basic_viewer/examples.txt
View File

@ -1,5 +1,5 @@
/*! /*!
\example Linear_cell_complex/draw_linear_cell_complex.cpp \example Surface_mesh/draw_surface_mesh.cpp
\example Basic_viewer/draw_mesh_and_points.cpp \example Basic_viewer/draw_mesh_and_points.cpp
\example Basic_viewer/draw_several_windows.cpp \example Basic_viewer/draw_several_windows.cpp
\example Basic_viewer/draw_surface_mesh_height.cpp \example Basic_viewer/draw_surface_mesh_height.cpp