Rviz Panel Tutorial #4869
Open
Rviz Panel Tutorial #4869
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
There was a problem hiding this comment.
@DLu thanks for this PR.
just a quick question though. rviz does not have those examples or samples that user can refer to? i was thinking that if there are, we could link those information here instead of having the whole implementation in ros2 documentation here.
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
…om-Panel.rst Co-authored-by: Tomoya Fujita <[email protected]> Signed-off-by: David V. Lu!! <[email protected]>
kscottz
approved these changes
Nov 19, 2024
There was a problem hiding this comment.
@DLu thanks for this! Much appreciated!
I added a bunch of suggestions that I think will help clarify things. I generally like to see us follow the pattern of:
- Tell the user what they are going to do.
- Show them the code with lots of in-line comments.
- Recap what we just did.
I added suggestions in that direction.
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Show resolved
Hide resolved
…om-Panel.rst Signed-off-by: Katherine Scott <[email protected]>
…om-Panel.rst Signed-off-by: Katherine Scott <[email protected]>
…om-Panel.rst Signed-off-by: Katherine Scott <[email protected]>
…om-Panel.rst Signed-off-by: Katherine Scott <[email protected]>
…om-Panel.rst Signed-off-by: Katherine Scott <[email protected]>
…om-Panel.rst Signed-off-by: Katherine Scott <[email protected]>
…om-Panel.rst Signed-off-by: Katherine Scott <[email protected]>
…om-Panel.rst Signed-off-by: Katherine Scott <[email protected]>
…om-Panel.rst Signed-off-by: Katherine Scott <[email protected]>
…om-Panel.rst Signed-off-by: Katherine Scott <[email protected]>
|
@DLu went and merged and resolved all of my comments. If someone else signs off I am good to go on this. I'll do my part to make sure people know about this once it gets merged. Your help is appreciated. 🫡 |
|
This pull request has been mentioned on ROS Discourse. There might be relevant details there: https://discourse.ros.org/t/ros-news-for-the-week-of-november-18th-2024/40777/1 |
Signed-off-by: Katherine Scott <[email protected]>
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Show resolved
Hide resolved
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
Fix lint complaints Signed-off-by: Katherine Scott <[email protected]>
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
kscottz
reviewed
Nov 22, 2024
source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst
Outdated
Show resolved
Hide resolved
One more pass on trailing whitespace Signed-off-by: Katherine Scott <[email protected]>
…om-Panel.rst Signed-off-by: Katherine Scott <[email protected]>
kscottz
reviewed
Nov 23, 2024
Now adding whitespace. Signed-off-by: Katherine Scott <[email protected]>
kscottz
reviewed
Nov 25, 2024
Signed-off-by: Katherine Scott <[email protected]>
kscottz
reviewed
Nov 25, 2024
Signed-off-by: Katherine Scott <[email protected]>
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.
Following the smash success of #3384, I have made a very similar looking tutorial for making a RViz panel. Mostly because I wanted the boilerplate code to be written somewhere.