Added Mouse Events

[ahcorde]

Signed-off-by: ahcorde [email protected]

🎉 New feature

Related with this issue #209. I added left and right mouse events. These events are generated by the Scene3D window, otherwise if we try to get the mouse click from other plugin we will get the click in the hole window making more difficult to handle it. Other advantage it's that we are publishing a ignition related event.

Summary

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 #228 (941803b) into main (6d0de68) will increase coverage by 0.24%.
The diff coverage is 100.00%.

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

@@            Coverage Diff             @@
##             main     #228      +/-   ##
==========================================
+ Coverage   65.31%   65.56%   +0.24%     
==========================================
  Files          24       25       +1     
  Lines        3088     3104      +16     
==========================================
+ Hits         2017     2035      +18     
+ Misses       1071     1069       -2     

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

---

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 6d0de68...4401552. Read the comment docs.

[mjcarroll]

LGTM, but the INTEGRATION_Scene3d test is segfaulting now.

[mjcarroll]

@osrf-jenkins retest this please

[chapulina]

Have you looked into the INTEGRATION_Scene3d test failure?

[chapulina]

Do you have a PR that uses these events, @ahcorde ? It would be nice to make sure the events have everything we need before merging and releasing. These classes don't use the PIMPL pattern, so if we realize later that they need more fields, we can't break ABI. See #209 (comment) for more context.

[ahcorde]

@chapulina this PR make use of it #231

[ahcorde]

friendly ping @chapulina

[chapulina]

@ahcorde , how about we target this one at main so we can iterate on it a bit. Then if we see the need to backport we can. It doesn't look like we have a use case for this on Citadel yet, right?

[ahcorde]

I will wait to this forward port #238 because it includes the scene3d tests.

[ahcorde]

@chapulina retargeted to main and add PIMPL pattern

[chapulina]

I pushed some documentation and tweaks in edcfb77.

I'm on the fence about keeping both the ClickOnScene and ClickToScene events. I think they could be combined into a single event to avoid confusion. But I'll refrain from making more changes until @scpeters opens a PR adding the distance field as proposed in #209 (comment).

Let's go with these for now!