-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from teamspatzenhirn/doxygen
Add package documentation using doxygen
- Loading branch information
Showing
7 changed files
with
2,714 additions
and
1 deletion.
There are no files selected for viewing
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
Large diffs are not rendered by default.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# rviz_2d_overlay_plugins | ||
|
||
Plugin for displaying 2D overlays over the RViz2 3D scene. | ||
|
||
Based on the [jsk_visualization](https://github.com/jsk-ros-pkg/jsk_visualization) | ||
package, which is currently only released for ROS1, under the 3-Clause BSD license. | ||
|
||
## Text Overlay | ||
|
||
![Screenshot showing the robot velocity as an overlay above the RViz 3D Scene, as well as the expanded properties of the plugin](doc/screenshot_vel_overlay.png) | ||
|
||
Both the text itself and formatting options for the text overlay are specified in | ||
the [OverlayText.msg message type](https://github.com/teamspatzenhirn/rviz_2d_overlay_plugins/blob/main/rviz_2d_overlay_msgs/msg/OverlayText.msg) | ||
. | ||
|
||
### Alignment and Positioning | ||
|
||
To allow easy positioning of the overlay along the edges of the rviz window, and to support multiple/dynamic window | ||
sizes, the position is given by offsets from the respective border. | ||
Depending on whether the `horizontal_alignment` is `LEFT`, `RIGHT` or `CENTER`, | ||
the `horizontal_distance` field sets the distance to the left or right border, or the offset from center. | ||
|
||
For `LEFT` and `RIGHT` alignment, a distance of zero means that the text is aligned to the border without any gap, | ||
a positive distance moves the overlay towards the center. | ||
|
||
For `CENTER` alignment, a distance of zero means completely centered, positive values move the overlay towards the | ||
bottom right of the window. | ||
|
||
`TOP` and `BOTTOM` for the vertical alignment work just like `LEFT` and `RIGHT` in the horizontal case. | ||
|
||
## Circular Gauge Overlay | ||
|
||
![Screenshot showing the PieChartDisplay, a circular gauge](doc/screenshot_PieChartDisplay.png) | ||
|
||
The `PieChartDisplay` is a rather boring pie chart, as it only displays a single value. | ||
`PieChartDisplay` and "Circular Gauge" are used synonymously in this package. | ||
The gauge allows displaying a | ||
[std_msgs/Float32](https://github.com/ros2/common_interfaces/blob/rolling/std_msgs/msg/Float32.msg). | ||
Formatting and positioning, as well as setting the maximum value is only possible in the display options inside rviz. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,5 +23,6 @@ | |
|
||
<export> | ||
<build_type>ament_cmake</build_type> | ||
<rosdoc2>rosdoc2.yaml</rosdoc2> | ||
</export> | ||
</package> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
type: 'rosdoc2 config' | ||
version: 1 | ||
--- | ||
settings: | ||
output_dir: "" | ||
builders: | ||
- doxygen: { | ||
name: doxygen, | ||
output_dir: 'generated/doxygen' | ||
} |