Configure Mouse Manager Settings in SofaPython3

[jo-ntan15]

Hello, I would like to manipulate some parameters of mouse interactions within the code, instead of using the SOFA gui. More specifically, I'm trying to change the mouse stiffness parameter of "attach an object to the mouse using a spring force field". Is that doable?

Thank you!

[th-skam]

Hi @jo-ntan15,

You can check out this example scene:
https://github.com/sofa-framework/sofa/blob/master/examples/Demos/liverConfiguration.scn
At some point in this XML script, you will see it adds the AttachBodyButtonSetting component and sets the stiffness. You can launch this scene and check out how this component affected the Mouse Manager settings for the Right mouse button.

In SofaPython3, if you wanted to add this component to your root node, you would be writing:

root.addObject("AttachBodyButtonSetting", stiffness=15, etc...)

Sidenote: if you are using the FreeMotionAnimationLoop in your simulation, I would suggest you use the ConstraintAttachButtonSetting instead. This adds a Bilateral Lagrangian constraint to perform the mouse interactions, for which you need not set a stiffness parameter.

Docs for the two components I mentioned:
https://sofa-framework.github.io/doc/components/gui/attachbodybuttonsetting/
https://sofa-framework.github.io/doc/components/gui/constraintattachbuttonsetting/

Hope this answers your question

[jo-ntan15]

Hi there, thank you for your response!

I did already come across that example scene. However it didn't work for me when I opened it with runSofa. I've also tried adding the "AttachBodyButtonSetting" object in python, with no success.

Above is exactly what I have right now, and Sofa did not throw me any errors.

Could the scene example/docs be dated for this component?

[bakpaul]

Hello, it is strange that it doesn't work in your example. What makes you think so ? Is the behavior the same ? Have you checked the mouse setting window to see if the actual stiffness value has changed ?

Can you try this scene : sofa/examples/Component/Constraint/Lagrangian/FixedLagrangianConstaint_Rigid3.scn (in the examples of the source. You should be able to pull on the needle if the object behaves correctly. If not the needle will explode directly (One side of the needle is attached, try pulling on the middle)

[jo-ntan15]

hello, thank you for your response.

The scene does work and the stiffness is indeed set to 5.

For the liverConfiguration scene, i do see the stiffness updating and switching to the right mouse button, but it doesn't actually pull or drag anything in the scene.

Although when I added the exact line to my python script root.addObject('AttachBodyButtonSetting',stiffness="100"), it doesn't work at all. The stiffness does not update in the mouse manager window. Do i have to access python's mouse manager differently?

[bakpaul]

Hello @jo-ntan15 sorry for the very late reply. I know that we had some trouble with the new imgui-based GUI on mouse interaction. Unfortunately, it wasn't fully working. Which GUI do you use ? And if it is imgui, this souhld be solved in the next release (v25.12, no binaries released yet but the branch is there https://github.com/sofa-framework/sofa/tree/v25.12)