From 32bf996787ace4060bc32202287bc46308998d07 Mon Sep 17 00:00:00 2001 From: Liangliang Nan Date: Mon, 10 Feb 2025 12:07:02 +0100 Subject: [PATCH] documentation --- docs/Doxyfile.in | 4 ++-- easy3d/core/mat.h | 4 ++-- easy3d/util/version.h | 2 +- tutorials/Tutorial_101_PointCloud/main.cpp | 4 +--- tutorials/Tutorial_102_PointCloud_Property/main.cpp | 4 +--- tutorials/Tutorial_103_PointCloud_IO/main.cpp | 4 +--- tutorials/Tutorial_104_SurfaceMesh/main.cpp | 4 +--- tutorials/Tutorial_105_SurfaceMesh_Connectivity/main.cpp | 4 +--- tutorials/Tutorial_106_SurfaceMesh_Property/main.cpp | 4 +--- tutorials/Tutorial_107_SurfaceMesh_IO/main.cpp | 4 +--- tutorials/Tutorial_108_Graph/main.cpp | 4 +--- tutorials/Tutorial_109_Graph_Connectivity/main.cpp | 4 +--- tutorials/Tutorial_110_Graph_Property/main.cpp | 4 +--- tutorials/Tutorial_111_Graph_IO/main.cpp | 4 +--- tutorials/Tutorial_112_PolyMesh/main.cpp | 4 +--- tutorials/Tutorial_113_PolyMesh_Connectivity/main.cpp | 4 +--- tutorials/Tutorial_114_PolyMesh_Property/main.cpp | 4 +--- tutorials/Tutorial_115_PolyMesh_IO/main.cpp | 4 +--- tutorials/Tutorial_201_Viewer_default/main.cpp | 4 +--- tutorials/Tutorial_202_Viewer_imgui/main.cpp | 7 +++---- tutorials/Tutorial_203_Viewer_wxWidgets/main.cpp | 5 ++--- tutorials/Tutorial_204_Viewer_Qt/main.cpp | 4 +--- tutorials/Tutorial_205_MultiView/main.cpp | 4 +--- tutorials/Tutorial_206_CameraInterpolation/main.cpp | 4 +--- tutorials/Tutorial_207_RealCamera/main.cpp | 5 ++--- tutorials/Tutorial_301_Drawables/main.cpp | 5 ++--- tutorials/Tutorial_302_Imposters/main.cpp | 4 +--- tutorials/Tutorial_303_ScalarField/main.cpp | 4 +--- tutorials/Tutorial_304_VectorField/main.cpp | 4 +--- tutorials/Tutorial_305_Texture/main.cpp | 4 +--- tutorials/Tutorial_306_ImageViewer/main.cpp | 5 ++--- tutorials/Tutorial_307_CrossSection/main.cpp | 5 ++--- tutorials/Tutorial_308_TexturedMesh/main.cpp | 5 ++--- tutorials/Tutorial_309_TextRendering/main.cpp | 5 ++--- tutorials/Tutorial_310_TextMesher/main.cpp | 4 +--- tutorials/Tutorial_311_Animation/main.cpp | 4 +--- tutorials/Tutorial_312_MultiThread/main.cpp | 4 +--- tutorials/Tutorial_401_ModelPicker/main.cpp | 5 ++--- tutorials/Tutorial_402_FacePicker/main.cpp | 5 ++--- tutorials/Tutorial_403_PointSelection/main.cpp | 5 ++--- tutorials/Tutorial_404_VirtualScanner/main.cpp | 5 ++--- tutorials/Tutorial_405_ObjectManipulation/main.cpp | 5 ++--- tutorials/Tutorial_406_CollisionDetection/main.cpp | 5 ++--- tutorials/Tutorial_501_AmbientOcclusion/main.cpp | 5 ++--- tutorials/Tutorial_502_HardShadow/main.cpp | 5 ++--- tutorials/Tutorial_503_SoftShadow/main.cpp | 5 ++--- tutorials/Tutorial_504_Transparency/main.cpp | 5 ++--- tutorials/Tutorial_505_EyeDomeLighting/main.cpp | 5 ++--- tutorials/Tutorial_506_DepthMap/main.cpp | 6 ++---- tutorials/Tutorial_601_Tessellator/main.cpp | 4 +--- tutorials/Tutorial_602_ConvexPartition/main.cpp | 4 +--- tutorials/Tutorial_603_Curves/main.cpp | 4 +--- tutorials/Tutorial_701_Cloud_NormalEstimation/main.cpp | 4 +--- .../Tutorial_702_Cloud_SurfaceReconstruction/main.cpp | 4 +--- tutorials/Tutorial_703_Cloud_PlaneExtraction/main.cpp | 4 +--- 55 files changed, 78 insertions(+), 163 deletions(-) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 01585e37..428492f7 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -1558,7 +1558,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -1673,7 +1673,7 @@ PDF_HYPERLINKS = YES # The default value is: YES. # This tag requires that the tag GENERATE_LATEX is set to YES. -USE_PDFLATEX = YES +USE_PDFLATEX = NO # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode # command to the generated LaTeX files. This will instruct LaTeX to keep running diff --git a/easy3d/core/mat.h b/easy3d/core/mat.h index e3cfd1f4..65b74efd 100755 --- a/easy3d/core/mat.h +++ b/easy3d/core/mat.h @@ -1620,7 +1620,7 @@ namespace easy3d { template class Quat; /** - * \brief 3x3 matrix. Extends Mat with 3D-specific functionality and constructors. + * \brief 3 by 3 matrix. Extends Mat with 3D-specific functionality and constructors. * \tparam T The scalar type for vector elements. \see Mat. * \class Mat3 easy3d/core/mat.h */ @@ -1953,7 +1953,7 @@ namespace easy3d { *******************************************************************************/ /** - * \brief 4x4 matrix. Extends Mat with 4D-specific functionality and constructors. + * \brief 4 by 4 matrix. Extends Mat with 4D-specific functionality and constructors. * \tparam T The scalar type for vector elements. \see Mat. * \class Mat4 easy3d/core/mat.h */ diff --git a/easy3d/util/version.h b/easy3d/util/version.h index ecf95b9d..38e6401b 100644 --- a/easy3d/util/version.h +++ b/easy3d/util/version.h @@ -59,7 +59,7 @@ namespace easy3d { #define EASY3D_VERSION_NR 1020601 /// Easy3D release date, in the format YYYYMMDD. -#define EASY3D_RELEASE_DATE 20250207 +#define EASY3D_RELEASE_DATE 20250210 #endif // EASY3D_UTIL_VERSION_H diff --git a/tutorials/Tutorial_101_PointCloud/main.cpp b/tutorials/Tutorial_101_PointCloud/main.cpp index 46da8795..2b174242 100644 --- a/tutorials/Tutorial_101_PointCloud/main.cpp +++ b/tutorials/Tutorial_101_PointCloud/main.cpp @@ -28,10 +28,8 @@ #include /** - * \example{lineno} Tutorial_101_PointCloud + * \example{lineno} Tutorial_101_PointCloud/main.cpp * This example shows how to create a point cloud from a set of points - * - * \include{lineno} Tutorial_101_PointCloud/main.cpp */ diff --git a/tutorials/Tutorial_102_PointCloud_Property/main.cpp b/tutorials/Tutorial_102_PointCloud_Property/main.cpp index 66771d78..3a82b99f 100644 --- a/tutorials/Tutorial_102_PointCloud_Property/main.cpp +++ b/tutorials/Tutorial_102_PointCloud_Property/main.cpp @@ -29,10 +29,8 @@ #include /** - * \example{lineno} Tutorial_102_PointCloud_Property + * \example{lineno} Tutorial_102_PointCloud_Property/main.cpp * This example shows how to add per-point properties to a point cloud and access its properties. - * - * \include{lineno} Tutorial_102_PointCloud_Property/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_103_PointCloud_IO/main.cpp b/tutorials/Tutorial_103_PointCloud_IO/main.cpp index 12380333..e404ea08 100644 --- a/tutorials/Tutorial_103_PointCloud_IO/main.cpp +++ b/tutorials/Tutorial_103_PointCloud_IO/main.cpp @@ -30,10 +30,8 @@ #include /** - * \example{lineno} Tutorial_103_PointCloud_IO + * \example{lineno} Tutorial_103_PointCloud_IO/main.cpp * This example shows how to load a point cloud from a file and save a point cloud to a file. - * - * \include{lineno} Tutorial_103_PointCloud_IO/main.cpp */ diff --git a/tutorials/Tutorial_104_SurfaceMesh/main.cpp b/tutorials/Tutorial_104_SurfaceMesh/main.cpp index 4cb560dd..9634dc56 100644 --- a/tutorials/Tutorial_104_SurfaceMesh/main.cpp +++ b/tutorials/Tutorial_104_SurfaceMesh/main.cpp @@ -29,10 +29,8 @@ #include /** - * \example{lineno} Tutorial_104_SurfaceMesh + * \example{lineno} Tutorial_104_SurfaceMesh/main.cpp * This example shows how to construct a mesh from its vertices and known connectivity. - * - * \include{lineno} Tutorial_104_SurfaceMesh/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_105_SurfaceMesh_Connectivity/main.cpp b/tutorials/Tutorial_105_SurfaceMesh_Connectivity/main.cpp index 54d2f6f7..58939e49 100644 --- a/tutorials/Tutorial_105_SurfaceMesh_Connectivity/main.cpp +++ b/tutorials/Tutorial_105_SurfaceMesh_Connectivity/main.cpp @@ -28,7 +28,7 @@ #include /** - * \example{lineno} Tutorial_105_SurfaceMesh_Connectivity + * \example{lineno} Tutorial_105_SurfaceMesh_Connectivity/main.cpp * This example shows how to access the adjacency information of a surface mesh, i.e., * - the incident vertices of each vertex * - the incident outgoing/ingoing edges of each vertex @@ -37,8 +37,6 @@ * - the incident half-edges of each face * - the two end points of each edge; * - the two faces connected by each edge - * - * \include{lineno} Tutorial_105_SurfaceMesh_Connectivity/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_106_SurfaceMesh_Property/main.cpp b/tutorials/Tutorial_106_SurfaceMesh_Property/main.cpp index 6d57a523..bb72f0f4 100644 --- a/tutorials/Tutorial_106_SurfaceMesh_Property/main.cpp +++ b/tutorials/Tutorial_106_SurfaceMesh_Property/main.cpp @@ -28,11 +28,9 @@ #include /** - * \example{lineno} Tutorial_106_SurfaceMesh_Property + * \example{lineno} Tutorial_106_SurfaceMesh_Property/main.cpp * This example shows how to create and access properties defined on a surface mesh. * We use per-face properties as example, you should be able to do similarly for per-edge/vertex properties. - * - * \include{lineno} Tutorial_106_SurfaceMesh_Property/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_107_SurfaceMesh_IO/main.cpp b/tutorials/Tutorial_107_SurfaceMesh_IO/main.cpp index 4702ad59..b09268f4 100644 --- a/tutorials/Tutorial_107_SurfaceMesh_IO/main.cpp +++ b/tutorials/Tutorial_107_SurfaceMesh_IO/main.cpp @@ -30,12 +30,10 @@ #include /** - * \example{lineno} Tutorial_107_SurfaceMesh_IO + * \example{lineno} Tutorial_107_SurfaceMesh_IO/main.cpp * This example shows how to * - load a surface mesh from a file; * - save a surface mesh into a file. - * - * \include{lineno} Tutorial_107_SurfaceMesh_IO/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_108_Graph/main.cpp b/tutorials/Tutorial_108_Graph/main.cpp index ab2b324a..089d4c02 100644 --- a/tutorials/Tutorial_108_Graph/main.cpp +++ b/tutorials/Tutorial_108_Graph/main.cpp @@ -28,10 +28,8 @@ #include /** - * \example{lineno} Tutorial_108_Graph + * \example{lineno} Tutorial_108_Graph/main.cpp * This example shows how to construct a graph from its vertices and edges - * - * \include{lineno} Tutorial_108_Graph/main.cpp */ diff --git a/tutorials/Tutorial_109_Graph_Connectivity/main.cpp b/tutorials/Tutorial_109_Graph_Connectivity/main.cpp index f5493420..8c0609ad 100644 --- a/tutorials/Tutorial_109_Graph_Connectivity/main.cpp +++ b/tutorials/Tutorial_109_Graph_Connectivity/main.cpp @@ -28,13 +28,11 @@ #include /** - * \example{lineno} Tutorial_109_Graph_Connectivity + * \example{lineno} Tutorial_109_Graph_Connectivity/main.cpp * This example shows how to * - access the incident vertices of each vertex * - access the incident edges of each vertex * - access the two end points of each edge - * - * \include{lineno} Tutorial_109_Graph_Connectivity/main.cpp */ diff --git a/tutorials/Tutorial_110_Graph_Property/main.cpp b/tutorials/Tutorial_110_Graph_Property/main.cpp index 6e6a51ae..8ddbc39f 100644 --- a/tutorials/Tutorial_110_Graph_Property/main.cpp +++ b/tutorials/Tutorial_110_Graph_Property/main.cpp @@ -28,10 +28,8 @@ #include /** - * \example{lineno} Tutorial_110_Graph_Property + * \example{lineno} Tutorial_110_Graph_Property/main.cpp * This example shows how to add per-vertex/per-edge properties to a graph, and how to access existing properties. - * - * \include{lineno} Tutorial_110_Graph_Property/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_111_Graph_IO/main.cpp b/tutorials/Tutorial_111_Graph_IO/main.cpp index 5a6a2a64..f2b95cee 100644 --- a/tutorials/Tutorial_111_Graph_IO/main.cpp +++ b/tutorials/Tutorial_111_Graph_IO/main.cpp @@ -30,10 +30,8 @@ #include /** - * \example{lineno} Tutorial_111_Graph_IO + * \example{lineno} Tutorial_111_Graph_IO/main.cpp * This example shows how to load a graph from a file and save a graph into a file. - * - * \include{lineno} Tutorial_111_Graph_IO/main.cpp */ diff --git a/tutorials/Tutorial_112_PolyMesh/main.cpp b/tutorials/Tutorial_112_PolyMesh/main.cpp index 7afc45e3..b0de68f4 100644 --- a/tutorials/Tutorial_112_PolyMesh/main.cpp +++ b/tutorials/Tutorial_112_PolyMesh/main.cpp @@ -28,11 +28,9 @@ #include /** - * \example{lineno} Tutorial_112_PolyMesh + * \example{lineno} Tutorial_112_PolyMesh/main.cpp * This example shows how to construct a polyhedral mesh (consisting of a single tetrahedron) from its vertices * and known connectivity. - * - * \include{lineno} Tutorial_112_PolyMesh/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_113_PolyMesh_Connectivity/main.cpp b/tutorials/Tutorial_113_PolyMesh_Connectivity/main.cpp index 2e248ee8..3b7ae5fd 100644 --- a/tutorials/Tutorial_113_PolyMesh_Connectivity/main.cpp +++ b/tutorials/Tutorial_113_PolyMesh_Connectivity/main.cpp @@ -28,7 +28,7 @@ #include /** - * \example{lineno} Tutorial_113_PolyMesh_Connectivity + * \example{lineno} Tutorial_113_PolyMesh_Connectivity/main.cpp * This example shows how to access the adjacency information of a polyhedral mesh (consisting of a single tetrahedron): * - the incident vertices of each vertex * - the incident edges of each vertex @@ -45,8 +45,6 @@ * - the incident edges of each cell * - the incident halffaces of each cell * - the two halffaces of each face - * - * \include{lineno} Tutorial_113_PolyMesh_Connectivity/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_114_PolyMesh_Property/main.cpp b/tutorials/Tutorial_114_PolyMesh_Property/main.cpp index d1ebbf73..d1e06209 100644 --- a/tutorials/Tutorial_114_PolyMesh_Property/main.cpp +++ b/tutorials/Tutorial_114_PolyMesh_Property/main.cpp @@ -28,12 +28,10 @@ #include /** - * \example{lineno} Tutorial_114_PolyMesh_Property + * \example{lineno} Tutorial_114_PolyMesh_Property/main.cpp * This example shows how to create and access properties defined on a polyhedral mesh (consisting of a single * tetrahedron). We use per-face properties as example, you should be able to do similarly for per-edge/vertex/cell * properties as well. - * - * \include{lineno} Tutorial_114_PolyMesh_Property/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_115_PolyMesh_IO/main.cpp b/tutorials/Tutorial_115_PolyMesh_IO/main.cpp index 13397f29..d8b9b6d9 100644 --- a/tutorials/Tutorial_115_PolyMesh_IO/main.cpp +++ b/tutorials/Tutorial_115_PolyMesh_IO/main.cpp @@ -30,10 +30,8 @@ #include /** - * \example{lineno} Tutorial_115_PolyMesh_IO + * \example{lineno} Tutorial_115_PolyMesh_IO/main.cpp * This example shows how to load a polyhedral mesh from a file and save a polyhedral mesh into a file. - * - * \include{lineno} Tutorial_115_PolyMesh_IO/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_201_Viewer_default/main.cpp b/tutorials/Tutorial_201_Viewer_default/main.cpp index 670ade5e..2d7e99cd 100644 --- a/tutorials/Tutorial_201_Viewer_default/main.cpp +++ b/tutorials/Tutorial_201_Viewer_default/main.cpp @@ -30,10 +30,8 @@ #include /** - * \example{lineno} Tutorial_201_Viewer_default + * \example{lineno} Tutorial_201_Viewer_default/main.cpp * This example shows how to create a simple viewer using Easy3D. - * - * \include{lineno} Tutorial_201_Viewer_default/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_202_Viewer_imgui/main.cpp b/tutorials/Tutorial_202_Viewer_imgui/main.cpp index 2bca8b12..8e613bbc 100644 --- a/tutorials/Tutorial_202_Viewer_imgui/main.cpp +++ b/tutorials/Tutorial_202_Viewer_imgui/main.cpp @@ -31,17 +31,16 @@ #include "viewer.h" /** - * \example Tutorial_202_Viewer_imgui + * \example{lineno} Tutorial_202_Viewer_imgui/main.cpp * This example shows how to enhance the default Easy3D viewer with menus using ImGui. * - * The source file containing the main() function: - * \include{lineno} Tutorial_202_Viewer_imgui/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_202_Viewer_imgui/viewer.h - * The source file of viewer class class: + * The source file of viewer class: * \include{lineno} Tutorial_202_Viewer_imgui/viewer.cpp */ + using namespace easy3d; int main(int argc, char** argv) { diff --git a/tutorials/Tutorial_203_Viewer_wxWidgets/main.cpp b/tutorials/Tutorial_203_Viewer_wxWidgets/main.cpp index 54fd3dd2..b994c77e 100644 --- a/tutorials/Tutorial_203_Viewer_wxWidgets/main.cpp +++ b/tutorials/Tutorial_203_Viewer_wxWidgets/main.cpp @@ -25,7 +25,8 @@ ********************************************************************/ /** - * \example Tutorial_203_Viewer_wxWidgets + * \example{lineno} Tutorial_203_Viewer_wxWidgets/main.cpp + * * This example shows how to create a simple viewer using wxWidgets. * * The header file of the viewer class: @@ -40,8 +41,6 @@ * \include{lineno} Tutorial_203_Viewer_wxWidgets/application.h * The source file of the application class: * \include{lineno} Tutorial_203_Viewer_wxWidgets/application.cpp - * The source file containing the main() function: - * \include{lineno} Tutorial_203_Viewer_wxWidgets/main.cpp */ diff --git a/tutorials/Tutorial_204_Viewer_Qt/main.cpp b/tutorials/Tutorial_204_Viewer_Qt/main.cpp index f5b12d93..43e6e284 100644 --- a/tutorials/Tutorial_204_Viewer_Qt/main.cpp +++ b/tutorials/Tutorial_204_Viewer_Qt/main.cpp @@ -35,11 +35,9 @@ #include "window.h" /** - * \example Tutorial_204_Viewer_Qt + * \example{lineno} Tutorial_204_Viewer_Qt/main.cpp * This example shows how to create a simple viewer using Qt. * - * The source file containing the main() function: - * \include{lineno} Tutorial_204_Viewer_Qt/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_204_Viewer_Qt/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_205_MultiView/main.cpp b/tutorials/Tutorial_205_MultiView/main.cpp index 8158e7ec..ed731b62 100644 --- a/tutorials/Tutorial_205_MultiView/main.cpp +++ b/tutorials/Tutorial_205_MultiView/main.cpp @@ -35,10 +35,8 @@ #include /** - * \example{lineno} Tutorial_205_MultiView + * \example{lineno} Tutorial_205_MultiView/main.cpp * This example shows how to use the built-in multi-view viewer. - * - * \include{lineno} Tutorial_205_MultiView/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_206_CameraInterpolation/main.cpp b/tutorials/Tutorial_206_CameraInterpolation/main.cpp index bdd8f789..b38351fe 100644 --- a/tutorials/Tutorial_206_CameraInterpolation/main.cpp +++ b/tutorials/Tutorial_206_CameraInterpolation/main.cpp @@ -29,13 +29,11 @@ #include /** - * \example Tutorial_206_CameraInterpolation + * \example{lineno} Tutorial_206_CameraInterpolation/main.cpp * This example shows how to * - create an exploration path using the key frame interpolator, * - play the path as an animation. * - * The source file containing the main() function: - * \include{lineno} Tutorial_206_CameraInterpolation/main.cpp * The header file of the class: * \include{lineno} Tutorial_206_CameraInterpolation/viewer.h * The source file of the class: diff --git a/tutorials/Tutorial_207_RealCamera/main.cpp b/tutorials/Tutorial_207_RealCamera/main.cpp index 3a69b9d5..31d870b3 100644 --- a/tutorials/Tutorial_207_RealCamera/main.cpp +++ b/tutorials/Tutorial_207_RealCamera/main.cpp @@ -29,7 +29,8 @@ #include /** - * \example Tutorial_207_RealCamera + * \example{lineno} Tutorial_207_RealCamera/main.cpp + * * This example shows how to * - render a model from the view given the camera's intrinsic and * extrinsic parameters. The camera parameters were recovered using @@ -37,8 +38,6 @@ * - how an image point is projected into a ray in the 3D space. * - how a 3D point is projected onto the image. * - * The source file containing the main() function: - * \include{lineno} Tutorial_207_RealCamera/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_207_RealCamera/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_301_Drawables/main.cpp b/tutorials/Tutorial_301_Drawables/main.cpp index e37cb8f6..dce3c5d2 100644 --- a/tutorials/Tutorial_301_Drawables/main.cpp +++ b/tutorials/Tutorial_301_Drawables/main.cpp @@ -33,7 +33,8 @@ #include /** - * \example{lineno} Tutorial_301_Drawables + * \example{lineno} Tutorial_301_Drawables/main.cpp + * * Drawables are typically for rendering 3D models (e.g., point clouds, meshes, graphs) that are loaded from files or * generated by some algorithms. * The use of drawables for visualization is quite flexible. Drawables are normally attached to a 3D model. For example, @@ -49,8 +50,6 @@ * - a set of edges/lines in screen coordinates using `LinesDrawable2D`. * - create a drawable for a specific rendering purpose; * - use the viewer to visualize drawables. - * - * \include{lineno} Tutorial_301_Drawables/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_302_Imposters/main.cpp b/tutorials/Tutorial_302_Imposters/main.cpp index 7cf1e352..1426e429 100644 --- a/tutorials/Tutorial_302_Imposters/main.cpp +++ b/tutorials/Tutorial_302_Imposters/main.cpp @@ -34,13 +34,11 @@ #include /** - * \example{lineno} Tutorial_302_Imposters + * \example{lineno} Tutorial_302_Imposters/main.cpp * This example shows how to render imposters, e.g., * - points as spheres and surfels; * - lines as cylinders; * - lines as cones. - * - * \include{lineno} Tutorial_302_Imposters/main.cpp */ diff --git a/tutorials/Tutorial_303_ScalarField/main.cpp b/tutorials/Tutorial_303_ScalarField/main.cpp index 948ab396..0f2aa62f 100644 --- a/tutorials/Tutorial_303_ScalarField/main.cpp +++ b/tutorials/Tutorial_303_ScalarField/main.cpp @@ -34,10 +34,8 @@ #include /** - * \example{lineno} Tutorial_303_ScalarField + * \example{lineno} Tutorial_303_ScalarField/main.cpp * This example shows how to render a scalar field defined on vertices of a mesh. - * - * \include{lineno} Tutorial_303_ScalarField/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_304_VectorField/main.cpp b/tutorials/Tutorial_304_VectorField/main.cpp index 0f2592ba..068ded7f 100644 --- a/tutorials/Tutorial_304_VectorField/main.cpp +++ b/tutorials/Tutorial_304_VectorField/main.cpp @@ -32,10 +32,8 @@ #include /** - * \example{lineno} Tutorial_304_VectorField + * \example{lineno} Tutorial_304_VectorField/main.cpp * This example shows how to rendering a vector field defined on a surface mesh. - * - * \include{lineno} Tutorial_304_VectorField/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_305_Texture/main.cpp b/tutorials/Tutorial_305_Texture/main.cpp index 473a5f70..c908fbb8 100644 --- a/tutorials/Tutorial_305_Texture/main.cpp +++ b/tutorials/Tutorial_305_Texture/main.cpp @@ -34,10 +34,8 @@ #include /** - * \example{lineno} Tutorial_305_Texture + * \example{lineno} Tutorial_305_Texture/main.cpp * This example shows how to create a texture from an image and render a textured quad using the created texture. - * - * \include{lineno} Tutorial_305_Texture/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_306_ImageViewer/main.cpp b/tutorials/Tutorial_306_ImageViewer/main.cpp index ba1a4712..d0583871 100644 --- a/tutorials/Tutorial_306_ImageViewer/main.cpp +++ b/tutorials/Tutorial_306_ImageViewer/main.cpp @@ -29,11 +29,10 @@ #include /** - * \example Tutorial_306_ImageViewer + * \example{lineno} Tutorial_306_ImageViewer/main.cpp + * * This example shows how to render an images. * - * The source file containing the main() function: - * \include{lineno} Tutorial_306_ImageViewer/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_306_ImageViewer/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_307_CrossSection/main.cpp b/tutorials/Tutorial_307_CrossSection/main.cpp index ed8460d6..13f29c51 100644 --- a/tutorials/Tutorial_307_CrossSection/main.cpp +++ b/tutorials/Tutorial_307_CrossSection/main.cpp @@ -31,11 +31,10 @@ #include "viewer.h" /** - * \example Tutorial_307_CrossSection + * \example{lineno} Tutorial_307_CrossSection/main.cpp + * * This example shows how to render a model with a clipping plane or cross-sections. * - * The source file containing the main() function: - * \include{lineno} Tutorial_307_CrossSection/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_307_CrossSection/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_308_TexturedMesh/main.cpp b/tutorials/Tutorial_308_TexturedMesh/main.cpp index dc0c9662..71f7ed13 100755 --- a/tutorials/Tutorial_308_TexturedMesh/main.cpp +++ b/tutorials/Tutorial_308_TexturedMesh/main.cpp @@ -29,12 +29,11 @@ #include /** - * \example Tutorial_308_TexturedMesh + * \example{lineno} Tutorial_308_TexturedMesh/main.cpp + * * This example shows how to override the file loading function of the default easy3d viewer to * visualize textured meshes. * - * The source file containing the main() function: - * \include{lineno} Tutorial_308_TexturedMesh/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_308_TexturedMesh/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_309_TextRendering/main.cpp b/tutorials/Tutorial_309_TextRendering/main.cpp index ef918ca1..dbcdb2d9 100644 --- a/tutorials/Tutorial_309_TextRendering/main.cpp +++ b/tutorials/Tutorial_309_TextRendering/main.cpp @@ -29,11 +29,10 @@ #include /** - * \example Tutorial_309_TextRendering + * \example{lineno} Tutorial_309_TextRendering/main.cpp + * * This example shows how to render strings using Easy3D. * - * The source file containing the main() function: - * \include{lineno} Tutorial_309_TextRendering/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_309_TextRendering/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_310_TextMesher/main.cpp b/tutorials/Tutorial_310_TextMesher/main.cpp index 2cba5c5c..1bacdf7f 100644 --- a/tutorials/Tutorial_310_TextMesher/main.cpp +++ b/tutorials/Tutorial_310_TextMesher/main.cpp @@ -33,10 +33,8 @@ #include /** - * \example{lineno} Tutorial_310_TextMesher + * \example{lineno} Tutorial_310_TextMesher/main.cpp * This example shows how to generate a surface mesh models from texts. - * - * \include{lineno} Tutorial_310_TextMesher/main.cpp */ diff --git a/tutorials/Tutorial_311_Animation/main.cpp b/tutorials/Tutorial_311_Animation/main.cpp index 28641656..3f9ed4d4 100644 --- a/tutorials/Tutorial_311_Animation/main.cpp +++ b/tutorials/Tutorial_311_Animation/main.cpp @@ -32,10 +32,8 @@ /** - * \example{lineno} Tutorial_311_Animation + * \example{lineno} Tutorial_311_Animation/main.cpp * This example shows how to map an array buffer for dynamic buffer update (useful for animation). - * - * \include{lineno} Tutorial_311_Animation/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_312_MultiThread/main.cpp b/tutorials/Tutorial_312_MultiThread/main.cpp index eb0349e4..63fb918a 100644 --- a/tutorials/Tutorial_312_MultiThread/main.cpp +++ b/tutorials/Tutorial_312_MultiThread/main.cpp @@ -33,10 +33,8 @@ #include /** - * \example{lineno} Tutorial_312_MultiThread + * \example{lineno} Tutorial_312_MultiThread/main.cpp * This example shows how to use another thread for repeatedly modifying a model and updating the viewer thread. - * - * \include{lineno} Tutorial_312_MultiThread/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_401_ModelPicker/main.cpp b/tutorials/Tutorial_401_ModelPicker/main.cpp index 5bbc9ada..89d5316a 100644 --- a/tutorials/Tutorial_401_ModelPicker/main.cpp +++ b/tutorials/Tutorial_401_ModelPicker/main.cpp @@ -29,11 +29,10 @@ #include /** - * \example Tutorial_401_ModelPicker + * \example{lineno} Tutorial_401_ModelPicker/main.cpp + * * This example shows how to select a model from a set of models by clicking the mouse. * - * The source file containing the main() function: - * \include{lineno} Tutorial_401_ModelPicker/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_401_ModelPicker/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_402_FacePicker/main.cpp b/tutorials/Tutorial_402_FacePicker/main.cpp index 95569fbb..0f40a87a 100644 --- a/tutorials/Tutorial_402_FacePicker/main.cpp +++ b/tutorials/Tutorial_402_FacePicker/main.cpp @@ -29,11 +29,10 @@ #include /** - * \example Tutorial_402_FacePicker + * \example{lineno} Tutorial_402_FacePicker/main.cpp + * * This example shows how to select a face of a surface mesh by clicking the mouse. * - * The source file containing the main() function: - * \include{lineno} Tutorial_402_FacePicker/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_402_FacePicker/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_403_PointSelection/main.cpp b/tutorials/Tutorial_403_PointSelection/main.cpp index af66a99d..1dbc12ad 100644 --- a/tutorials/Tutorial_403_PointSelection/main.cpp +++ b/tutorials/Tutorial_403_PointSelection/main.cpp @@ -32,11 +32,10 @@ #include /** - * \example Tutorial_403_PointSelection + * \example{lineno} Tutorial_403_PointSelection/main.cpp + * * This example shows how to select a subset of a point cloud by sketching a rectangle or a lasso using the mouse. * - * The source file containing the main() function: - * \include{lineno} Tutorial_403_PointSelection/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_403_PointSelection/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_404_VirtualScanner/main.cpp b/tutorials/Tutorial_404_VirtualScanner/main.cpp index e42784a8..62a587cc 100644 --- a/tutorials/Tutorial_404_VirtualScanner/main.cpp +++ b/tutorials/Tutorial_404_VirtualScanner/main.cpp @@ -32,11 +32,10 @@ #include /** - * \example Tutorial_404_VirtualScanner + * \example{lineno} Tutorial_404_VirtualScanner/main.cpp + * * This example shows how to perform virtual scanning of a given model. * - * The source file containing the main() function: - * \include{lineno} Tutorial_404_VirtualScanner/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_404_VirtualScanner/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_405_ObjectManipulation/main.cpp b/tutorials/Tutorial_405_ObjectManipulation/main.cpp index 5c41c758..19dd1167 100644 --- a/tutorials/Tutorial_405_ObjectManipulation/main.cpp +++ b/tutorials/Tutorial_405_ObjectManipulation/main.cpp @@ -29,11 +29,10 @@ #include /** - * \example Tutorial_405_ObjectManipulation + * \example{lineno} Tutorial_405_ObjectManipulation/main.cpp + * * This example shows how to manipulate a model in the 3D space using the Manipulator class. * - * The source file containing the main() function: - * \include{lineno} Tutorial_405_ObjectManipulation/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_405_ObjectManipulation/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_406_CollisionDetection/main.cpp b/tutorials/Tutorial_406_CollisionDetection/main.cpp index 158a3da1..5c7d82b8 100644 --- a/tutorials/Tutorial_406_CollisionDetection/main.cpp +++ b/tutorials/Tutorial_406_CollisionDetection/main.cpp @@ -28,11 +28,10 @@ #include /** - * \example Tutorial_406_CollisionDetection + * \example{lineno} Tutorial_406_CollisionDetection/main.cpp + * * This example shows how to detect the intersecting faces using collision detection. * - * The source file containing the main() function: - * \include{lineno} Tutorial_406_CollisionDetection/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_406_CollisionDetection/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_501_AmbientOcclusion/main.cpp b/tutorials/Tutorial_501_AmbientOcclusion/main.cpp index 09d8b579..1fb028af 100644 --- a/tutorials/Tutorial_501_AmbientOcclusion/main.cpp +++ b/tutorials/Tutorial_501_AmbientOcclusion/main.cpp @@ -32,11 +32,10 @@ #include /** - * \example Tutorial_501_AmbientOcclusion + * \example{lineno} Tutorial_501_AmbientOcclusion/main.cpp + * * This example shows how to renders a surface mesh using ambient occlusion to improve depth perception. * - * The source file containing the main() function: - * \include{lineno} Tutorial_501_AmbientOcclusion/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_501_AmbientOcclusion/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_502_HardShadow/main.cpp b/tutorials/Tutorial_502_HardShadow/main.cpp index 1522e015..d0d785cf 100644 --- a/tutorials/Tutorial_502_HardShadow/main.cpp +++ b/tutorials/Tutorial_502_HardShadow/main.cpp @@ -32,11 +32,10 @@ #include /** - * \example Tutorial_502_HardShadow + * \example{lineno} Tutorial_502_HardShadow/main.cpp + * * This example shows how to renders a scene with hard shadow using the shadow map technique. * - * The source file containing the main() function: - * \include{lineno} Tutorial_502_HardShadow/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_502_HardShadow/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_503_SoftShadow/main.cpp b/tutorials/Tutorial_503_SoftShadow/main.cpp index c11b47ee..8d087cd2 100644 --- a/tutorials/Tutorial_503_SoftShadow/main.cpp +++ b/tutorials/Tutorial_503_SoftShadow/main.cpp @@ -32,11 +32,10 @@ #include /** - * \example Tutorial_503_SoftShadow + * \example{lineno} Tutorial_503_SoftShadow/main.cpp + * * This example shows how to renders a scene with hard shadow using the Percentage-Closer Soft Shadows (PCSS) technique. * - * The source file containing the main() function: - * \include{lineno} Tutorial_503_SoftShadow/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_503_SoftShadow/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_504_Transparency/main.cpp b/tutorials/Tutorial_504_Transparency/main.cpp index 2b38147e..2c951725 100644 --- a/tutorials/Tutorial_504_Transparency/main.cpp +++ b/tutorials/Tutorial_504_Transparency/main.cpp @@ -32,13 +32,12 @@ #include /** - * \example Tutorial_504_Transparency + * \example{lineno} Tutorial_504_Transparency/main.cpp + * * This example shows how to render a surface mesh with transparency effect using the following techniques * - Average Color Blending * - Dual Depth Peeling * - * The source file containing the main() function: - * \include{lineno} Tutorial_504_Transparency/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_504_Transparency/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_505_EyeDomeLighting/main.cpp b/tutorials/Tutorial_505_EyeDomeLighting/main.cpp index 9877a224..420e6967 100644 --- a/tutorials/Tutorial_505_EyeDomeLighting/main.cpp +++ b/tutorials/Tutorial_505_EyeDomeLighting/main.cpp @@ -32,12 +32,11 @@ #include /** - * \example Tutorial_505_EyeDomeLighting + * \example{lineno} Tutorial_505_EyeDomeLighting/main.cpp + * * This example shows how to render a point cloud without normal information (but still be able to perceive the depth) * using the Eye Dome Lighting technique. * - * The source file containing the main() function: - * \include{lineno} Tutorial_505_EyeDomeLighting/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_505_EyeDomeLighting/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_506_DepthMap/main.cpp b/tutorials/Tutorial_506_DepthMap/main.cpp index 5982c0bd..1f2f67a1 100644 --- a/tutorials/Tutorial_506_DepthMap/main.cpp +++ b/tutorials/Tutorial_506_DepthMap/main.cpp @@ -33,12 +33,10 @@ /** - * \example Tutorial_506_DepthMap - * + * \example{lineno} Tutorial_506_DepthMap/main.cpp + * * This example shows how to create depth images from the rendering. * - * The source file containing the main() function: - * \include{lineno} Tutorial_506_DepthMap/main.cpp * The header file of the viewer class: * \include{lineno} Tutorial_506_DepthMap/viewer.h * The source file of the viewer class: diff --git a/tutorials/Tutorial_601_Tessellator/main.cpp b/tutorials/Tutorial_601_Tessellator/main.cpp index b737f9f1..697d5a01 100644 --- a/tutorials/Tutorial_601_Tessellator/main.cpp +++ b/tutorials/Tutorial_601_Tessellator/main.cpp @@ -34,15 +34,13 @@ #include /** - * \example{lineno} Tutorial_601_Tessellator + * \example{lineno} Tutorial_601_Tessellator/main.cpp * * This example shows how to triangulate a general polygonal meshes (e.g., meshes with concave faces, * self−intersecting faces, and faces with holes) using the tessellator of Easy3D. * * Note: For general rendering purposes, you can use the tessellator to create a TrianglesDrawable for * the model without explicitly triangulating the mesh. - * - * \include{lineno} Tutorial_601_Tessellator/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_602_ConvexPartition/main.cpp b/tutorials/Tutorial_602_ConvexPartition/main.cpp index 846f3906..f5b585b2 100644 --- a/tutorials/Tutorial_602_ConvexPartition/main.cpp +++ b/tutorials/Tutorial_602_ConvexPartition/main.cpp @@ -34,15 +34,13 @@ #include /** - * \example{lineno} Tutorial_602_ConvexPartition + * \example{lineno} Tutorial_602_ConvexPartition/main.cpp * * This example shows how to partition a polygon (free of self-intersection) with an arbitrary number of holes into * a set of convex polygons using the PolygonPartition class of Easy3D. * * Note: For complex unknown structures that have self-intersection, you need to use the CSG operators provided in * easy3d/algo/tessellator.h to obtain simply polygons (free of self-intersection) first. - * - * \include{lineno} Tutorial_602_ConvexPartition/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_603_Curves/main.cpp b/tutorials/Tutorial_603_Curves/main.cpp index 81cbeb92..de04345a 100644 --- a/tutorials/Tutorial_603_Curves/main.cpp +++ b/tutorials/Tutorial_603_Curves/main.cpp @@ -32,11 +32,9 @@ #include /** - * \example{lineno} Tutorial_603_Curves + * \example{lineno} Tutorial_603_Curves/main.cpp * * This example shows how to create/evaluate several types of curves and curve fitting/interpolation methods in Easy3D. - * - * \include{lineno} Tutorial_603_Curves/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_701_Cloud_NormalEstimation/main.cpp b/tutorials/Tutorial_701_Cloud_NormalEstimation/main.cpp index 72e0fe09..91d32170 100644 --- a/tutorials/Tutorial_701_Cloud_NormalEstimation/main.cpp +++ b/tutorials/Tutorial_701_Cloud_NormalEstimation/main.cpp @@ -34,13 +34,11 @@ #include /** - * \example{lineno} Tutorial_701_Cloud_NormalEstimation + * \example{lineno} Tutorial_701_Cloud_NormalEstimation/main.cpp * * This example shows how to * - estimate normal information of a point cloud. * - re-orient the normals. - * - * \include{lineno} Tutorial_701_Cloud_NormalEstimation/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_702_Cloud_SurfaceReconstruction/main.cpp b/tutorials/Tutorial_702_Cloud_SurfaceReconstruction/main.cpp index d8d81500..32165227 100644 --- a/tutorials/Tutorial_702_Cloud_SurfaceReconstruction/main.cpp +++ b/tutorials/Tutorial_702_Cloud_SurfaceReconstruction/main.cpp @@ -33,12 +33,10 @@ #include /** - * \example{lineno} Tutorial_702_Cloud_SurfaceReconstruction + * \example{lineno} Tutorial_702_Cloud_SurfaceReconstruction/main.cpp * * This example shows how to reconstruct a smooth surface from a point cloud using the Poisson surface * reconstruction method. - * - * \include{lineno} Tutorial_702_Cloud_SurfaceReconstruction/main.cpp */ using namespace easy3d; diff --git a/tutorials/Tutorial_703_Cloud_PlaneExtraction/main.cpp b/tutorials/Tutorial_703_Cloud_PlaneExtraction/main.cpp index 9725c219..b52db2bf 100644 --- a/tutorials/Tutorial_703_Cloud_PlaneExtraction/main.cpp +++ b/tutorials/Tutorial_703_Cloud_PlaneExtraction/main.cpp @@ -33,11 +33,9 @@ #include /** - * \example{lineno} Tutorial_703_Cloud_PlaneExtraction + * \example{lineno} Tutorial_703_Cloud_PlaneExtraction/main.cpp * * This example shows how to extract planes from a point cloud using RANSAC. - * - * \include{lineno} Tutorial_703_Cloud_PlaneExtraction/main.cpp */ using namespace easy3d;