Public Member Functions | Public Attributes
airbus_plugin_rviz.plugin.PluginRviz Class Reference

The MyViz class is the main container widget. More...

Inheritance diagram for airbus_plugin_rviz.plugin.PluginRviz:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
 MyViz Constructor ^^^^^^^^^^^^^^^^^.
def onControlModeChanged
def onCreate
def onDestroy
def onEmergencyStop
def onPause
def onResume
def onTranslate
def onUserChanged

Public Attributes

 frame
 rviz.VisualizationFrame is the main container widget of the regular RViz application, with menus, a toolbar, a status bar, and many docked subpanels.
 grid_display
 Since the config file is part of the source code for this example, we know that the first display in the list is the grid we want to control.
 manager
 The "splash path" is the full path of an image file which gets shown during loading.

Detailed Description

The MyViz class is the main container widget.

Definition at line 32 of file plugin.py.


Constructor & Destructor Documentation

def airbus_plugin_rviz.plugin.PluginRviz.__init__ (   self,
  context 
)

MyViz Constructor ^^^^^^^^^^^^^^^^^.

Its constructor creates and configures all the component widgets: frame, thickness_slider, top_button, and side_button, and adds them to layouts.

Definition at line 40 of file plugin.py.


Member Function Documentation

Definition at line 116 of file plugin.py.

def airbus_plugin_rviz.plugin.PluginRviz.onCreate (   self,
  param 
)

Definition at line 45 of file plugin.py.

Definition at line 132 of file plugin.py.

Definition at line 129 of file plugin.py.

Definition at line 110 of file plugin.py.

Definition at line 113 of file plugin.py.

Definition at line 126 of file plugin.py.

def airbus_plugin_rviz.plugin.PluginRviz.onUserChanged (   self,
  user_info 
)

Definition at line 123 of file plugin.py.


Member Data Documentation

rviz.VisualizationFrame is the main container widget of the regular RViz application, with menus, a toolbar, a status bar, and many docked subpanels.

In this example, we disable everything so that the only thing visible is the 3D render window.

Definition at line 40 of file plugin.py.

Since the config file is part of the source code for this example, we know that the first display in the list is the grid we want to control.

Here we just save a reference to it for later.

Definition at line 76 of file plugin.py.

The "splash path" is the full path of an image file which gets shown during loading.

Setting it to the empty string suppresses that behavior. VisualizationFrame.initialize() must be called before VisualizationFrame.load(). In fact it must be called before most interactions with RViz classes because it instantiates and initializes the VisualizationManager, which is the central class of RViz. The reader reads config file data into the config object. VisualizationFrame reads its data from the config object. You can also store any other application data you like in the config object. Here we read the window title from the map key called "Title", which has been added by hand to the config file. Here we disable the menu bar (from the top), status bar (from the bottom), and the "hide-docks" buttons, which are the tall skinny buttons on the left and right sides of the main render window. frame.getManager() returns the VisualizationManager instance, which is a very central class. It has pointers to other manager objects and is generally required to make any changes in an rviz instance.

Definition at line 72 of file plugin.py.


The documentation for this class was generated from the following file:


airbus_plugin_rviz
Author(s): Matignon Martin
autogenerated on Thu Jun 6 2019 17:59:27