Emit more events from Scene3D #213

chapulina · 2021-04-27T15:53:11Z

🎉 New feature

Closes #209

Summary

This PR makes the 3D scene emit more events, such as clicks and hover, that can be used by other plugins. Most of the code here has been ported from ignition::gazebo::Scene3D.

I got stuck writing tests for it though, for some reason the render engine plugin is not properly loaded. I spent some time digging deep into ign-plugin with no luck. I'll leave this as draft until I can address this.

Test it

I'd like to add an example plugin that makes use of these events, so others can use it as a pattern to copy for their needs.

Checklist

Signed all commits for DCO
Added tests - that's the tough part
Added example and/or tutorial - TODO
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

🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸

Signed-off-by: Louise Poubel <louise@openrobotics.org>

chapulina · 2021-04-29T18:30:39Z

I removed the tests that weren't working and ticketed #216. Opening this for review.

It's worth reading the conversation on #209. The current approach to emitting events is necessary for some use cases, but adds unnecessary complexity for others. I think we could revisit the current architecture in a future release in favor of an objectName-based approach for specific use cases.

There seems to be a problem with loading the ignition-rendering-ogre plugin from the Scene3D test if it links to that plugin. Making Scene3D_TEST.cc into an integration test works because it doesn't directly call any plugin methods. This also changes the linking for the Grid3D plugin to only link to the ignition-rendering core library target instead of the IGNITION-RENDERING_LIBRARIES variable which includes the ogre component library plugins. Signed-off-by: Steve Peters <scpeters@openrobotics.org>

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

…apulina/3/events

scpeters · 2021-05-08T00:08:16Z

I've fixed the issue with loading the render engines documented in #216 and have merged those changes into this branch. I moved Scene3D_TEST.cc to test/integration, and it seems to be working now.

Signed-off-by: Louise Poubel <louise@openrobotics.org>

chapulina · 2021-05-14T23:45:41Z

I added a test for the render event in 23c0578. I won't have time to add tests for the other events for a while. Options:

Get this in with the current tests and add more tests later (this is already more testing than most plugins)
Someone else picks up this PR and adds tests for the click and hover events
Wait until I come back

codecov · 2021-05-14T23:53:42Z

Codecov Report

Merging #213 (096c868) into ign-gui3 (a7e659e) will increase coverage by 6.00%.
The diff coverage is 47.05%.

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

@@             Coverage Diff              @@
##           ign-gui3     #213      +/-   ##
============================================
+ Coverage     59.55%   65.56%   +6.00%     
============================================
  Files            23       23              
  Lines          2715     2817     +102     
============================================
+ Hits           1617     1847     +230     
+ Misses         1098      970     -128

Impacted Files	Coverage Δ
src/plugins/scene3d/Scene3D.cc	`42.38% <47.05%> (+29.78%)`	⬆️

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 a7e659e...e75cff4. Read the comment docs.

scpeters · 2021-05-15T02:05:26Z

I added a test for the render event in 23c0578. I won't have time to add tests for the other events for a while. Options:

Get this in with the current tests and add more tests later (this is already more testing than most plugins)

Someone else picks up this PR and adds tests for the click and hover events

Wait until I come back

I can try adding some more tests. Do you know how to create fake mouse clicks from a test?

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

scpeters · 2021-05-25T20:38:37Z

I just noticed the windows build has been broken since 23c0578

error C2491: 'ignition::gui::TestHelper::staticMetaObject': definition of dllimport static data member not allowed

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

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

Signed-off-by: Alejandro Hernández <ahcorde@gmail.com>

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

scpeters · 2021-05-27T06:57:15Z

I've added some expectations about the value of the Vector3d passed with the click events in 48171dd, and if CI is reasonable, then I will be ready to approve

ahcorde · 2021-05-27T07:01:27Z

test/integration/scene3d.cc

+      std::cerr << "hoverToScene point["
+                << hoverToScene->Point() << "]" << std::endl;


Remove this trace ?

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

* Release 3.5.1 (#195) Signed-off-by: Steve Peters <scpeters@openrobotics.org> * check_test_ran.py: remove grep/xsltproc (#203) We aren't using QTest anymore in ign-gui, so remove the parts of check_test_ran.py that translated QTest xml files into junit, since they don't work easily on Windows and aren't needed any longer. Fixes #198. Signed-off-by: Steve Peters <scpeters@openrobotics.org> * Fixed material specular in scene3D (#218) Signed-off-by: ahcorde <ahcorde@gmail.com> * Remove tools/code_check and update codecov (#222) Signed-off-by: Louise Poubel <louise@openrobotics.org> * Removed duplicated code with rendering::sceneFromFirstRenderEngine (#223) Signed-off-by: ahcorde <ahcorde@gmail.com> * Emit more events from Scene3D (#213) * Start porting events from ign-gazebo Signed-off-by: Louise Poubel <louise@openrobotics.org> * Remove test that fails due to #216 Signed-off-by: Louise Poubel <louise@openrobotics.org> * Move Scene3d_TEST.cc to test/integration There seems to be a problem with loading the ignition-rendering-ogre plugin from the Scene3D test if it links to that plugin. Making Scene3D_TEST.cc into an integration test works because it doesn't directly call any plugin methods. This also changes the linking for the Grid3D plugin to only link to the ignition-rendering core library target instead of the IGNITION-RENDERING_LIBRARIES variable which includes the ogre component library plugins. Signed-off-by: Steve Peters <scpeters@openrobotics.org> * process qt events to allow scene to initialize Signed-off-by: Steve Peters <scpeters@openrobotics.org> * Add test helper to check event Signed-off-by: Louise Poubel <louise@openrobotics.org> * added more tests Signed-off-by: ahcorde <ahcorde@gmail.com> * make linters happy Signed-off-by: ahcorde <ahcorde@gmail.com> * Move TestHelper code to .cc file, fix windows? Signed-off-by: Steve Peters <scpeters@openrobotics.org> * Fix windows? Signed-off-by: ahcorde <ahcorde@gmail.com> * Fix windows? Signed-off-by: Alejandro Hernández <ahcorde@gmail.com> * Expect values of Vector3 point in click events Signed-off-by: Steve Peters <scpeters@openrobotics.org> * Remove debug message Signed-off-by: Steve Peters <scpeters@openrobotics.org> * Remove unused variable Signed-off-by: Steve Peters <scpeters@openrobotics.org> Co-authored-by: Steve Peters <scpeters@openrobotics.org> Co-authored-by: ahcorde <ahcorde@gmail.com> * Avoid grid3D crash (#227) Signed-off-by: ahcorde <ahcorde@gmail.com> * Confirmation dialog when closing main window (#225) * Adds confirmation dialog when closing window * Updates docs and extends test coverage. * Adds dialog_on_exit atribute to example .config Signed-off-by: Franco Cipollone <franco.c@ekumenlabs.com> * update codeowners (#232) Signed-off-by: Jenn Nguyen <jenn@openrobotics.org> * 🎈 3.6.0 (#233) Signed-off-by: Louise Poubel <louise@openrobotics.org> * Bump required ign-rendering version to 4.8 (#234) Signed-off-by: Louise Poubel <louise@openrobotics.org> Co-authored-by: Steve Peters <scpeters@openrobotics.org> Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com> Co-authored-by: Franco Cipollone <53065142+francocipollone@users.noreply.github.com> Co-authored-by: Jenn Nguyen <jenn@openrobotics.org>

Start porting events from ign-gazebo

2eb2ee0

Signed-off-by: Louise Poubel <louise@openrobotics.org>

github-actions bot added the 🏰 citadel Ignition Citadel label Apr 27, 2021

chapulina mentioned this pull request Apr 27, 2021

Send more events from Scene3D #209

Closed

chapulina mentioned this pull request Apr 29, 2021

Failing to load render engine plugin in tests #216

Closed

Remove test that fails due to #216

8299a15

Signed-off-by: Louise Poubel <louise@openrobotics.org>

chapulina marked this pull request as ready for review April 29, 2021 18:27

scpeters self-requested a review April 29, 2021 18:39

scpeters added 4 commits May 6, 2021 11:51

process qt events to allow scene to initialize

341db2a

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

Merge remote-tracking branch 'origin/scpeters/3/events_debug' into ch…

d576a5b

…apulina/3/events

Merge branch 'ign-gui3' into chapulina/3/events

135dcc2

chapulina added 2 commits May 14, 2021 15:18

Merge branch 'ign-gui3' into chapulina/3/events

142c0e5

Signed-off-by: Louise Poubel <louise@openrobotics.org>

Add test helper to check event

23c0578

Signed-off-by: Louise Poubel <louise@openrobotics.org>

added more tests

a38108b

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

ahcorde mentioned this pull request May 25, 2021

Emit key events from Scene3D #224

Merged

8 tasks

make linters happy

acfa9b8

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

scpeters and others added 4 commits May 25, 2021 14:05

Move TestHelper code to .cc file, fix windows?

67ed9a7

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

Fix windows?

d925bee

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

Fix windows?

53cbb41

Signed-off-by: Alejandro Hernández <ahcorde@gmail.com>

Merge branch 'ign-gui3' into chapulina/3/events

b622d6d

ahcorde mentioned this pull request May 26, 2021

Added camera tracking #226

Merged

8 tasks

ahcorde mentioned this pull request May 26, 2021

Move some plugins to ign-gui gazebosim/gz-sim#835

Closed

Expect values of Vector3 point in click events

48171dd

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

ahcorde requested changes May 27, 2021

View reviewed changes

scpeters added 2 commits May 27, 2021 00:10

Remove debug message

039ef43

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

Remove unused variable

e75cff4

Signed-off-by: Steve Peters <scpeters@openrobotics.org>

scpeters approved these changes May 27, 2021

View reviewed changes

ahcorde enabled auto-merge (squash) May 27, 2021 09:40

ahcorde merged commit 4a0159b into ign-gui3 May 27, 2021

ahcorde approved these changes May 27, 2021

View reviewed changes

ahcorde deleted the chapulina/3/events branch May 27, 2021 09:44

ahcorde mentioned this pull request Jun 8, 2021

Added Interactive view control plugin #231

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Emit more events from Scene3D #213

Emit more events from Scene3D #213

chapulina commented Apr 27, 2021 •

edited

Loading

chapulina commented Apr 29, 2021

scpeters commented May 8, 2021

chapulina commented May 14, 2021

codecov bot commented May 14, 2021 •

edited

Loading

scpeters commented May 15, 2021

scpeters commented May 25, 2021

scpeters commented May 27, 2021

ahcorde May 27, 2021

scpeters May 27, 2021

		std::cerr << "hoverToScene point["
		<< hoverToScene->Point() << "]" << std::endl;

Emit more events from Scene3D #213

Emit more events from Scene3D #213

Conversation

chapulina commented Apr 27, 2021 • edited Loading

🎉 New feature

Summary

Test it

Checklist

chapulina commented Apr 29, 2021

scpeters commented May 8, 2021

chapulina commented May 14, 2021

codecov bot commented May 14, 2021 • edited Loading

Codecov Report

scpeters commented May 15, 2021

scpeters commented May 25, 2021

scpeters commented May 27, 2021

ahcorde May 27, 2021

Choose a reason for hiding this comment

scpeters May 27, 2021

Choose a reason for hiding this comment

chapulina commented Apr 27, 2021 •

edited

Loading

codecov bot commented May 14, 2021 •

edited

Loading