Doc: Add code snippets from examples (#4497)

Author: oitel

examples/cpp-examples/FreeFormDeformation.dox.cpp

@@ -9,12 +9,13 @@ int main()
     auto mesh = MR::MeshLoad::fromAnySupportedFormat( "mesh.stl" );
     assert( mesh );
 
-    // Compute mesh bounding box
-    const auto box = mesh->computeBoundingBox();
-
+//! [0]
     // Construct deformer on mesh vertices
     MR::FreeFormDeformer ffDeformer( mesh->points, mesh->topology.getValidVerts() );
 
+    // Compute mesh bounding box
+    const auto box = mesh->computeBoundingBox();
+
     // Init deformer with 3x3 grid on mesh box
     ffDeformer.init( MR::Vector3i::diagonal( 3 ), box );
 
@@ -31,6 +32,7 @@ int main()
 
     // Invalidate the mesh because of external vertex changes
     mesh->invalidateCaches();
+//! [0]
 
     // Save deformed mesh
     MR::MeshSave::toAnySupportedFormat( *mesh, "deformed_mesh.stl" );

examples/cpp-examples/MeshBoolean.dox.cpp

@@ -7,6 +7,7 @@
 
 int main()
 {
+//! [0]
     // create first sphere with radius of 1 unit
     MR::Mesh sphere1 = MR::makeUVSphere( 1.0f, 64, 64 );
 
@@ -17,10 +18,12 @@ int main()
 
     // perform boolean operation
     MR::BooleanResult result = MR::boolean( sphere1, sphere2, MR::BooleanOperation::Intersection );
-    MR::Mesh resultMesh = *result;
     if ( !result.valid() )
         std::cerr << result.errorString << std::endl;
 
+    MR::Mesh resultMesh = *result;
+//! [0]
+
     // save result to STL file
     MR::MeshSave::toAnySupportedFormat( resultMesh, "out_boolean.stl" );
 

examples/cpp-examples/MeshDecimate.dox.cpp

@@ -10,6 +10,7 @@ int main()
     // Load mesh
     MR::Mesh mesh = *MR::MeshLoad::fromAnySupportedFormat( "mesh.stl" );
 
+//! [0]
     // Repack mesh optimally.
     // It's not necessary but highly recommended to achieve the best performance in parallel processing
     mesh.packOptimally();
@@ -27,6 +28,7 @@ int main()
 
     // Decimate mesh
     MR::decimateMesh( mesh, settings );
+//! [0]
 
     // Save result
     MR::MeshSave::toAnySupportedFormat( mesh, "decimated_mesh.stl" );

examples/cpp-examples/MeshICP.dox.cpp

@@ -12,6 +12,7 @@ int main()
     MR::Mesh meshFloating = *MR::MeshLoad::fromAnySupportedFormat( "meshA.stl" );
     MR::Mesh meshFixed = *MR::MeshLoad::fromAnySupportedFormat( "meshB.stl" );
 
+//! [0]
     // Prepare ICP parameters
     float diagonal = meshFixed.getBoundingBox().diagonal();
     float icpSamplingVoxelSize = diagonal * 0.01f; // To sample points from object
@@ -30,6 +31,7 @@ int main()
 
     // Transform floating mesh
     meshFloating.transform( xf );
+//! [0]
 
     // Output information string
     std::string info = icp.getStatusInfo();

examples/cpp-examples/MeshModification.dox.cpp

@@ -16,9 +16,11 @@ int main()
     props.maxDeviationAfterFlip = 0.5f;
     MR::subdivideMesh( mesh, props );
 
+//! [MeshTransform]
     // Rotate mesh
     MR::AffineXf3f rotationXf = MR::AffineXf3f::linear( MR::Matrix3f::rotation( MR::Vector3f::plusZ(), MR::PI_F * 0.5f ) );
     mesh.transform( rotationXf );
+//! [MeshTransform]
 
     return 0;
 }

examples/cpp-examples/MeshOffset.dox.cpp

@@ -12,6 +12,7 @@ int main()
     // Create mesh
     MR::Mesh mesh = MR::makeCube();
 
+//! [0]    
     // Setup parameters
     MR::GeneralOffsetParameters params;
     // calculate voxel size depending on desired accuracy and/or memory consumption
@@ -22,6 +23,7 @@ int main()
     // Make offset mesh
     float offset = mesh.computeBoundingBox().diagonal() * 0.1f;
     auto meshRes = MR::generalOffsetMesh( mesh, offset, params );
+//! [0]    
     if ( !meshRes.has_value() )
     {
         std::cerr << meshRes.error() << std::endl;

examples/cpp-examples/MeshStitchHole.dox.cpp

@@ -13,6 +13,7 @@ int main()
     MR::Mesh mesh = std::move( meshARes.value() );
     mesh.addMesh( meshBRes.value() );
 
+//! [0]    
     // Find holes (expect that there are exactly 2 holes)
     std::vector<MR::EdgeId> edges = mesh.topology.findHoleRepresentiveEdges();
     if ( edges.size() != 2 )
@@ -22,6 +23,7 @@ int main()
     MR::StitchHolesParams params;
     params.metric = MR::getUniversalMetric( mesh );
     MR::buildCylinderBetweenTwoHoles( mesh, edges.front(), edges.back(), params );
+//! [0]    
 
     // Save result
     auto saveRes = MR::MeshSave::toAnySupportedFormat( mesh, "stitchedMesh.stl" );

source/MRMesh/MRFreeFormDeformer.h

@@ -7,7 +7,8 @@
 
 namespace MR
 {
-// Class for deforming mesh using Bernstein interpolation
+/// \brief Class for deforming mesh using Bernstein interpolation
+/// \snippet cpp-examples/FreeFormDeformation.dox.cpp 0
 class FreeFormDeformer
 {
 public:

source/MRMesh/MRICP.h

@@ -167,6 +167,7 @@ MRMESH_API void updatePointPairs( PointPairs& pairs,
 
 /// This class allows you to register two object with similar shape using
 /// Iterative Closest Points (ICP) point-to-point or point-to-plane algorithms
+/// \snippet cpp-examples/MeshICP.dox.cpp 0
 class [[nodiscard]] ICP
 {
 public:

source/MRMesh/MRMesh.h

@@ -340,6 +340,7 @@ struct [[nodiscard]] Mesh
 
     /// applies given transformation to specified vertices
     /// if region is nullptr, all valid mesh vertices are used
+    /// \snippet cpp-examples/MeshModification.dox.cpp MeshTransform
     MRMESH_API void transform( const AffineXf3f& xf, const VertBitSet* region = nullptr );
 
     /// creates new point and assigns given position to it