-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rviz Panel Tutorial #4869
base: rolling
Are you sure you want to change the base?
Rviz Panel Tutorial #4869
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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 <Tomoya.Fujita@sony.com> Signed-off-by: David V. Lu!! <davidvlu@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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 <katherineAScott@gmail.com>
…om-Panel.rst Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
…om-Panel.rst Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
…om-Panel.rst Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
…om-Panel.rst Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
…om-Panel.rst Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
…om-Panel.rst Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
…om-Panel.rst Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
…om-Panel.rst Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
…om-Panel.rst Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@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 <katherineAScott@gmail.com>
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
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
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
Fix lint complaints Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
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
One more pass on trailing whitespace Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
…om-Panel.rst Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
Now adding whitespace. Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
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.