Emit key events from Scene3D

[ahcorde]

Signed-off-by: ahcorde ahcorde@gmail.com

🎉 New feature

Summary

This PR builds on top of this other PR #213. This PR makes the 3D scene emit key events (press and release), that can be used by other plugins.

Checklist

• Signed all commits for DCO
• Added tests
• Added example and/or tutorial
• Updated documentation (as needed)
• Updated migration guide (as needed)
• codecheck passed (See contributing)
• All tests passed (See test coverage)
• While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge

[codecov]

Codecov Report

Merging #224 (d2d545c) into main (2fc2862) will increase coverage by 1.58%.
The diff coverage is 100.00%.

❗ Current head d2d545c differs from pull request most recent head dd6edfa. Consider uploading reports for the commit dd6edfa to get more accurate results

@@            Coverage Diff             @@
##             main     #224      +/-   ##
==========================================
+ Coverage   65.56%   67.14%   +1.58%     
==========================================
  Files          25       25              
  Lines        3104     3138      +34     
==========================================
+ Hits         2035     2107      +72     
+ Misses       1069     1031      -38     

Impacted Files	Coverage Δ
include/ignition/gui/GuiEvents.hh	100.00% <ø> (ø)
src/GuiEvents.cc	100.00% <100.00%> (ø)
src/plugins/scene3d/Scene3D.cc	48.69% <100.00%> (+6.46%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2fc2862...dd6edfa. Read the comment docs.

[ahcorde]

Do not merge this PR yet, i will add key modifiers such us control, shift or alt.

[ahcorde]

I think we should add the same modifiers to the Mouse clicks, what do you think @scpeters ?

[ahcorde]

@scpeters and @mjcarroll this is ready for another pass

[mjcarroll]

Looks like something has changed on focal, presumably because of Qt5?

  /github/workspace/test/integration/scene3d.cc:271: Failure
  Expected equality of these values:
    Qt::Key_A
      Which is: 65
    keyPressedValue
      Which is: 16777251

[ahcorde]

@mjcarroll I think it's flaky...

[mjcarroll]

I think adding the copy constructor messed with all of the derived classes here as well.

[chapulina]

The idea of the PR is good, we just need to fix the build:

   In file included from /github/workspace/src/GuiEvents_TEST.cc:21:
  /github/workspace/include/ignition/gui/GuiEvents.hh: In constructor 'ignition::gui::events::KeyRelease::KeyRelease(const ignition::common::KeyEvent&)':
  /github/workspace/include/ignition/gui/GuiEvents.hh:269:38: error: use of deleted function 'ignition::common::KeyEvent::KeyEvent(const ignition::common::KeyEvent&)'
               : QEvent(kType), key(_key)

[ahcorde]

@chapulina PR is in gazebosim/gz-common#224

We need a ign-common3 release.

[chapulina]

Same as #228, since this is not used by any Citadel plugins yet, let's target it at main.

My concern with these events is that they're not PIMPL'ed and once merged into a stable version we can't iterate on them (see #239 ).

[ahcorde]

@chapulina retargeted to main and add PIMPL pattern

[chapulina]

Pushed tweaks on cdcf459.

LGTM with happy CI.

[ahcorde]

Merging, some know tests are failing: UNIT_WorldStats_TEST and UNIT_Application_TEST

[ahcorde]

@osrf-jenkins retest this please

[ahcorde]

@osrf-jenkins retest this please