Send mouse hover event only on spawn preview to improve framerate #950
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ian Chen <[email protected]>
Codecov Report
@@ Coverage Diff @@
## ign-gazebo3 #950 +/- ##
============================================
Coverage 77.80% 77.80%
============================================
Files 220 220
Lines 12579 12579
============================================
Hits 9787 9787
Misses 2792 2792 Continue to review full report at Codecov.
|
chapulina
reviewed
Jul 31, 2021
| @@ -889,7 +889,7 @@ void IgnRenderer::HandleMouseEvent() | |||
| ///////////////////////////////////////////////// | |||
| void IgnRenderer::BroadcastHoverPos() | |||
| { | |||
| if (this->dataPtr->hoverDirty) | |||
| if (this->dataPtr->spawnPreview && this->dataPtr->hoverDirty) | |||
There was a problem hiding this comment.
There are other plugins listening to the hover event, such as TapeMeasure:
chapulina
suggested changes
Jul 31, 2021
chapulina
added
performance
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Ian Chen [email protected]
🦟 Bug fix
Summary
Scene3D appear to be slow when there are high poly count meshes in the scene. This turns out that it's not a rendering issue. The problem is that we are making ray queries every frame through the
ScreenToScenecall in theBroadcastHoverPosfunction. I believe this is intended mainly for spawning entities. ThehoverDirtyvariable is never set tofalseeven when the mouse is outside the 3D window. It's only set tofalsein spawn entity mode. So it's incurring unnecessary computation every frame.Note with this change, we will only broadcast the hover event on spawn entity mode. The gain here is a big improvement in frame rate.
To reproduce the issue:
launch ign-gazebo and drag and drop a high polycount model into the scene, e.g. Urban 2 Story model. Try moving the camera and notice that it's laggy.
Before this change, I get ~3-4 FPS, and after this change, I get 40-50 FPS
Checklist
codecheckpassed (See contributing)Note to maintainers: Remember to use Squash-Merge