Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Ogre2IgnHlmsCustomizations to Ogre2IgnHlmsSphericalClipMinDistance #534

Merged
merged 2 commits into from
Jan 19, 2022

Conversation

darksylinc
Copy link
Contributor

Summary

This is part of ticket #502

In order to split the amount of changes into maneagable, reviewable changes; the changes are being submitted in 3 PRs.

This is the 2nd PR.

It simply renames Ogre2IgnHlmsCustomizations to Ogre2IgnHlmsSphericalClipMinDistance.

The reason behind this is that customizations are now being managed by Ogre2IgnHlmsPbs & Ogre2IgnHlmsUnlit.

Since Ogre2IgnHlmsCustomizations is doing just one job but has a generic name, it would tend to confusion as to what it does and its role.

The class isn't exposed to the user; however Ogre2RenderEngine::HlmsCustomizations did expose a forward declared pointer to the user; which is why the function still exists but has been marked as deprecated.

Signed-off-by: Matias N. Goldberg dark_sylinc@yahoo.com.ar

馃 Bug fix

Affects #502

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 and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

to Ogre2IgnHlmsSphericalClipMinDistance

Signed-off-by: Matias N. Goldberg <dark_sylinc@yahoo.com.ar>
@osrf-triage osrf-triage added this to Inbox in Core development Jan 8, 2022
@github-actions github-actions bot added the 馃尡 garden Ignition Garden label Jan 8, 2022
@codecov
Copy link

codecov bot commented Jan 8, 2022

Codecov Report

Merging #534 (82bf629) into main (fe04bf1) will decrease coverage by 0.00%.
The diff coverage is 91.66%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #534      +/-   ##
==========================================
- Coverage   53.39%   53.38%   -0.01%     
==========================================
  Files         211      211              
  Lines       20817    20818       +1     
==========================================
- Hits        11115    11114       -1     
- Misses       9702     9704       +2     
Impacted Files Coverage 螖
...lude/ignition/rendering/ogre2/Ogre2RenderEngine.hh 100.00% <酶> (酶)
ogre2/src/Ogre2IgnHlmsPbsPrivate.cc 82.35% <酶> (酶)
ogre2/src/Ogre2IgnHlmsPbsPrivate.hh 100.00% <酶> (酶)
ogre2/src/Ogre2IgnHlmsUnlitPrivate.hh 100.00% <酶> (酶)
ogre2/src/Ogre2RenderEngine.cc 78.57% <77.77%> (-0.36%) 猬囷笍
ogre2/src/Ogre2GpuRays.cc 95.48% <100.00%> (酶)
ogre2/src/Ogre2IgnHlmsSphericalClipMinDistance.cc 100.00% <100.00%> (酶)
ogre2/src/Ogre2IgnHlmsSphericalClipMinDistance.hh 100.00% <100.00%> (酶)
ogre2/src/Ogre2IgnHlmsUnlitPrivate.cc 59.52% <100.00%> (酶)
...e/ignition/rendering/base/BaseGaussianNoisePass.hh 96.66% <0.00%> (-3.34%) 猬囷笍

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 fe04bf1...82bf629. Read the comment docs.

Fix deprecation warnings

Signed-off-by: Matias N. Goldberg <dark_sylinc@yahoo.com.ar>
@chapulina chapulina moved this from Inbox to In review in Core development Jan 10, 2022
Copy link
Contributor

@iche033 iche033 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me. Just one minor comment on updating the migration guide.

@@ -175,9 +175,13 @@ namespace ignition
/// \return a list of FSAA levels
public: std::vector<unsigned int> FSAALevels() const;

/// \brief Deprecated. Use SphericalClipMinDistance instead
public: Ogre2IgnHlmsSphericalClipMinDistance IGN_DEPRECATED(7) &
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add an entry to the Migration.md guide?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll add this in a separate PR

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iche033 iche033 merged commit 78baf76 into gazebosim:main Jan 19, 2022
Core development automation moved this from In review to Done Jan 19, 2022
@j-rivero j-rivero removed this from Done in Core development May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
馃尡 garden Ignition Garden
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants