RenderWidget Class Reference

#include <RenderWidget.hh>

Inherits QWidget.

Public Member Functions

 RenderWidget (QWidget *_parent=0)
 
virtual ~RenderWidget ()
 
void AddPlugin (GUIPluginPtr _plugin, sdf::ElementPtr _elem)
 Add a plugin to the render widget and call GUIPlugin::Load(). More...
 
bool AddPlugin (const std::string &_filename, sdf::ElementPtr _elem)
 Add a plugin to the render widget and call GUIPlugin::Load(). More...
 
void AddPlugins (const std::vector< std::string > &_pluginFilenames)
 Add a list of plugins to be loaded from files. More...
 
void CreateScene (const std::string &_name)
 
void DisplayOverlayMsg (const std::string &_msg, int _duration=-1)
 Display an overlay message. More...
 
std::string GetOverlayMsg () const
 Get the overlay message being displayed. More...
 
TimePanelGetTimePanel () const
 Get the time panel widget. More...
 
TopToolbarGetToolbar () const
 Get the toolbar on top of the render widget. More...
 
void Init ()
 
void InsertWidget (unsigned int _index, QWidget *_widget)
 Add a widget inside the render widget. More...
 
void RemoveScene (const std::string &_name)
 
void SetOverlaysVisible (const bool _visible)
 Show or hide all the GUI overlays. More...
 
void ShowTimePanel (bool _show)
 Show the time panel. More...
 
void ShowToolbar (const bool _show)
 Set the visibility of the toolbar. More...
 

Constructor & Destructor Documentation

RenderWidget ( QWidget *  _parent = 0)
virtual ~RenderWidget ( )
virtual

Member Function Documentation

void AddPlugin ( GUIPluginPtr  _plugin,
sdf::ElementPtr  _elem 
)

Add a plugin to the render widget and call GUIPlugin::Load().

Parameters
[in]_pluginPlugin pointer to add.
[in]_elemPlugin sdf parameters.
bool AddPlugin ( const std::string &  _filename,
sdf::ElementPtr  _elem 
)

Add a plugin to the render widget and call GUIPlugin::Load().

Return values
trueon success.
falseif the plugin in the file is not of the right type, it needs to be a GUIPlugin. Also returns false if the plugin couldn't be created from this file.
Parameters
[in]_filenameFilename to load the plugin from
[in]_elemPlugin sdf parameters.
void AddPlugins ( const std::vector< std::string > &  _pluginFilenames)

Add a list of plugins to be loaded from files.

This will create a plugin from each file in the list and call AddPlugin(std::string, sdf::ElementPtr with an empty sdf::Element for each. Use AddPlugin(std::string&, sdf::ElementPtr) to load a GUI plugin with an initialized sdf element instead.

Parameters
[in]_pluginFilenameslist of filenames with the plugins
void CreateScene ( const std::string &  _name)
void DisplayOverlayMsg ( const std::string &  _msg,
int  _duration = -1 
)

Display an overlay message.

Parameters
[in]_msgMessage to be displayed
[in]_durationDuration in milliseconds
std::string GetOverlayMsg ( ) const

Get the overlay message being displayed.

Returns
Message displayed in the render window
TimePanel* GetTimePanel ( ) const

Get the time panel widget.

Returns
the time panel widget.
TopToolbar* GetToolbar ( ) const

Get the toolbar on top of the render widget.

Returns
Toolbar
void Init ( )
void InsertWidget ( unsigned int  _index,
QWidget *  _widget 
)

Add a widget inside the render widget.

Parameters
[in]_indexIndex in the splitter to add the widget at.
[in]_widgetWidget to be added.
void RemoveScene ( const std::string &  _name)
void SetOverlaysVisible ( const bool  _visible)

Show or hide all the GUI overlays.

Parameters
[in]_visibleTrue to show the GUI overlays, false to hide them.
void ShowTimePanel ( bool  _show)

Show the time panel.

[in] _show True to show the panel, false to hide it.

void ShowToolbar ( const bool  _show)

Set the visibility of the toolbar.

Parameters
[in]_showWhether or not to show the toolbar.

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