Add RViz Marker DisplayTypes Tutorial #4821
Merged
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
ahcorde
requested changes
Oct 25, 2024
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Outdated
Show resolved
Hide resolved
ahcorde
approved these changes
Nov 11, 2024
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Outdated
Show resolved
Hide resolved
ahcorde
added
the
backport-all
|
@clalancette Do you mind to take a quick look ? |
kscottz
approved these changes
Nov 11, 2024
There was a problem hiding this comment.
@LeweC This is fantastic and we really appreciate your contribution! Thank you so much.
This is a fantastic start to a decent RViz marker tutorial. Obviously there is a lot more we could add here, but I think this is good enough to add in once the suggestions are merged.
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Outdated
Show resolved
Hide resolved
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Outdated
Show resolved
Hide resolved
|
|
||
| * ``frame_locked``: | ||
|
|
||
| Tells RViz to retransform the marker into the current location of the specified frame every update cycle. |
There was a problem hiding this comment.
Not your fault, but I wish this was a bit clearer. The docs are pretty sparse.
There was a problem hiding this comment.
I changed it a bit. Mainly added a sentence, I hope this makes it clearer.
source/Tutorials/Intermediate/RViz/Marker-Display-types/Marker-Display-types.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Katherine Scott <[email protected]> Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Lewe Christiansen <[email protected]>
ahcorde
requested changes
Nov 21, 2024
There was a problem hiding this comment.
Do you mind to check linters ? https://github.com/ros2/ros2_documentation/actions/runs/11952606475/job/33318689926?pr=4821
Yeah I was just in the procces of doing that. I am pretty sure my setup is/was correct, I think it came from one of the suggestions. Fixed now and I think I added all your guys feedback. |
ahcorde
approved these changes
Nov 21, 2024
mergify bot
pushed a commit
that referenced
this pull request
Nov 21, 2024
Signed-off-by: Lewe Christiansen <[email protected]> Co-authored-by: lewec <[email protected]> (cherry picked from commit 8c6ae4a)
mergify bot
pushed a commit
that referenced
this pull request
Nov 21, 2024
Signed-off-by: Lewe Christiansen <[email protected]> Co-authored-by: lewec <[email protected]> (cherry picked from commit 8c6ae4a)
This was referenced Nov 21, 2024
mergify bot
pushed a commit
that referenced
this pull request
Nov 21, 2024
Signed-off-by: Lewe Christiansen <[email protected]> Co-authored-by: lewec <[email protected]> (cherry picked from commit 8c6ae4a)
ahcorde
pushed a commit
that referenced
this pull request
Nov 21, 2024
Signed-off-by: Lewe Christiansen <[email protected]> Co-authored-by: lewec <[email protected]> (cherry picked from commit 8c6ae4a) Co-authored-by: Lewe Christiansen <[email protected]>
ahcorde
pushed a commit
that referenced
this pull request
Nov 21, 2024
Signed-off-by: Lewe Christiansen <[email protected]> Co-authored-by: lewec <[email protected]> (cherry picked from commit 8c6ae4a) Co-authored-by: Lewe Christiansen <[email protected]>
ahcorde
pushed a commit
that referenced
this pull request
Nov 21, 2024
Signed-off-by: Lewe Christiansen <[email protected]> Co-authored-by: lewec <[email protected]> (cherry picked from commit 8c6ae4a) Co-authored-by: Lewe Christiansen <[email protected]>
This was referenced Nov 26, 2024
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.
This PR is a continuation of the initial issue #3864, the discussion in the abandoned PR #3908 which led to the first completed PR #4040 of the porting of old RViz tutorial series.
This is the next tutorial about RViz and especially RViz Marker Types, which is the basis for the following tutorial series I want to port in later PRs as soon as this one is ready because I have some time now.
The link to the original Marker DisplayTypes Tutorial in ROS1 which served as a basis.
In the old RViz documentation page the DisplayTypes: Marker was grouped with the other DisplayTypes on a subpage. In contrast, I decided to keep it on the main RViz subpage for this version, as I do not intend to add new PRs for the other DisplayTypes in the near future. I want to finish the current tutorial series first. I do not think we need a subpage for the Marker DisplayTypes page until we have more than one other DisplayType Page, and I think this page still fits nicely into the main RViz page at the moment, but I am interested in your opinion.
I think this version is ready for your next review step (as it had one or two review steps in #3908)