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.

Sign up for GitHub

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

Jump to bottom

Rviz Panel Tutorial #4869

Merged
merged 22 commits into from
Jan 13, 2025
Merged

Rviz Panel Tutorial #4869

merged 22 commits into from
Jan 13, 2025

Conversation

DLu
Copy link
Contributor

@DLu DLu commented Nov 15, 2024

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.

fujitatomoya
fujitatomoya reviewed Nov 17, 2024
View reviewed changes
Copy link
Collaborator

@fujitatomoya fujitatomoya left a 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
DLu and others added 2 commits November 18, 2024 16:28
@DLu @fujitatomoya
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
99703f8 
…om-Panel.rst

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: David V. Lu!! <davidvlu@gmail.com>
@DLu
Add link to code, images, edits
0a11ad5
kscottz
kscottz approved these changes Nov 19, 2024
View reviewed changes
Copy link
Collaborator

@kscottz kscottz left a 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
DLu and others added 11 commits November 21, 2024 15:59
@DLu
PR Feedack response for Kat
1234a9d
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
be64144 
…om-Panel.rst

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
fa8d2d3 
…om-Panel.rst

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
c68f06e 
…om-Panel.rst

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
3ebfde1 
…om-Panel.rst

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
3173b6f 
…om-Panel.rst

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
e26fd4a 
…om-Panel.rst

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
c18a452 
…om-Panel.rst

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
21fad13 
…om-Panel.rst

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
ef1ae71 
…om-Panel.rst

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
f78d5d3 
…om-Panel.rst

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Copy link
Collaborator

kscottz commented Nov 22, 2024 •
edited
Loading

@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. 🫡

@ros-discourse
Copy link

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

@kscottz
Merge branch 'rolling' into rviz_panel
affc0ab 
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Apply suggestions from code review
efd2b3b 
Fix lint complaints

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Apply suggestions from code review
a6d233f 
One more pass on trailing whitespace

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Cust…
97a3a35 
…om-Panel.rst

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Main.rst
ed25f68 
Now adding whitespace.

Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Main.rst
4b39fed 
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@kscottz
Update source/Tutorials/Intermediate/RViz/RViz-Main.rst
d5756dd 
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
@ahcorde ahcorde requested a review from fujitatomoya January 10, 2025 09:34
ahcorde
ahcorde requested changes Jan 10, 2025
View reviewed changes
Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

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

Just a minor comment about some duplicated content

source/Tutorials/Intermediate/RViz/RViz-Custom-Panel/RViz-Custom-Panel.rst Outdated Show resolved Hide resolved
@ahcorde ahcorde added the backport-all backport at reviewers discretion; from rolling to all versions label Jan 13, 2025
@ahcorde ahcorde merged commit 783b7f6 into ros2:rolling Jan 13, 2025
4 checks passed
mergify bot pushed a commit that referenced this pull request Jan 13, 2025
@DLu @mergify
Rviz Panel Tutorial (#4869)
992f0b1 
Signed-off-by: David V. Lu!! <davidvlu@gmail.com>
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
(cherry picked from commit 783b7f6)
@mergify mergify bot mentioned this pull request Jan 13, 2025
Merged
mergify bot pushed a commit that referenced this pull request Jan 13, 2025
@DLu @mergify
Rviz Panel Tutorial (#4869)
fe7300f 
Signed-off-by: David V. Lu!! <davidvlu@gmail.com>
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
(cherry picked from commit 783b7f6)
@mergify mergify bot mentioned this pull request Jan 13, 2025
Merged
ahcorde pushed a commit that referenced this pull request Jan 13, 2025
@mergify @DLu
Rviz Panel Tutorial (#4869) (#4930)
c1d0c11 
Signed-off-by: David V. Lu!! <davidvlu@gmail.com>
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
(cherry picked from commit 783b7f6)

Co-authored-by: David V. Lu!! <davidvlu@gmail.com>
ahcorde pushed a commit that referenced this pull request Jan 13, 2025
@mergify @DLu
Rviz Panel Tutorial (#4869) (#4931)
aceba1d 
Signed-off-by: David V. Lu!! <davidvlu@gmail.com>
Signed-off-by: Katherine Scott <katherineAScott@gmail.com>
Co-authored-by: Katherine Scott <katherineAScott@gmail.com>
(cherry picked from commit 783b7f6)

Co-authored-by: David V. Lu!! <davidvlu@gmail.com>
@DLu DLu deleted the rviz_panel branch January 14, 2025 04:15
This was referenced Jan 14, 2025
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kscottz kscottz kscottz approved these changes

@ahcorde ahcorde ahcorde approved these changes

@clalancette clalancette Awaiting requested review from clalancette clalancette is a code owner

@audrow audrow Awaiting requested review from audrow audrow is a code owner

@fujitatomoya fujitatomoya Awaiting requested review from fujitatomoya

Assignees
No one assigned
Labels
backport-all backport at reviewers discretion; from rolling to all versions
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@DLu @kscottz @ros-discourse @ahcorde @fujitatomoya