Don't clone visuals with an ignore flag

[adlarkin]

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

Summary

While working on gazebosim/gz-sim#1013, I noticed that there are times where certain visuals shouldn't be cloned. I've added support for setting a boolean UserData flag with a key of skip-visual-clone on a visual. If a visual has UserData with this key, it will not be cloned.

For an example of how this is useful, see the second half of gazebosim/gz-sim#1013 (comment).

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

[codecov]

Codecov Report

Merging #442 (dc6cdfd) into ign-rendering6 (34d1d0a) will increase coverage by 0.02%.
The diff coverage is 100.00%.

@@                Coverage Diff                 @@
##           ign-rendering6     #442      +/-   ##
==================================================
+ Coverage           53.46%   53.48%   +0.02%     
==================================================
  Files                 192      192              
  Lines               19536    19545       +9     
==================================================
+ Hits                10444    10454      +10     
+ Misses               9092     9091       -1     

Impacted Files	Coverage Δ
include/ignition/rendering/Visual.hh	100.00% <ø> (ø)
include/ignition/rendering/base/BaseVisual.hh	71.49% <100.00%> (+1.29%)	⬆️
...e/ignition/rendering/base/BaseGaussianNoisePass.hh	100.00% <0.00%> (+3.33%)	⬆️

---

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 34d1d0a...dc6cdfd. Read the comment docs.

[adlarkin]

I'm closing this PR because this functionality is now a part of ign-gazebo: see gazebosim/gz-sim#1103