Rviz2的自定义插件开发基础知识

最新推荐文章于 2024-05-30 13:24:17 发布
最新推荐文章于 2024-05-30 13:24:17 发布
阅读量2.1k 收藏 14
点赞数 7
文章标签： 机器人 自动驾驶 c++
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Zeus1125/article/details/131979533
版权

1. 简介

Rviz中有不同类型的插件，每个插件都必须具有相应的基本类型，才能被RViz识别

plugin typebase type
Displayrviz_common::Display
Panelrviz_common::Panel
Toolrviz_common::Tool
Frames transformation libraryrviz_common::transformation::FrameTransformer
View Controllerrviz_common::ViewController

1.1 display plugin (display插件)

为了编写一个display插件，需要从rviz_common::Display或rviz_common::RosTopicDisplay 派生。

其中在不订阅ros的情况下编写display时，从rviz_common::display派生。

当编写一个topic类型的display，从rviz_common::RosTopicDisplay派生。

1.2 panel plugin (panel插件)

要编写自定义面板，从rviz_common::panel派生。

1.3 tool plugin (tool插件)

  • 编写一个tool插件，从rviz_common::Tool派生

  • 快捷键可以通过shortcut_key_来设置

  • 通过将函数getPropertyContainer（）的返回值作为相关属性的父级传递，可以将属性添加到“工具属性”面板中（有关示例，请参见rviz_default_plugins::tools::MeasureTool）

  • 用于插件的自定义光标、图标等可通过rviz_common/load_resource获得

1.4 view controller plugin (视图控制器插件)

  • 为了编写一个独立于tf帧的自定义视图控制器，请从rviz_common::ViewController派生

  • 如果视图控制器应该能够跟踪场景中的tf帧，请从rviz_common::FramePositionTrackingViewController派生，它已经包含了跟踪目标帧的便利功能

  • 如果自定义视图控制器环绕焦点运行，那么从rviz_default_plugins:OrbitViewController派生

1.5 transformation library plugin (转换库插件)

  • 要编写转换器插件，必须实现rviz_common::transformation::FrameTransformer类（请参阅头文件中包含的API文档）

  • 如果您的插件还需要额外的功能，或者您想提供对库本身某些部分的直接访问，那么您也可以实现rviz_common::transformation::TransformerLibraryConnector的子类（例如，请参阅rviz_default_plugins::transformation::TFWrapper）

2. Rviz的API概述

2.1 rviz_rendering

rviz_rendering包应该包含所有涉及渲染的功能：

  • 要添加到场景图中的视觉效果和对象，如子文件夹对象中的箭头、形状或文本对象（其中许多对象是从文件夹ogre_helpers中移植的）

  • 渲染窗口，包括一些暴露其内部的函数（RenderWindowOgreAdapter）。如果可能的话，不要使用RenderWindowOgreAdapter，因为它将来可能会被弃用和删除

  • 便利功能去工作使用materials（material_manager.hpp）或其他与orge相关的功能（例如viewport_projection_filter.hpp中的光线跟踪）

  • 用于测试的便利类，允许设置一个工作的grge环境和场景图内省的助手

2.2 rviz_common

rviz_common包包含大量可用于插件开发的rviz：

  • 主应用程序和rendering队列（不暴露）

  • 插件开发的主要入口点-panels、view controllers、displays和tools的基类

  • 使用位于rviz_common/properties中的各种视图（如display panel）中的属性的便捷类

  • 可选类型的主要类SelectionHandlers（位于rviz_common/interaction中）

  • ROS 2的接入点。目前，RViz只使用一个节点，可以通过ros_integration访问。未来，可能需要进一步的改变，以将ROS 2访问完全抽象为ROS_integration

2.3 rviz_default_plugins

rviz_default_plugins包含rviz附带的所有插件（view controllers, tools, displays and in the future, panels) 其中大多数是从rviz的default_plugins文件夹移植的)。

  • 当开发简单的插件时，没有必要在这个包中使用任何东西。

  • 当开发类似于现有插件的更复杂的插件时，使用甚至从这个包中包含的类派生可能是有益的，以简化您的开发。

2.4 rviz_visual_testing_framework

rviz_visual_testing_framework包含编写插件可视化测试的主干。如果您想编写自动屏幕截图测试，那么只需要将此包用作测试依赖项。有关进一步的帮助，请参阅软件包中的文档。

3. Panel插件开发流程

3.1 创建一个工作空间

ros2 pkg create package_name --build-type ament_cmake --dependencies rclcpp

3.2 QT程序设计

  • 新建Qt Widgets Application

 

  • 一直下一步，Base class选择Qwidget

 

  • QT文件目录结构

双击.ui文件进行可视化界面设计

 

  • ui设计界面

左侧为常用界面控件，如布局、按钮等；

右侧设置不同控件的属性和值

为了适配不同的屏幕尺寸，在进行设计时需要给画布中的按钮、列表等设置最大或最小值；例如在按钮控件上右键，选择大小限定。

界面布局：通常将各类控件放入布局（Layout）中，可以适应不同屏幕比例变化，全画布的布局可以通过画布右键向选择

 

  • 信号和槽

发送者->做出事件动作->接收者->给出事件回应

private slots:
        void on_pushButton_clicked();
void Widget::on_pushButton_clicked()
{
    close();
    delete(this);//彻底关闭插件
}

3.3 ROS环境下的代码

rviz_plugin_demo.h

/*
 * @Author: sunqingshun sunqingshun@foton.com.cn
 * @Date: 2023-07-20 16:34:47
 * @LastEditors: sunqingshun sunqingshun@foton.com.cn
 * @LastEditTime: 2023-07-25 15:11:41
 * @FilePath: /rviz_plugin_demo/src/rviz_plugin_demo/include/rviz_plugin_demo/rviz_plugin_demo.h
 * @Description: 这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE       
 */
#ifndef WIDGET_H
#define WIDGET_H
​
#include<rclcpp/rclcpp.hpp>
#include<rviz_common/panel.hpp>
#include <QWidget>
​
// QT_BEGIN_NAMESPACE
namespace Ui { class Widget; }
// QT_END_NAMESPACE
​
namespace rviz_plugin_demo
{
class Widget : public rviz_common::Panel
    {
      Q_OBJECT
​
public:
        Widget(QWidget *parent = nullptr);
        ~Widget();
​
private slots:
        void on_pushButton_clicked();
​
private:
        Ui::Widget *ui;
};
} // namespace rvzi_plugin_demo
​
​
#endif // WIDGET_H
​

ui_rviz_plugin_demo.h

通过以下命令可以将QT的ui文件转换成.h代码文件，output.h：要输出的文件，input.ui：输入的ui文件

uic -o output.h input.ui
/********************************************************************************
** Form generated from reading UI file 'rviz_plugin_demo.ui'
**
** Created by: Qt User Interface Compiler version 5.12.8
**
** WARNING! All changes made in this file will be lost when recompiling UI file!
********************************************************************************/
​
#ifndef UI_RVIZ_PLUGIN_DEMO_H
#define UI_RVIZ_PLUGIN_DEMO_H
​
#include <QtCore/QVariant>
#include <QtWidgets/QApplication>
#include <QtWidgets/QGridLayout>
#include <QtWidgets/QPushButton>
#include <QtWidgets/QWidget>
​
QT_BEGIN_NAMESPACE
​
class Ui_Widget
{
public:
    QGridLayout *gridLayout;
    QPushButton *pushButton;
​
    void setupUi(QWidget *Widget)
    {
        if (Widget->objectName().isEmpty())
            Widget->setObjectName(QString::fromUtf8("Widget"));
        Widget->resize(161, 99);
        gridLayout = new QGridLayout(Widget);
        gridLayout->setObjectName(QString::fromUtf8("gridLayout"));
        pushButton = new QPushButton(Widget);
        pushButton->setObjectName(QString::fromUtf8("pushButton"));
        pushButton->setMinimumSize(QSize(100, 27));
        pushButton->setMaximumSize(QSize(100, 27));
​
        gridLayout->addWidget(pushButton, 0, 0, 1, 1);
​
​
        retranslateUi(Widget);
​
        QMetaObject::connectSlotsByName(Widget);
    } // setupUi
​
    void retranslateUi(QWidget *Widget)
    {
        Widget->setWindowTitle(QApplication::translate("Widget", "Widget", nullptr));
        pushButton->setText(QApplication::translate("Widget", "Hello!", nullptr));
    } // retranslateUi
​
};
​
namespace Ui {
    class Widget: public Ui_Widget {};
} // namespace Ui
​
QT_END_NAMESPACE
​
#endif // UI_RVIZ_PLUGIN_DEMO_H

rviz_plugin_demo.cpp

/*
 * @Author: sunqingshun sunqingshun@foton.com.cn
 * @Date: 2023-07-20 16:34:39
 * @LastEditors: sunqingshun sunqingshun@foton.com.cn
 * @LastEditTime: 2023-07-25 15:14:04
 * @FilePath: /rviz_plugin_demo/src/rviz_plugin_demo/src/rviz_plugin_demo.cpp
 * @Description: 这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE
 */
#include "rviz_plugin_demo/rviz_plugin_demo.h"
#include "rviz_plugin_demo/ui_rviz_plugin_demo.h"
​
​
namespace rviz_plugin_demo
{
Widget::Widget(QWidget *parent)
    : rviz_common::Panel(parent)
    , ui(new Ui::Widget)
{
    ui->setupUi(this);
}
​
Widget::~Widget()
{
    delete ui;
}
​
void Widget::on_pushButton_clicked()
{
    close();
    delete(this);
}
​
} // namespace rviz_plugin_demo
​
#include <pluginlib/class_list_macros.hpp>  // plugin宏声明
PLUGINLIB_EXPORT_CLASS(rviz_plugin_demo::Widget, rviz_common::Panel)
​

CMakeLists.txt

cmake_minimum_required(VERSION 3.5)
project(rviz_plugin_demo)
​
# Default to C99
if(NOT CMAKE_C_STANDARD)
  set(CMAKE_C_STANDARD 99)
endif()
​
# Default to C++14
if(NOT CMAKE_CXX_STANDARD)
  set(CMAKE_CXX_STANDARD 14)
endif()
​
if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
  add_compile_options(-Wall -Wextra -Wpedantic)
endif()
​
​
set(CMAKE_AUTOMOC ON)#cmake自动处理Moc文件
​
# find dependencies
find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(rviz_common REQUIRED)
find_package(pluginlib REQUIRED)
find_package(Qt5 COMPONENTS Widgets Core REQUIRED)
​
set (THIS_PACKAGE_INCLUDE_DEPENDS
  rclcpp   
  rviz_common 
  pluginlib
  Qt5
)
​
include_directories(
  include
)
​
#动态链接库
add_library( ${PROJECT_NAME} SHARED
  src/rviz_plugin_demo.cpp
  include/rviz_plugin_demo/rviz_plugin_demo.h
  include/rviz_plugin_demo/ui_rviz_plugin_demo.h
  ui/rviz_plugin_demo.ui
)
​
ament_target_dependencies(${PROJECT_NAME} ${THIS_PACKAGE_INCLUDE_DEPENDS})
​
target_include_directories(${PROJECT_NAME} PUBLIC
  ${Qt5Widgets_INCLUDE_DIRS}
)
​
target_link_libraries(
  ${PROJECT_NAME} Qt5::Widgets
)
​
​
#导出插件描述文件
pluginlib_export_plugin_description_file(rviz_common plugin_description.xml)
​
install(
  TARGETS ${PROJECT_NAME}
  EXPORT ${PROJECT_NAME}
  LIBRARY DESTINATION lib
  ARCHIVE DESTINATION lib
  RUNTIME DESTINATION bin
)
​
# 在ament中导出项目的头文件、库、目标和依赖项
ament_export_include_directories(include) # 将include目录中的头文件导出
ament_export_libraries(${PROJECT_NAME}) # 将项目名称指定的库导出
ament_export_targets(${PROJECT_NAME} ) # 将项目名称指定的目标导出
ament_export_dependencies(${THIS_PACKAGE_INCLUDE_DEPENDS}) # 将此包的依赖项导出
​
if(BUILD_TESTING)
  find_package(ament_lint_auto REQUIRED)
  # the following line skips the linter which checks for copyrights
  # uncomment the line when a copyright and license is not present in all source files
  #set(ament_cmake_copyright_FOUND TRUE)
  # the following line skips cpplint (only works in a git repo)
  # uncomment the line when this package is not in a git repo
  #set(ament_cmake_cpplint_FOUND TRUE)
  ament_lint_auto_find_test_dependencies()
endif()
​
ament_package()
​

package.xml

<?xml version="1.0"?>
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
  <name>rviz_plugin_demo</name>
  <version>0.0.0</version>
  <description>TODO: Package description</description>
  <maintainer email="sunqingshun@foton.com.cn">sun</maintainer>
  <license>TODO: License declaration</license>
​
  <buildtool_depend>ament_cmake</buildtool_depend>
​
  <depend>rclcpp</depend>
​
  <test_depend>ament_lint_auto</test_depend>
  <test_depend>ament_lint_common</test_depend>
  <depend>pluginlib</depend>
  <depend>rviz_common</depend>
​
  <exec_depend>libqt5-core</exec_depend>
  <exec_depend>libqt5-gui</exec_depend>
  <exec_depend>libqt5-widgets</exec_depend>
​
  <export>
    <build_type>ament_cmake</build_type>
  </export>
</package>
​

plugin_description.xml

<!-- 
    path：动态链接库路径 
    name：插件名称
    type：插件类
    base_class_type：基类
    description：功能描述
-->
<library path="rviz_plugin_demo"> 
    <class 
        name="rviz_plugin_demo/Demo"
        type="rviz_plugin_demo::Widget" 
        base_class_type="rviz_common::Panel">
        <description>
            A panel demo.
        </description>
    </class>
</library>

4.附录文件

rviz2的官方源码：https://github.com/ros2/rviz

ros2中cmake的配置说明：https://docs.ros.org/en/foxy/How-To-Guides/Ament-CMake-Documentation.html

 

 

淋雨的蜗牛
关注
  • 7
    点赞
  • 踩
  • 14
    收藏
    觉得还不错? 一键收藏
  • 6
    评论
【ROS】RViz、RViz2安装、使用详解
郭老二
06-14 5429
RViz安装（ROS1、ROS2）、使用、编程详解
ROS插件示例DEMO代码含注释
01-06
在本资源中，我们有一个关于ROS插件的DEMO代码示例，这将帮助开发者理解如何在ROS环境中创建和使用自定义插件。 首先，插件是ROS系统中一种增强已有节点功能的方式，它们可以动态加载到运行中的节点中，无需重新...
【ROS2】ROS2环境下用RVIZ2进行点云的可视化
qq_44225139的博客
03-02 4787
ROS2环境下用 RVIZ 实现点云的可视化
使用Qt+librviz+ros设计点云显示界面源码+使用教程.zip
04-30
使用Qt+librviz+ros设计点云显示界面.zip
机器人系统ros2-开发学习实践16-RViz 用户指南
小海聊智造
05-30 1490
视图面板还允许您创建不同的命名视图，这些视图会被保存并可在其中切换。视图由目标框架、相机类型和相机姿势组成。您可以通过单击视图面板的“保存”按钮来保存视图。
ros rviz 插件开发
feidaji的博客
11-29 4669
1. rviz 插件，tools 开发总结（画虚拟墙开发，虚拟路径开发）： 主要是参照了rviz 中measure_tool.cpp 中划线的方法，并把线转化成点云数据，然后发给costmap层。 ros的基础知识： ros c++ 下点的数据定义及使用： 头文件：#include &lt;geometry_msgs/Point32.h&gt; 定义一个点变量：geometry_msgs...
（四）添加rviz自定义插件
m0_67254672的博客
08-17 907
在工作空间src下创建存放消息的包，右击【src】，选择【添加新文件...】。选择【ROS】，选择【Package】，点击【Choose...】按钮。写入【Name:】名称，写入【Catkin:】依赖，消息依赖于 std_msgs和message_generation。点击【完成】按钮。找到创建的消息包【plugin_msg】文件夹，在此新建文件夹，名称为【msg】，目录结构如下：右击【msg】，选择【添加新文件...】。
ros2机器人rviz2详细介绍和使用说明？
weixin_35756637的博客
02-10 852
ROS2机器人Rviz2是一个可视化工具，用于显示机器人环境中的消息，提供3D视角来查看机器人的状态和活动。它可以帮助开发者更好地理解机器人当前的状态和活动，以及其他可视化消息。Rviz2提供了一系列的可视化工具，可以帮助开发者更好地理解机器人的状态和活动，比如可视化坐标系、激光扫描消息、点云消息、机器人模型等等。使用Rviz2，可以轻松地查看和调试机器人系统，从而更好地实现机器人目标。 ...
octomap_rviz_plugins:RViz显示插件，用于可视化ROS中的octomap消息
05-27
octomap_rviz_plugins RViz显示插件，用于可视化octomap消息（ROS groovy和更高版本）： ://ros.org/wiki/octomap_rviz_plugins
【ROS2机器人入门到实战】RVIZ2
生活不止眼前的苟且
08-21 1861
看完之后是不是还挺不明所以的，因为大多插件都是和坐标相关的，这个要大家学习了下一章节机器人学和URDF建模之后就非常的清晰了。
ROS rviz常用可视化插件
Moresweet 猫甜
09-12 4072
TF是ROS中的一个库，用于管理和查询不同坐标系之间的关系，尤其在机器人系统中常用。args中是配置文件路径，自己在rviz中设置的可视化组建的组合以及参数都会保存在这个文件中，启动后会加载，这样的效果是不必在每次启动rviz后都去重新添加需要的可视化组件。在RViz中，Map（地图）的参数通常是通过Map显示属性进行配置的，以显示静态地图或实时地图数据。此参数最为重要，可以选择接收的地图话题，一般/map为SLAM或者直接加载的静态地图，也可以选择代价地图，例如。用于设置可视化中点云数据点的颜色范围。
RVIZ2是一个怎样的神奇存在
生活不止眼前的苟且
10-07 2843
大家好，我是小鱼，今天是国庆的第六天，小鱼来上班了，大家今天也都开始学习了，还差最后两节，动手学ROS2的前六章文字版教程就要更新完毕了，不知不觉的跨度了三个月的时间。 今天一位曾今打赏小鱼的鱼粉脱单啦！大家也要抓紧脱单（打赏）~ 1.RVIZ2是什么 RVIZ2是ROS2中的一个非常重要且常用的数据可视化工具。 那数据指的是什么数据？可视化又是怎么可视化的？RVIZ2又是如何实现不同数据的可视化的呢？ 答案如下： 数据：各种调试机器人时常用的数据，比如：图像数据、三维点云数据、地图数据、TF数据，机
ros1基础学习的代码
最新发布
06-19
2. **安装和配置**：学习ROS1时，首先要了解如何设置开发环境，包括安装ROS1的发行版（如 Fuerte, Groovy, Hydro, Indigo, Jade 等），配置环境变量，以及使用`catkin`工具来构建和管理项目。 3. **消息（Message）...
《ROS机器人开发实践》示例代码（胡春旭）
04-11
ROS（Robot Operating System，机器人操作系统）是机器人领域广泛使用的开源框架，它为机器人软件开发提供了标准化的工具、库和通信机制。《ROS机器人开发实践》一书由胡春旭撰写，旨在帮助读者深入理解ROS并掌握其...
推荐一款高效导航工具：rviz_navi_multi_goals_pub_plugin
gitblog_00016的博客
04-21 360
推荐一款高效导航工具：rviz_navi_multi_goals_pub_plugin 项目地址:https://gitcode.com/autolaborcenter/rviz_navi_multi_goals_pub_plugin 项目简介 在机器人领域，rviz_navi_multi_goals_pub_plugin 是一个强大的ROS (Robot Operating System) 插件...
为RViz创建自定义的显示插件
weixin_45710350的博客
07-31 5403
ROS有很多场景都会使用RViz进行交互控制，比如navigation。RViz自身提供了很多显示类的信息，比如RobotModel，LaserScan，Odometry等等。如果用户还有其他信息也希望在RViz得到显示，则需要我们自定义该信息及其RViz的一个插件导入到RViz中。本文以机器人的电池电量信息插件作为示例，简要说明如何为RViz创建一个自定义的显示插件httpgithub下载，如果文中出现了描述错误以及不清晰的地方，欢迎指正，共同交流httpshttpshttpshttps。........
（一）对ROS中的RVIZ的简单理解
m0_67254672的博客
07-19 1903
rviz作为一种可扩展化的视图工具，可以使用插件机制来扩展丰富的功能，进行二次开发，我们在rviz中常常使用的激光数据可视化显示、图像数据可视化显示，其实都是官方提供的插件。但是很多时候，这些基础的插件无法满足我们的需求，这个时候rviz的plugin机制就派上用场了。rviz是基于OGRE图形渲染库和QT库实现的，QT库的信号和槽函数的机制提供了动作效果的实现，OGRE库负责了设计效果和渲染的实现。rviz是ROS官方提供的一款3D可视化工具，可以将机器人的相关数据进行图形化显示。四 、RVIZ的实现。
rviz2发布Panel面板插件可视化msg
weixin_43357110的博客
06-15 432
以上demo代码，根据自己需求，借助Qt，开发控制面板。然后在rviz2窗口，左上角选择Panels–>Add New Panel，在弹出的窗口中选择自己创建的panel面板插件即可。
rviz2中map插件详解
05-18
rviz2是ROS2中的一款可视化工具，用于显示和调试机器人系统中的数据和信息。其中，map插件用于显示机器人在地图上的位置和姿态。 在rviz2中使用map插件的步骤如下： 1.打开rviz2，选择一个配置文件或者创建一个新的配置文件。 2.在Displays面板中找到Map选项，点击加号添加map插件。 3.在Map选项中，设置Topic为机器人的定位信息话题，例如“/amcl_pose”。 4.设置Alpha值，控制地图的透明度，以便观察机器人的位置。 5.设置Color Scheme，选择地图的颜色方案，包括灰度、彩色等。 6.根据需要，设置其他选项，例如Resolution、Draw Behind、Queue Size等。 7.点击Save Configuration保存配置文件。 使用map插件可以方便地观察机器人在地图上的位置和姿态，对于机器人导航和定位的调试和优化非常有帮助。
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值