Add API for particle emitter scatter ratio

[adlarkin]

Signed-off-by: Ashton Larkin [email protected]

🦟 Bug fix

Addresses a missing API that was mentioned here. This breaks ABI, so this is targeting Edifice before release.

Summary

Checklist

• Signed all commits for DCO
• Added tests
• 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

[adlarkin]

@iche033 this is ready for review. I just have one question, which I tried to explain below.

It also looks like a particle scatter-related test is now failing on Ubuntu CI 😬 I'm not sure why though, because I did some debugging and believe that the scatter ratio is being set correctly in shaders. Can you tell me if you notice anything here that may be related to these failures?

Edit: Failures should be gone now after 5dc273f. Let me know if I am missing any other tests that need to be updated.

[codecov]

Codecov Report

Merging #275 (23be0b8) into main (eefcdd9) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #275   +/-   ##
=======================================
  Coverage   57.54%   57.54%           
=======================================
  Files         159      159           
  Lines       15595    15588    -7     
=======================================
- Hits         8974     8970    -4     
+ Misses       6621     6618    -3     

Impacted Files	Coverage Δ
include/ignition/rendering/ParticleEmitter.hh	100.00% <ø> (ø)
ogre2/src/Ogre2ParticleNoiseListener.hh	100.00% <ø> (ø)
...ude/ignition/rendering/base/BaseParticleEmitter.hh	48.19% <100.00%> (+4.03%)	⬆️
ogre2/src/Ogre2ParticleNoiseListener.cc	92.85% <100.00%> (+3.76%)	⬆️

---

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 eefcdd9...23be0b8. Read the comment docs.

[iche033]

nice, looks good to me. just one minor comment.

thanks for adding the new API!

[adlarkin]

We'll need to update the related code in ign-gazebo as well, but I think that we might need to wait to do that. In particular, we can now use these new API calls in ign-gazebo/src/rendering/SceneManager.cc (gazebosim/gz-sim#674), but we will need to wait for that PR to be merged and forward-ported first.