[Collision.Geometry] Rename TriangleOctreeModel to TriangleOctreeCollisionModel (#5766)

* rename to triangleoctreecollisionmodel and deprecate old name ; and add a data to display the octree

* Apply suggestion from @bakpaul (add PR number)

Co-authored-by: Paul Baksic <30337881+bakpaul@users.noreply.github.com>

---------

Co-authored-by: Paul Baksic <30337881+bakpaul@users.noreply.github.com>

Author: fredroy

Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/TriangleOctreeModel.cpp

@@ -37,34 +37,41 @@ namespace sofa::component::collision::geometry
 void registerTriangleOctreeModel(sofa::core::ObjectFactory* factory)
 {
     factory->registerObjects(core::ObjectRegistrationData("Collision model using a triangular mesh mapped to an Octree.")
-        .add <	TriangleOctreeModel >());
+        .add <	TriangleOctreeCollisionModel >()
+        .addAlias("TriangleOctreeModel")); // SOFA_ATTRIBUTE_DEPRECATED__RENAMED_TRIANGLEOCTREEMODEL()
 }
 
-TriangleOctreeModel::TriangleOctreeModel ()
+TriangleOctreeCollisionModel::TriangleOctreeCollisionModel ()
+    : Inherit1()
+    , helper::TriangleOctreeRoot()
+    , d_drawOctree(initData(&d_drawOctree, false, "drawOctree", "draw the octree structure"))
 {
 }
 
-void TriangleOctreeModel::drawCollisionModel (const core::visual::VisualParams* vparams)
+void TriangleOctreeCollisionModel::drawCollisionModel (const core::visual::VisualParams* vparams)
 {
     TriangleCollisionModel<sofa::defaulttype::Vec3Types>::drawCollisionModel(vparams);
 
-    if (vparams->displayFlags().getShowWireFrame())
+    if (d_drawOctree.getValue())
     {
-        vparams->drawTool()->setPolygonMode(0, true);
-    }
+        if (vparams->displayFlags().getShowWireFrame())
+        {
+            vparams->drawTool()->setPolygonMode(0, true);
+        }
 
-    vparams->drawTool()->enableLighting();
-    const float* getCol = getColor4f();
-    const auto color = sofa::type::RGBAColor(getCol[0], getCol[1], getCol[2], getCol[3]);
-    vparams->drawTool()->setMaterial(color);
+        vparams->drawTool()->enableLighting();
+        const float* getCol = getColor4f();
+        const auto color = sofa::type::RGBAColor(getCol[0], getCol[1], getCol[2], getCol[3]);
+        vparams->drawTool()->setMaterial(color);
 
-    if (octreeRoot) octreeRoot->draw(vparams->drawTool());
+        if (octreeRoot) octreeRoot->draw(vparams->drawTool());
 
-    vparams->drawTool()->disableLighting();
-    if (vparams->displayFlags().getShowWireFrame()) vparams->drawTool()->setPolygonMode(0, false);
+        vparams->drawTool()->disableLighting();
+        if (vparams->displayFlags().getShowWireFrame()) vparams->drawTool()->setPolygonMode(0, false);
+    }
 }
 
-void TriangleOctreeModel::computeBoundingTree(int maxDepth)
+void TriangleOctreeCollisionModel::computeBoundingTree(int maxDepth)
 {
     const type::vector<topology::Triangle>& tri = *m_triangles;
     if(octreeRoot)
@@ -124,12 +131,12 @@ void TriangleOctreeModel::computeBoundingTree(int maxDepth)
     }
 }
 
-void TriangleOctreeModel::computeContinuousBoundingTree(SReal/* dt*/, int maxDepth)
+void TriangleOctreeCollisionModel::computeContinuousBoundingTree(SReal/* dt*/, int maxDepth)
 {
     computeBoundingTree(maxDepth);
 }
 
-void TriangleOctreeModel::buildOctree()
+void TriangleOctreeCollisionModel::buildOctree()
 {
     this->octreeTriangles = &this->getTriangles();
     this->octreePos = &this->getX();

Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/TriangleOctreeModel.h

@@ -33,14 +33,15 @@
 namespace sofa::component::collision::geometry
 {
 
-class SOFA_COMPONENT_COLLISION_GEOMETRY_API TriangleOctreeModel : public  TriangleCollisionModel<sofa::defaulttype::Vec3Types>, public helper::TriangleOctreeRoot
+class SOFA_COMPONENT_COLLISION_GEOMETRY_API TriangleOctreeCollisionModel : public  TriangleCollisionModel<sofa::defaulttype::Vec3Types>, public helper::TriangleOctreeRoot
 {
 public:
-    SOFA_CLASS(TriangleOctreeModel, TriangleCollisionModel<sofa::defaulttype::Vec3Types>);
+    SOFA_CLASS(TriangleOctreeCollisionModel, TriangleCollisionModel<sofa::defaulttype::Vec3Types>);
 protected:
-    TriangleOctreeModel();
+    TriangleOctreeCollisionModel();
     void drawCollisionModel(const core::visual::VisualParams* vparams) override;
 public:
+    Data<bool> d_drawOctree;  ///< draw the octree
 
     /// the normals for each point
     type::vector<type::Vec3> pNorms;
@@ -50,4 +51,8 @@ class SOFA_COMPONENT_COLLISION_GEOMETRY_API TriangleOctreeModel : public  Triang
     void buildOctree ();
 };
 
+
+using TriangleOctreeModel SOFA_ATTRIBUTE_DEPRECATED__RENAMED_TRIANGLEOCTREEMODEL() = TriangleOctreeCollisionModel;
+
+
 } // namespace sofa::component::collision::geometry

Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/config.h.in

@@ -36,3 +36,13 @@ namespace sofa::component::collision::geometry
 	constexpr const char* MODULE_NAME = "@PROJECT_NAME@";
 	constexpr const char* MODULE_VERSION = "@PROJECT_VERSION@";
 } // namespace sofa::component::collision::geometry
+
+
+#ifdef SOFA_BUILD_SOFA_COMPONENT_COLLISION_GEOMETRY
+#define SOFA_ATTRIBUTE_DEPRECATED__RENAMED_TRIANGLEOCTREEMODEL()
+#else
+#define SOFA_ATTRIBUTE_DEPRECATED__RENAMED_TRIANGLEOCTREEMODEL() \
+    SOFA_ATTRIBUTE_DEPRECATED( \
+        "v25.12", "v26.06", \
+        "TriangleOctreeModel has been renamed to TriangleOctreeCollisionModel in PR5766")
+#endif

Sofa/framework/Helper/src/sofa/helper/ComponentChange.cpp

@@ -765,7 +765,8 @@ std::map< std::string, Renamed, std::less<> > renamedComponents = {
     {"StiffSpringForceField", Renamed("v24.06","v25.06","SpringForceField")},
     {"ParallelStiffSpringForceField", Renamed("v24.06","v25.06","ParallelSpringForceField")},
     {"ShewchukPCGLinearSolver", Renamed("v24.12","v25.12","PCGLinearSolver")},
-    {"OglCylinderModel", Renamed("v24.12", "v25.06", "CylinderVisualModel")}
+    {"OglCylinderModel", Renamed("v24.12", "v25.06", "CylinderVisualModel")},
+    {"TriangleOctreeModel", Renamed("v25.12", "v26.06", "TriangleOctreeCollisionModel") }
 };