Change in keyboard shortcuts (imgui)

[hugtalbot]

As stated by @accuracy-maker (thank you for making me write this post 🙏) in #5954, the way to interact with the keyboard and keyboard shortcuts changed in the new ImGui-based GUI for SOFA.

Several shortcuts are related to the window:

• F11: switch to fullscreen
• Escape: close the app
• Space: play/pause the simulation
• Any letter on your keyboard would result in a search in the scene graph

Using the control (CTRL) key, you activate GUI shortcuts such as:

• Ctrl+A: show the scene axis
• Ctrl+B: switch the background
• Ctrl+R: reload the current scene
• Ctrl+O: open a scene file

Using the SHIFT key, you activate the scene interactions such as the mouse interaction.

Using the SHIFT + CTRL keys, you will trigger events on key pressed/released.

[hugtalbot]

The documentation has been updated accordingly here: https://sofa-framework.github.io/doc/using-sofa/runsofa-with-imgui/#keyboard-shortcuts

[accuracy-maker]

Hi Hugo,

Thanks for updating!!!. Base on my own experience, I modified Key logic a bit. The previous implementation is in SofaGLFW/src/SofaGLFW/SofaGLFWBaseGUI.cpp:

    // Key events are forwarded to SOFA using: CTRL + SHIFT
    if (isCtrlKeyPressed && isShiftKeyPressed)
    {
        if (action == GLFW_PRESS)
        {
            KeypressedEvent keyPressedEvent(keyName);
            rootNode->propagateEvent(core::ExecParams::defaultInstance(), &keyPressedEvent);
        }
        else if (action == GLFW_RELEASE)
        {
            KeyreleasedEvent keyReleasedEvent(keyName);
            rootNode->propagateEvent(core::ExecParams::defaultInstance(), &keyReleasedEvent);
        }
    }

which doesn't allow you to keep pressing the key. If your action is too small, you might need to press the key many times.

I change it to

    // Key events are forwarded to SOFA using: CTRL + SHIFT
    if (isCtrlKeyPressed && isShiftKeyPressed)
    {
        // if (action == GLFW_PRESS)
        // {
        //     KeypressedEvent keyPressedEvent(keyName);
        //     rootNode->propagateEvent(core::ExecParams::defaultInstance(), &keyPressedEvent);
        // }
        if (action == GLFW_PRESS || action == GLFW_REPEAT)
        {
            KeypressedEvent keyPressedEvent(keyName);
            rootNode->propagateEvent(core::ExecParams::defaultInstance(), &keyPressedEvent);
        }
        else if (action == GLFW_RELEASE)
        {
            KeyreleasedEvent keyReleasedEvent(keyName);
            rootNode->propagateEvent(core::ExecParams::defaultInstance(), &keyReleasedEvent);
        }
    }

which makes the keyboard control much easier lol.

Cheers,

[hugtalbot]

Nice do not hesitate to PR it

[accuracy-maker]

I submitted the PR.

Best,