rviz Documentation

A 3d visualization environment for robots using ROS.

rviz is a 3d visualization program for robots using ROS.

Warning:: This is a preliminary API doc posted only for review. It is not intended to describe any released version of rviz.

rviz can be extended by writing plugins. (See RViz Plugin Tutorials.)

librviz is a library for including rviz visualization capabilities in your own applications. (See Librviz Tutorial.)

Display Plugin Classes

The main classes relevant when writing display plugins are:

rviz::Display This is the superclass of things that can be added to the list of displays. Subclasses generally subscribe to ROS messages and show 3D things in the visualization window.

rviz::VisualizationManager This is the central manager class of RViz. Most things you write with RViz will access one of these.

rviz::FrameManager subscribes to TF messages to know where all the coordinate frames are. It has a (settable) "Fixed Frame" and functions for finding the pose of any other frame relative to it. This is the main class to use when you need to know where something is in space.

The rviz::Property subclasses like rviz::IntProperty, rviz::FloatProperty, rviz::StringProperty, rviz::RosTopicStringProperty, rviz::BoolProperty, etc. are created by rviz::Display subclasses to define user-editable properties which get saved to config files.

The ogre-helper classes are useful for making some common types of 3D objects show up in the render window: rviz::Arrow, rviz::Axes, rviz::BillboardLine, rviz::Grid, rviz::MovableText, and rviz::PointCloud.

The main classes relevant when writing panel plugins are:

rviz::Config represents a config file, which rviz::Panel subclasses need to use in order to save their custom data (since they don't use Property objects).

When writing an application using librviz, some additional important classes are:

rviz::VisualizationFrame is the main RViz window, including the menus, toolbar, dockable sub-windows, etc.

rviz::VisualizationPanel is a stripped-down RViz window (not used in the actual RViz executable) which has only the rviz::DisplaysPanel on the left and an rviz::RenderPanel on the right. This widget has no menu, no toolbar, and cannot have other widgets "dock" with it. This is a great widget to start with because hide the list of displays to see a "pure" 3D view in your application, but you can still show the display list and add or remove displays interactively if you need to. It also includes an rviz::VisualizationManager and a call to ros::init(), so there is less bookkeeping to do.

rviz::RenderPanel is the main 3D view widget. Using this directly in your code gives the most flexibility, at the cost of added complexity. If you use this, you will need to create an rviz::VisualizationManager yourself and also call ros::init(). The Librviz Tutorial demonstrates this.

RViz uses several external libraries which show up in its API. Here are some of the major ones:

ros::NodeHandle is one of the main ROS classes, used for subscribing and publishing on topics.

ros::init() function, used to initialize a ROS node. Only needed if you want to use an rviz::RenderPanel on its own.

tf::MessageFilter filters incoming ROS messages based on their coordinate frame header and the frame data currently available from TF.

Ogre::SceneManager, Ogre::SceneNode, Ogre::Vector3, Ogre::Quaternion, Ogre::ManualObject, Ogre::Entity, and Ogre::Material are just a few of the many classes from the Ogre3D graphics library which you may need when playing inside RViz.