Add documentation

Author: damienmarchal

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_DrawTool.cpp

@@ -95,7 +95,7 @@ void moduleAddDrawTool(py::module &m)
     dt.def("drawPoints", [](DrawTool *self, py::array_t<double> points, float size, sofa::type::RGBAColor& color)
     {
         self->drawPoints(getPoints(points), size, color);
-    });
+    }, sofapython3::doc::drawtool::drawPoints);
     dt.def("drawPoints", [](DrawTool *self, BaseData* dpositions, float size, sofa::type::RGBAColor& color){
         auto positions = dynamic_cast<Data<sofa::type::vector<sofa::type::Vec3>>*>(dpositions);
         if(!positions)
@@ -107,7 +107,7 @@ void moduleAddDrawTool(py::module &m)
     /// Draw lines
     dt.def("drawLines", [](DrawTool *self,  const py::array_t<double>& positions, const float size, sofa::type::RGBAColor& color){
         self->drawLines(getPoints(positions), size, color);
-    });
+    }, sofapython3::doc::drawtool::drawLines);
     dt.def("drawLines", [](DrawTool *self, BaseData* dpositions, const float size, sofa::type::RGBAColor& color){
         auto positions = dynamic_cast<Data<sofa::type::vector<sofa::type::Vec3>>*>(dpositions);
         if(!positions)
@@ -127,7 +127,7 @@ void moduleAddDrawTool(py::module &m)
     // Draw mesh
     dt.def("drawTriangles", [](DrawTool *self,  py::array_t<double>& positions, sofa::type::RGBAColor& color){
         self->drawTriangles(getPoints(positions), color);
-    });
+    }, sofapython3::doc::drawtool::drawTriangles);
     dt.def("drawTriangles", [](DrawTool *self,  BaseData* dpositions, BaseData* dtriangles, sofa::type::RGBAColor& color){
         auto positions = dynamic_cast<Data<sofa::type::vector<sofa::type::Vec3d>>*>(dpositions);
         if(!positions)
@@ -156,7 +156,7 @@ void moduleAddDrawTool(py::module &m)
     // Draw mesh
     dt.def("drawQuads", [](DrawTool *self,  py::array_t<double>& positions, sofa::type::RGBAColor& color){
         self->drawQuads(getPoints(positions), color);
-    });
+    }, sofapython3::doc::drawtool::drawQuads);
     dt.def("drawQuads", [](DrawTool *self,  BaseData* dpositions, BaseData* dquads, sofa::type::RGBAColor& color){
         auto positions = dynamic_cast<Data<sofa::type::vector<sofa::type::Vec3d>>*>(dpositions);
         if(!positions)
@@ -187,7 +187,7 @@ void moduleAddDrawTool(py::module &m)
     // Draw spheres
     dt.def("drawSpheres", [](DrawTool *self,  const py::array_t<double>& positions, const std::vector<float>& radius, sofa::type::RGBAColor& color){
         self->drawSpheres(getPoints(positions), radius, color);
-    });
+    }, sofapython3::doc::drawtool::drawSpheres);
     dt.def("drawSpheres", [](DrawTool *self, BaseData* dpositions, const float radius, sofa::type::RGBAColor& color){
         auto positions = dynamic_cast<Data<sofa::type::vector<sofa::type::Vec3>>*>(dpositions);
         if(!positions)
@@ -196,11 +196,11 @@ void moduleAddDrawTool(py::module &m)
     });
 
     // Draw boundingBox
-    dt.def("boundingBox", [](DrawTool *self,  const std::array<double,4>& min, const std::array<double, 4>& max, double width){
+    dt.def("drawBoundingBox", [](DrawTool *self,  const std::array<double,4>& min, const std::array<double, 4>& max, double width){
         sofa::type::Vec3d cmin { min[0], min[1], min[2] };
         sofa::type::Vec3d cmax { max[0], max[1], max[2] };
         self->drawBoundingBox( cmin, cmax, width);
-    });
+    }, sofapython3::doc::drawtool::drawBoundingBox);
 
     // Draw frames
     dt.def("drawFrames", [](DrawTool* self,
@@ -214,7 +214,7 @@ void moduleAddDrawTool(py::module &m)
         {
             self->drawFrame(cpoints[i], corientations[i], csize);
         }
-    });
+    }, sofapython3::doc::drawtool::drawFrames);
     dt.def("drawFrames", [](DrawTool* self, BaseData* dpositions, std::array<double, 3>& size ){
         using sofa::defaulttype::Rigid3Types;
         using Coord = sofa::defaulttype::Rigid3Types::Coord;
@@ -241,15 +241,13 @@ void moduleAddDrawTool(py::module &m)
                           const sofa::type::RGBAColor& color)
     {
         self->draw3DText(point, size, color, text.c_str());
-    });
+    }, sofapython3::doc::drawtool::drawText);
 
     // Draw overlay text
     dt.def("drawOverlayText", [](DrawTool* self, const std::array<double,2>& point,
                                  int fontSize, char* text, sofa::type::RGBAColor& color){
         self->writeOverlayText(point[0],point[1], fontSize, color, text);
-    });
-
-
+    }, sofapython3::doc::drawtool::drawOverlayText);
 
 }
 

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_DrawTool_doc.h

@@ -27,4 +27,54 @@ static auto baseDrawToolClass =
            It provides higher-level drawing functions like drawing lines, points, spheres, arrows, etc., without
            needing to write raw OpenGL each time.)";
 
+static auto drawPoints =
+            R"(Draws 3D points.
+            points: NumPy array of shape (N, 3) or BaseData of type vector<Vec3>
+            size: Point size (float)
+            color: RGBAColor object)";
+
+static auto drawLines =
+            R"(Draws connected line segments between given 3D points.)";
+
+
+static auto drawTriangles =
+            R"(Draws a triangle mesh from a flat array of 3-point group.
+            points: NumPy array of shape (N, 3) or BaseData of type vector<Vec3>
+            color: RGBAColor object)";
+
+static auto drawQuads =
+            R"(Draws quad mesh from a flat array of 4-point groups.
+            points: NumPy array of shape (N, 3) or BaseData of type vector<Vec4>
+            color: RGBAColor object)";
+
+static auto drawSpheres =
+            R"(Draws spheres from a set of points.
+            points: NumPy array of shape (N, 3) or BaseData of type vector<Vec4>
+            color: RGBAColor object)";
+
+static auto drawBoundingBox =
+            R"(Draws a bounding box from its min and max point
+            min: an array of 3 values
+            max: an array of 3 values)";
+
+static auto drawFrames =
+            R"(Draws 3d frames from position and orientation
+            position: an array of size N,3
+            orientaiton: an array of size N,4)";
+
+static auto drawText =
+            R"(Draws text in 3D
+            position: an array of size 3
+            size: dimmension of the text,
+            text: content to show on screen
+            color: RGBAColor)";
+
+static auto drawOverlayText =
+            R"(Draws text in 2D
+            position: an array of size 2
+            size: the font size,
+            text: content to show on screen
+            color: RGBAColor)";
+
+
 }