MainWindow Class Reference

#include <MainWindow.hh>

Inherits QMainWindow.

Public Slots

void Pause ()
 Pause simulation. More...
 
void Play ()
 Play simulation. More...
 

Signals

void AddPlugins ()
 A signal to trigger loading of GUI plugins. More...
 
void Close ()
 A signal to indicate the main window is about to close. More...
 
void TrackVisual (const std::string &_visualName)
 A signal to track a visual. More...
 

Public Member Functions

 MainWindow ()
 Constructor. More...
 
virtual ~MainWindow ()
 Destructor. More...
 
void AddMenu (QMenu *_menu)
 Add a menu to the main window menu bar. More...
 
void AddToLeftColumn (const std::string &_name, QWidget *_widget)
 Add a widget to the left column stack of widgets. More...
 
QAction * CloneAction (QAction *_action, QObject *_parent)
 Create a new action with information from the given action, such as text and tooltip. More...
 
gui::EditorEditor (const std::string &_name) const
 Get an editor by name. More...
 
unsigned int EntityId (const std::string &_name)
 Get an entity id. More...
 
bool HasEntityName (const std::string &_name)
 Has an entity name. More...
 
void Init ()
 Initialization. More...
 
bool IsPaused () const
 Returns the state of the simulation, true if paused. More...
 
void Load ()
 Load the mainwindow. More...
 
gui::RenderWidgetRenderWidget () const
 Get a pointer to the render widget. More...
 
void SetLeftPaneVisibility (bool _on)
 Set whether the left pane is visible. More...
 
void ShowLeftColumnWidget (const std::string &_name="default")
 Show a widget in the left column. More...
 
void ShowMenuBar (QMenuBar *_bar=NULL)
 Show a custom menubar. More...
 

Protected Member Functions

void closeEvent (QCloseEvent *_event)
 

Constructor & Destructor Documentation

Constructor.

virtual ~MainWindow ( )
virtual

Destructor.

Member Function Documentation

void AddMenu ( QMenu *  _menu)

Add a menu to the main window menu bar.

Parameters
[in]_menuMenu to be added.
void AddPlugins ( )
signal

A signal to trigger loading of GUI plugins.

void AddToLeftColumn ( const std::string &  _name,
QWidget *  _widget 
)

Add a widget to the left column stack of widgets.

Parameters
[in]_nameName of the widget
[in]_widgetPointer to the widget to add.
QAction* CloneAction ( QAction *  _action,
QObject *  _parent 
)

Create a new action with information from the given action, such as text and tooltip.

The new action triggers the original action and follows its checked state. This is used for example to have the "same" action on the main window menu and the model editor menu, since an action can't be added to 2 different menus.

Parameters
[in]_actionAction to be cloned.
[in]_parentParent for the new action.
Returns
The new action.
void Close ( )
signal

A signal to indicate the main window is about to close.

void closeEvent ( QCloseEvent *  _event)
protected
gui::Editor* Editor ( const std::string &  _name) const

Get an editor by name.

Parameters
[in]_nameName of the editor.
Returns
Pointer to the editor.
unsigned int EntityId ( const std::string &  _name)

Get an entity id.

Parameters
[in]_nameThe name of the entity
Returns
The entity id
bool HasEntityName ( const std::string &  _name)

Has an entity name.

Parameters
[in]_nameThe entity name
Returns
True if the entity has a name
void Init ( )

Initialization.

bool IsPaused ( ) const

Returns the state of the simulation, true if paused.

Returns
True if paused, false otherwise.
void Load ( )

Load the mainwindow.

void Pause ( )
slot

Pause simulation.

void Play ( )
slot

Play simulation.

Get a pointer to the render widget.

Returns
A pointer to the render widget.
void SetLeftPaneVisibility ( bool  _on)

Set whether the left pane is visible.

Parameters
[in]_onTrue to show the left pane, false to hide.
void ShowLeftColumnWidget ( const std::string &  _name = "default")

Show a widget in the left column.

See also
AddToLeftColumn
Parameters
[in]_nameName of the widge to show. The widget must have been added using AddToLeftColumn. The string "default" will show the main tab.
void ShowMenuBar ( QMenuBar *  _bar = NULL)

Show a custom menubar.

If NULL is used, the default menubar is shown.

Parameters
[in]_barThe menubar to show. NULL will show the default menubar.
void TrackVisual ( const std::string &  _visualName)
signal

A signal to track a visual.

Parameters
[in]_visualNameName of the visual to attach the camera to.

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