documentation

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

easy3d/core/mat.h

@@ -1620,7 +1620,7 @@ namespace easy3d {
     template <typename T>	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
      */

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

tutorials/Tutorial_101_PointCloud/main.cpp

@@ -28,10 +28,8 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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
  */
 
 

tutorials/Tutorial_102_PointCloud_Property/main.cpp

@@ -29,10 +29,8 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_103_PointCloud_IO/main.cpp

@@ -30,10 +30,8 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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
  */
 
 

tutorials/Tutorial_104_SurfaceMesh/main.cpp

@@ -29,10 +29,8 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_105_SurfaceMesh_Connectivity/main.cpp

@@ -28,7 +28,7 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_106_SurfaceMesh_Property/main.cpp

@@ -28,11 +28,9 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_107_SurfaceMesh_IO/main.cpp

@@ -30,12 +30,10 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_108_Graph/main.cpp

@@ -28,10 +28,8 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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
  */
 
 

tutorials/Tutorial_109_Graph_Connectivity/main.cpp

@@ -28,13 +28,11 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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
  */
 
 

tutorials/Tutorial_110_Graph_Property/main.cpp

@@ -28,10 +28,8 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_111_Graph_IO/main.cpp

@@ -30,10 +30,8 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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
  */
 
 

tutorials/Tutorial_112_PolyMesh/main.cpp

@@ -28,11 +28,9 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_113_PolyMesh_Connectivity/main.cpp

@@ -28,7 +28,7 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_114_PolyMesh_Property/main.cpp

@@ -28,12 +28,10 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_115_PolyMesh_IO/main.cpp

@@ -30,10 +30,8 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_201_Viewer_default/main.cpp

@@ -30,10 +30,8 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

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) {

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
  */
 
 

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:

tutorials/Tutorial_205_MultiView/main.cpp

@@ -35,10 +35,8 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_206_CameraInterpolation/main.cpp

@@ -29,13 +29,11 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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:

tutorials/Tutorial_207_RealCamera/main.cpp

@@ -29,16 +29,15 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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
  *       commonly used computer vision techniques (i.e., calibration, or SfM).
  *     - 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:

tutorials/Tutorial_301_Drawables/main.cpp

@@ -33,7 +33,8 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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;

tutorials/Tutorial_302_Imposters/main.cpp

@@ -34,13 +34,11 @@
 #include <easy3d/util/initializer.h>
 
 /**
- * \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
  */