##

RenderWidget Class Reference

`#include <RenderWidget.hh>`

Inherits QWidget.

## Public Member Functions

| RenderWidget (QWidget *_parent=0)
virtual | ~RenderWidget ()
bool | AddPlugin (const std::string &_filename, sdf::ElementPtr _elem)
| Add a plugin to the render widget and call GUIPlugin::Load(). More...
void | AddPlugin (GUIPluginPtr _plugin, 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...
TimePanel * | GetTimePanel () const
| Get the time panel widget. More...
TopToolbar * | GetToolbar () 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()

RenderWidget | ( | QWidget * | _parent = `0` | ) |

explicit

## ~RenderWidget()

virtual ~RenderWidget | ( |  | ) |

virtual

## Member Function Documentation

## AddPlugin() [1/2]

bool AddPlugin | ( | const std::string & | _filename,
|  | sdf::ElementPtr | _elem
| ) |  |

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

Return values

  true | on success.
  false | if 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] | _filename | Filename to load the plugin from
  [in] | _elem | Plugin sdf parameters.

## AddPlugin() [2/2]

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

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

Parameters

  [in] | _plugin | Plugin pointer to add.
  [in] | _elem | Plugin sdf parameters.

## AddPlugins()

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] | _pluginFilenames | list of filenames with the plugins

## CreateScene()

void CreateScene | ( | const std::string & | _name | ) |

## DisplayOverlayMsg()

void DisplayOverlayMsg | ( | const std::string & | _msg,
|  | int | _duration = `-1`
| ) |  |

Display an overlay message.

Parameters

  [in] | _msg | Message to be displayed
  [in] | _duration | Duration in milliseconds

## GetOverlayMsg()

std::string GetOverlayMsg | ( |  | ) | const

Get the overlay message being displayed.

Returns
  Message displayed in the render window

## GetTimePanel()

TimePanel* GetTimePanel | ( |  | ) | const

Get the time panel widget.

Returns
  the time panel widget.

## GetToolbar()

TopToolbar* GetToolbar | ( |  | ) | const

Get the toolbar on top of the render widget.

Returns
  Toolbar

## Init()

void Init | ( |  | ) |

## InsertWidget()

void InsertWidget | ( | unsigned int | _index,
|  | QWidget * | _widget
| ) |  |

Add a widget inside the render widget.

Parameters

  [in] | _index | Index in the splitter to add the widget at.
  [in] | _widget | Widget to be added.

## RemoveScene()

void RemoveScene | ( | const std::string & | _name | ) |

## SetOverlaysVisible()

void SetOverlaysVisible | ( | const bool | _visible | ) |

Show or hide all the GUI overlays.

Parameters

  [in] | _visible | True to show the GUI overlays, false to hide them.

## ShowTimePanel()

void ShowTimePanel | ( | bool | _show | ) |

Show the time panel.

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

## ShowToolbar()

void ShowToolbar | ( | const bool | _show | ) |

Set the visibility of the toolbar.

Parameters

  [in] | _show | Whether or not to show the toolbar.

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

- RenderWidget.hh