Take comments into account

Author: bakpaul

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

@@ -35,7 +35,7 @@ using sofa::core::objectmodel::BaseComponent;
 // ---------------------------------------------------------------------------
 
 Component_Trampoline::Component_Trampoline()
-    : TrampolineBase(this)   // pass this as BaseComponent* — no CRTP needed
+    : BasetTrampoline(this)   // pass this as BaseComponent* — no CRTP needed
 {
 }
 

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

@@ -28,11 +28,11 @@
 namespace sofapython3 {
 
 
-class TrampolineBase
+class BasetTrampoline
 {
 public:
-    explicit TrampolineBase(sofa::core::objectmodel::BaseComponent* self);
-    ~TrampolineBase();
+    explicit BasetTrampoline(sofa::core::objectmodel::BaseComponent* self);
+    ~BasetTrampoline();
 
     void trampoline_handleEvent(sofa::core::objectmodel::Event* event);
     std::string trampoline_getClassName() const;
@@ -46,7 +46,7 @@ class TrampolineBase
                           const std::string& methodName);
 
     /// Raw non-owning pointer to the concrete trampoline as BaseComponent.
-    /// Safe because TrampolineBase is always embedded in the same object.
+    /// Safe because BasetTrampoline is always embedded in the same object.
     sofa::core::objectmodel::BaseComponent* m_componentSelf { nullptr };
 
     pybind11::object m_pySelf;
@@ -70,7 +70,7 @@ class Component : public sofa::core::objectmodel::BaseComponent {
     void reinit() override {}
 };
 
-class Component_Trampoline : public Component, public TrampolineBase
+class Component_Trampoline : public Component, public BasetTrampoline
 {
 public:
     SOFA_CLASS(Component_Trampoline, Component);

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Component.inl

@@ -37,22 +37,22 @@ using sofa::core::objectmodel::Event;
 using sofa::core::objectmodel::BaseComponent;
 
 
-inline TrampolineBase::TrampolineBase(BaseComponent* self)
+inline BasetTrampoline::BasetTrampoline(BaseComponent* self)
     : m_componentSelf(self)
 {
 }
 
-inline TrampolineBase::~TrampolineBase()
+inline BasetTrampoline::~BasetTrampoline()
 {
     if (m_cacheInitialized)
     {
-        PythonEnvironment::gil acquire {"~TrampolineBase"};
+        PythonEnvironment::gil acquire {"~BasetTrampoline"};
         m_methodCache.clear();
         m_pySelf = py::object();
     }
 }
 
-inline void TrampolineBase::initializePythonCache()
+inline void BasetTrampoline::initializePythonCache()
 {
     if (m_cacheInitialized)
         return;
@@ -66,7 +66,7 @@ inline void TrampolineBase::initializePythonCache()
     m_cacheInitialized = true;
 }
 
-inline py::object TrampolineBase::getCachedMethod(const std::string& methodName)
+inline py::object BasetTrampoline::getCachedMethod(const std::string& methodName)
 {
     auto it = m_methodCache.find(methodName);
     if (it != m_methodCache.end())
@@ -84,7 +84,7 @@ inline py::object TrampolineBase::getCachedMethod(const std::string& methodName)
     return method;
 }
 
-inline bool TrampolineBase::callCachedMethod(const py::object& method, Event* event)
+inline bool BasetTrampoline::callCachedMethod(const py::object& method, Event* event)
 {
     if (m_componentSelf->f_printLog.getValue())
     {
@@ -99,14 +99,14 @@ inline bool TrampolineBase::callCachedMethod(const py::object& method, Event* ev
     return py::cast<bool>(result);
 }
 
-inline void TrampolineBase::invalidateMethodCache(const std::string& methodName)
+inline void BasetTrampoline::invalidateMethodCache(const std::string& methodName)
 {
     if (!m_cacheInitialized)
         return;
     m_methodCache.erase(methodName);
 }
 
-inline std::string TrampolineBase::trampoline_getClassName() const
+inline std::string BasetTrampoline::trampoline_getClassName() const
 {
     PythonEnvironment::gil acquire {"getClassName"};
 
@@ -117,7 +117,7 @@ inline std::string TrampolineBase::trampoline_getClassName() const
     return py::str(py::type::of(py::cast(m_componentSelf)).attr("__name__"));
 }
 
-inline bool TrampolineBase::callScriptMethod(
+inline bool BasetTrampoline::callScriptMethod(
     const py::object& self, Event* event, const std::string& methodName)
 {
     if (m_componentSelf->f_printLog.getValue())
@@ -138,7 +138,7 @@ inline bool TrampolineBase::callScriptMethod(
     return false;
 }
 
-inline void TrampolineBase::trampoline_handleEvent(Event* event)
+inline void BasetTrampoline::trampoline_handleEvent(Event* event)
 {
     PythonEnvironment::executePython(m_componentSelf, [this, event](){
         if (!m_cacheInitialized)

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

@@ -24,19 +24,21 @@ namespace sofapython3::doc::component
 {
 static auto componentClass =
         R"(
-        Overridable class for user interaction on SOFA Components
+        Overridable class for SOFA Components
 
         It can catch events to trigger actions, such as onAnimateBeginEvent, onAnimateEndEvent or onPythonScriptEvent.
-        A new custom controller class needs to be defined to use a controller in a script,
+        A new custom Components class needs to be defined to use a Components in a script,
         and that class needs to reimplement the __init__ method.
 
         :example of use:
 
-        In the following example, we redefine the controller class, and reimplement the __init__ method.
-        We also implement the onAnimateBeginEvent, that will be activted everytime an animation step ends
+        In the following example, we redefine the Components class, and reimplement the __init__ method.
+        We also implement the init and onAnimateBeginEvent methods, the last one will be activted everytime an animation step ends
         and that will simply print a message in the command line. In the createScene function, we initialize
-        the controller and add it to the rootNode.
-        If you run this with runSofa, it will simply endlessly print `onAnimateBeginEvent`
+        the Components and add it to the rootNode.
+        If you run this with runSofa, it will first print "Init component" before you start the simulation, then
+        it will simply endlessly print `onAnimateBeginEvent`
+
         when you click the Animate button.
 
             .. code-block:: python
@@ -45,18 +47,24 @@ static auto componentClass =
 
                 class MyComponent(Sofa.Core.Component):
                     def __init__(self, *args, **kwargs):
-                         ## These are needed (and the normal way to override from a python class)
-                         Sofa.Core.Component.__init__(self, *args, **kwargs)
-                         print(" Python::__init__::"+str(self.name))
+                        ## These are needed (and the normal way to override from a python class)
+                        Sofa.Core.Component.__init__(self, *args, **kwargs)
+                        print(" Python::__init__::"+str(self.name))
+
+                    def init():
+                        """This function is called at the initialization stage of the component.
+                           Right after the call to 'createScene' when the root node is initialized.
+                        """
+                        print("Init component")
 
                     def onEvent(self, event):
-                         """This function is the fallback one that is called if the XXXX event is
-                            received but there is not overriden onXXXX() method.
-                         """
-                         print("generic event handler catched ", event)
+                        """This function is the fallback one that is called if the XXXX event is
+                           received but there is not overriden onXXXX() method.
+                        """
+                        print("generic event handler catched ", event)
 
                     def onAnimateBeginEvent(self, event):
-                         print("onAnimateBeginEvent")
+                        print("onAnimateBeginEvent")
 
                 def createScene(rootNode):
                     controller = MyComponent(name="MyC")

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

@@ -43,7 +43,7 @@ using sofa::core::behavior::BaseController;
 // ---------------------------------------------------------------------------
 
 Controller_Trampoline::Controller_Trampoline()
-    : TrampolineBase(this)   // pass this as BaseComponent* — no CRTP needed
+    : BasetTrampoline(this)   // pass this as BaseComponent* — no CRTP needed
 {
 }
 

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

@@ -38,7 +38,7 @@ class Controller : public sofa::core::behavior::BaseController {
     void reinit() override {}
 };
 
-class Controller_Trampoline : public Controller, public TrampolineBase
+class Controller_Trampoline : public Controller, public BasetTrampoline
 {
 public:
     SOFA_CLASS(Controller_Trampoline, Controller);