Merge branch 'master' of github.com:sofa-framework/PluginExample into 25_05_add_notify_dash

bakpaul · bakpaul · commit 6a88dba6883f · 2025-05-16T16:35:49.000+02:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-22.04, macos-13, windows-2022]
+        os: [ubuntu-22.04, macos-14, windows-2022]
         sofa_branch: [master]
 
     steps:
@@ -69,18 +69,31 @@ jobs:
             echo ${CCACHE_BASEDIR}
             ccache -s
           fi
+
+      - name: Sanitize artifact name
+        id: sanitize
+        # This step removes special characters from the artifact name to ensure compatibility with upload-artifact
+        # Characters removed: " : < > | * ? \r \n \ /
+        # Spaces are replaced with underscores
+        # This sanitization prevents errors in artifact creation and retrieval
+        shell: pwsh
+        run: |
+          $originalName = "PluginExample_${{ steps.sofa.outputs.run_branch }}_for-SOFA-${{ steps.sofa.outputs.sofa_version }}_${{ runner.os }}"
+          $artifact_name = $originalName -replace '[":;<>|*?\r\n\\/]', '' -replace ' ', '_'
+          echo "artifact_name=$artifact_name" >> $env:GITHUB_OUTPUT
+
       - name: Create artifact
         id: create-artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4.4.0
         with:
-          name: PluginExample_${{ steps.sofa.outputs.run_branch }}_for-SOFA-${{ steps.sofa.outputs.sofa_version }}_${{ runner.os }}
+          name: ${{ steps.sanitize.outputs.artifact_name }}
           path: ${{ env.WORKSPACE_INSTALL_PATH }}
 
       - name: Install artifact
         id: install-artifact
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4.1.7
         with:
-          name: PluginExample_${{ steps.sofa.outputs.run_branch }}_for-SOFA-${{ steps.sofa.outputs.sofa_version }}_${{ runner.os }}
+          name: ${{ steps.sanitize.outputs.artifact_name }}
           path: ${{ env.WORKSPACE_ARTIFACT_PATH }}
       
       - name: Set env vars for tests
@@ -131,6 +144,7 @@ jobs:
 
           binary_status=$([ '${{ steps.create-artifact.outcome }}' == 'success' ] && \
                          [ '${{ steps.install-artifact.outcome }}' == 'success' ] && \
+                         [ '${{ steps.sanitize.outcome }}' == 'success' ] && \
                          echo 'true' || echo 'false')
 
 
@@ -151,7 +165,7 @@ jobs:
     continue-on-error: true
     steps:
       - name: Get artifacts
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4.1.7
         with:
           path: artifacts
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -6,8 +6,8 @@ project(PluginExample VERSION 1.0 LANGUAGES CXX)
 find_package(Sofa.Component.Visual REQUIRED) # Needed for VisualModelImpl
 
 ## Optional dependencies
-sofa_find_package(Sofa.GUI.Qt)
-sofa_find_package(Qt5 COMPONENTS Core) # Dependency to Qt5Core (needed for qt5_wrap_cpp)
+sofa_find_package(Sofa.GUI.Qt QUIET)
+sofa_find_package(Qt5 COMPONENTS Core QUIET) # Dependency to Qt5Core (needed for qt5_wrap_cpp)
 
 # List all files
 set(PLUGINEXAMPLE_SRC_DIR src/PluginExample)
diff --git a/PluginExample_test/MyBehaviorModel_test.cpp b/PluginExample_test/MyBehaviorModel_test.cpp
@@ -26,23 +26,24 @@ using std::vector;
 
 #include <sofa/testing/BaseTest.h>
 using sofa::testing::BaseTest;
-
 using ::testing::Types;
 
+using namespace pluginexample;
+
 namespace {
 
 class MyBehaviorModel_test : public BaseTest,
                              public ::testing::WithParamInterface<unsigned>
 {
 public:
-    using MyBehaviorModel = sofa::component::behaviormodel::MyBehaviorModel;
+    using MyBehaviorModel = pluginexample::MyBehaviorModel;
 
-    void TearDown()
+    void doTearDown() override
     {
 
     }
 
-    void SetUp()
+    void doSetUp() override
     {
         m_behaviorModel = sofa::core::objectmodel::New< MyBehaviorModel >();
     }
diff --git a/src/PluginExample/MyBehaviorModel.cpp b/src/PluginExample/MyBehaviorModel.cpp
@@ -24,7 +24,7 @@
 #include <sofa/core/ObjectFactory.h>
 
 
-namespace sofa::component::behaviormodel
+namespace pluginexample
 {
 
 MyBehaviorModel::MyBehaviorModel()
@@ -52,8 +52,11 @@ void MyBehaviorModel::updatePosition(double dt)
     SOFA_UNUSED(dt);
 }
 
-int MyBehaviorModelClass = core::RegisterObject("Dummy component with a custom widget.").add< MyBehaviorModel >();
-
+void registerMyBehaviorModel(sofa::core::ObjectFactory* factory)
+{
+    factory->registerObjects(core::ObjectRegistrationData("Dummy component with a custom widget.")
+    .add< MyBehaviorModel >());
+}
 
-} // namespace sofa::component::behaviormodel
+} // namespace pluginexample
 
diff --git a/src/PluginExample/MyBehaviorModel.h b/src/PluginExample/MyBehaviorModel.h
@@ -26,7 +26,7 @@
 #include <sofa/core/BehaviorModel.h>
 
 
-namespace sofa::component::behaviormodel
+namespace pluginexample
 {
 
 /**
@@ -52,5 +52,5 @@ class SOFA_PLUGINEXAMPLE_API MyBehaviorModel : public sofa::core::BehaviorModel
 };
 
 
-} // sofa::component::behaviormodel
+} // namespace pluginexample
 
diff --git a/src/PluginExample/MyDataWidgetUnsigned.cpp b/src/PluginExample/MyDataWidgetUnsigned.cpp
@@ -24,7 +24,7 @@
 #include <sofa/helper/Factory.h>
 
 
-namespace sofa::gui::qt
+namespace pluginexample
 {
 
 /*
@@ -112,4 +112,4 @@ void MyDataWidgetUnsigned::change()
 }
 
 
-} // namespace sofa::gui::qt
+} // namespace pluginexample
diff --git a/src/PluginExample/MyDataWidgetUnsigned.h b/src/PluginExample/MyDataWidgetUnsigned.h
@@ -31,7 +31,7 @@
 #include <QString>
 
 
-namespace sofa::gui::qt
+namespace pluginexample
 {
 
 /**
@@ -65,4 +65,4 @@ protected slots:
 };
 
 
-} // namespace sofa::gui::qt
+} // namespace pluginexample
diff --git a/src/PluginExample/MyMappingPendulumInPlane.cpp b/src/PluginExample/MyMappingPendulumInPlane.cpp
@@ -27,21 +27,21 @@
 #include <sofa/defaulttype/VecTypes.h>
 
 
-namespace sofa::component::mapping
+namespace pluginexample
 {
 
 using namespace sofa::defaulttype;
 
-
-int MyMappingPendulumInPlaneClass = core::RegisterObject("Mapping from an angle to a point in 2D")
+void registerMyMappingPendulumInPlane(sofa::core::ObjectFactory* factory)
+{
+    factory->registerObjects(core::ObjectRegistrationData("Mapping from an angle to a point in 2D.")
     .add< MyMappingPendulumInPlane<Vec1Types, Vec3Types> >()
-    .add< MyMappingPendulumInPlane<Vec1Types, Vec2Types> >()
-;
+    .add< MyMappingPendulumInPlane<Vec1Types, Vec2Types> >());
+}
 
 template class SOFA_PLUGINEXAMPLE_API MyMappingPendulumInPlane<Vec1Types, Vec3Types>;
 template class SOFA_PLUGINEXAMPLE_API MyMappingPendulumInPlane<Vec1Types, Vec2Types>;
 
 
 
-} // namespace sofa::component::mapping
-
+} // namespace pluginexample
diff --git a/src/PluginExample/MyMappingPendulumInPlane.h b/src/PluginExample/MyMappingPendulumInPlane.h
@@ -28,7 +28,7 @@
 #include <sofa/helper/OptionsGroup.h>
 
 
-namespace sofa::component::mapping
+namespace pluginexample
 {
 
 using type::vector;
@@ -84,5 +84,5 @@ class MyMappingPendulumInPlane: public core::Mapping<TIn, TOut>
     vector<Vec2> gap;
 };
 
-} // namespace sofa::component::mapping
+} // namespace pluginexample
 
diff --git a/src/PluginExample/MyMappingPendulumInPlane.inl b/src/PluginExample/MyMappingPendulumInPlane.inl
@@ -32,7 +32,7 @@ using std::cerr;
 using std::endl;
 
 
-namespace sofa::component::mapping
+namespace pluginexample
 {
 
 using helper::ReadAccessor;
@@ -57,8 +57,8 @@ MyMappingPendulumInPlane<In, Out>::~MyMappingPendulumInPlane()
 template <class In, class Out>
 void MyMappingPendulumInPlane<In, Out>::init()
 {
-    ReadAccessor<Data<VecOutCoord> > out (*this->toModel->read(core::ConstVecCoordId::position()));
-    WriteAccessor<Data<VecInCoord> > in (*this->fromModel->write(core::VecCoordId::position()));
+    ReadAccessor<Data<VecOutCoord> > out (*this->toModel->read(core::vec_id::read_access::position));
+    WriteAccessor<Data<VecInCoord> > in (*this->fromModel->write(core::vec_id::write_access::position));
     WriteAccessor<Data<vector<OutReal> > > distances (d_length);
     if (distances.size() != out.size()) // values not read from file
     {
@@ -80,7 +80,7 @@ void MyMappingPendulumInPlane<In, Out>::draw(const core::visual::VisualParams* v
 {
     if (!vparams->displayFlags().getShowMappings()) return;
 
-    ReadAccessor<Data<VecOutCoord> > out (*this->toModel->read(core::ConstVecCoordId::position()));
+    ReadAccessor<Data<VecOutCoord> > out (*this->toModel->read(core::vec_id::read_access::position));
     std::vector< Vec3 > points(out.size());
 
     for (unsigned int i=0; i<out.size(); i++)
@@ -206,4 +206,4 @@ void MyMappingPendulumInPlane<In, Out>::applyDJT(const core::MechanicalParams* m
 }
 
 
-}	// namespace sofa::component::mapping 
+}	// namespace pluginexample 
diff --git a/src/PluginExample/MyProjectiveConstraintSet.cpp b/src/PluginExample/MyProjectiveConstraintSet.cpp
@@ -24,21 +24,22 @@
 #include <sofa/core/ObjectFactory.h>
 
 
-namespace sofa::component::projectiveconstraintset
+namespace pluginexample
 {
-
+    
 using namespace sofa::defaulttype;
 
-
-int MyProjectiveConstraintSetClass = core::RegisterObject("just an example of templated component")
+void registerMyProjectiveConstraintSet(sofa::core::ObjectFactory* factory)
+{
+    factory->registerObjects(core::ObjectRegistrationData("Just an example of templated component.")
     .add< MyProjectiveConstraintSet<Vec3Types> >()
     .add< MyProjectiveConstraintSet<Vec1Types> >()
-    .add< MyProjectiveConstraintSet<Rigid3Types> >()
-;
+    .add< MyProjectiveConstraintSet<Rigid3Types> >());
+}
 
 template class SOFA_PLUGINEXAMPLE_API MyProjectiveConstraintSet<Rigid3Types>;
 template class SOFA_PLUGINEXAMPLE_API MyProjectiveConstraintSet<Vec3Types>;
 
 
 
-} // namespace sofa::component::projectiveconstraintset
+} // namespace pluginexample
diff --git a/src/PluginExample/MyProjectiveConstraintSet.h b/src/PluginExample/MyProjectiveConstraintSet.h
@@ -28,7 +28,7 @@
 #include <sofa/defaulttype/VecTypes.h>
 
 
-namespace sofa::component::projectiveconstraintset
+namespace pluginexample
 {
 
 template <class DataTypes>
diff --git a/src/PluginExample/MyProjectiveConstraintSet.inl b/src/PluginExample/MyProjectiveConstraintSet.inl
@@ -24,7 +24,7 @@
 #include <PluginExample/MyProjectiveConstraintSet.h>
 
 
-namespace sofa::component::projectiveconstraintset
+namespace pluginexample
 {
 
 template <class DataTypes>
@@ -52,4 +52,4 @@ void MyProjectiveConstraintSet<DataTypes>::reinit()
 
 
 
-} // namespace sofa::component::projectiveconstraintset
+} // namespace pluginexample
diff --git a/src/PluginExample/MyVisualModel.cpp b/src/PluginExample/MyVisualModel.cpp
@@ -24,7 +24,7 @@
 #include <sofa/core/ObjectFactory.h>
 
 
-namespace sofa::component::visual
+namespace pluginexample
 {
 
 MyVisualModel::MyVisualModel()
@@ -44,8 +44,11 @@ void MyVisualModel::reinit()
 {
 }
 
-int MyVisualModelClass = core::RegisterObject("Dummy visual component.").add< MyVisualModel >();
-
+void registerMyVisualModel(sofa::core::ObjectFactory* factory)
+{
+    factory->registerObjects(core::ObjectRegistrationData("Dummy visual component.")
+    .add< MyVisualModel >());
+}
 
-} // namespace sofa::component::visual
+} // namespace pluginexample
 
diff --git a/src/PluginExample/MyVisualModel.h b/src/PluginExample/MyVisualModel.h
@@ -27,7 +27,7 @@
 #include <sofa/component/visual/VisualModelImpl.h>
 
 
-namespace sofa::component::visual
+namespace pluginexample
 {
 
 /**
@@ -53,5 +53,5 @@ class SOFA_PLUGINEXAMPLE_API MyVisualModel : public sofa::component::visual::Vis
 };
 
 
-} // sofa::component::visual
+} // namespace pluginexample
 
diff --git a/src/PluginExample/config.h.in b/src/PluginExample/config.h.in
@@ -23,6 +23,9 @@
 
 #include <sofa/config.h>
 
+// adding SOFA namespace to ease using SOFA classes within the plugin
+using namespace sofa;
+
 #define PLUGINEXAMPLE_VERSION @PROJECT_VERSION@
 
 #ifdef SOFA_BUILD_PLUGINEXAMPLE
@@ -32,3 +35,8 @@
 #  define SOFA_PLUGINEXAMPLE_API SOFA_IMPORT_DYNAMIC_LIBRARY
 #endif
 
+namespace pluginexample
+{
+    constexpr const char* MODULE_NAME = "@PROJECT_NAME@";
+    constexpr const char* MODULE_VERSION = "@PROJECT_VERSION@";
+} // namespace pluginexample
diff --git a/src/PluginExample/initPluginExample.cpp b/src/PluginExample/initPluginExample.cpp

Original file line number	Diff line number	Diff line change
`@@ -26,23 +26,24 @@ using std::vector;`
`26`	`26`
`27`	`27`	`#include <sofa/testing/BaseTest.h>`
`28`	`28`	`using sofa::testing::BaseTest;`
`29`		`-`
`30`	`29`	`using ::testing::Types;`
`31`	`30`
	`31`	`+using namespace pluginexample;`
	`32`	`+`
`32`	`33`	`namespace {`
`33`	`34`
`34`	`35`	`class MyBehaviorModel_test : public BaseTest,`
`35`	`36`	`public ::testing::WithParamInterface<unsigned>`
`36`	`37`	`{`
`37`	`38`	`public:`
`38`		`- using MyBehaviorModel = sofa::component::behaviormodel::MyBehaviorModel;`
	`39`	`+ using MyBehaviorModel = pluginexample::MyBehaviorModel;`
`39`	`40`
`40`		`- void TearDown()`
	`41`	`+ void doTearDown() override`
`41`	`42`	`{`
`42`	`43`
`43`	`44`	`}`
`44`	`45`
`45`		`- void SetUp()`
	`46`	`+ void doSetUp() override`
`46`	`47`	`{`
`47`	`48`	`m_behaviorModel = sofa::core::objectmodel::New< MyBehaviorModel >();`
`48`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`#include <sofa/core/BehaviorModel.h>`
`27`	`27`
`28`	`28`
`29`		`-namespace sofa::component::behaviormodel`
	`29`	`+namespace pluginexample`
`30`	`30`	`{`
`31`	`31`
`32`	`32`	`/**`
`@@ -52,5 +52,5 @@ class SOFA_PLUGINEXAMPLE_API MyBehaviorModel : public sofa::core::BehaviorModel`
`52`	`52`	`};`
`53`	`53`
`54`	`54`
`55`		`-} // sofa::component::behaviormodel`
	`55`	`+} // namespace pluginexample`
`56`	`56`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`#include <sofa/helper/Factory.h>`
`25`	`25`
`26`	`26`
`27`		`-namespace sofa::gui::qt`
	`27`	`+namespace pluginexample`
`28`	`28`	`{`
`29`	`29`
`30`	`30`	`/*`
`@@ -112,4 +112,4 @@ void MyDataWidgetUnsigned::change()`
`112`	`112`	`}`
`113`	`113`
`114`	`114`
`115`		`-} // namespace sofa::gui::qt`
	`115`	`+} // namespace pluginexample`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`#include <QString>`
`32`	`32`
`33`	`33`
`34`		`-namespace sofa::gui::qt`
	`34`	`+namespace pluginexample`
`35`	`35`	`{`
`36`	`36`
`37`	`37`	`/**`
`@@ -65,4 +65,4 @@ protected slots:`
`65`	`65`	`};`
`66`	`66`
`67`	`67`
`68`		`-} // namespace sofa::gui::qt`
	`68`	`+} // namespace pluginexample`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ using std::cerr;`
`32`	`32`	`using std::endl;`
`33`	`33`
`34`	`34`
`35`		`-namespace sofa::component::mapping`
	`35`	`+namespace pluginexample`
`36`	`36`	`{`
`37`	`37`
`38`	`38`	`using helper::ReadAccessor;`
`@@ -57,8 +57,8 @@ MyMappingPendulumInPlane<In, Out>::~MyMappingPendulumInPlane()`
`57`	`57`	`template <class In, class Out>`
`58`	`58`	`void MyMappingPendulumInPlane<In, Out>::init()`
`59`	`59`	`{`
`60`		`- ReadAccessor<Data<VecOutCoord> > out (*this->toModel->read(core::ConstVecCoordId::position()));`
`61`		`- WriteAccessor<Data<VecInCoord> > in (*this->fromModel->write(core::VecCoordId::position()));`
	`60`	`+ ReadAccessor<Data<VecOutCoord> > out (*this->toModel->read(core::vec_id::read_access::position));`
	`61`	`+ WriteAccessor<Data<VecInCoord> > in (*this->fromModel->write(core::vec_id::write_access::position));`
`62`	`62`	`WriteAccessor<Data<vector<OutReal> > > distances (d_length);`
`63`	`63`	`if (distances.size() != out.size()) // values not read from file`
`64`	`64`	`{`
`@@ -80,7 +80,7 @@ void MyMappingPendulumInPlane<In, Out>::draw(const core::visual::VisualParams* v`
`80`	`80`	`{`
`81`	`81`	`if (!vparams->displayFlags().getShowMappings()) return;`
`82`	`82`
`83`		`- ReadAccessor<Data<VecOutCoord> > out (*this->toModel->read(core::ConstVecCoordId::position()));`
	`83`	`+ ReadAccessor<Data<VecOutCoord> > out (*this->toModel->read(core::vec_id::read_access::position));`
`84`	`84`	`std::vector< Vec3 > points(out.size());`
`85`	`85`
`86`	`86`	`for (unsigned int i=0; i<out.size(); i++)`
`@@ -206,4 +206,4 @@ void MyMappingPendulumInPlane<In, Out>::applyDJT(const core::MechanicalParams* m`
`206`	`206`	`}`
`207`	`207`
`208`	`208`
`209`		`-} // namespace sofa::component::mapping`
	`209`	`+} // namespace pluginexample`