roviz  0.7
Code Documentation of roviz
Public Slots | Public Member Functions | Static Public Member Functions | List of all members
SharedWindow Class Reference

Provides a shared window that displays data from all items. More...

#include <shared_window.h>

Inheritance diagram for SharedWindow:
Inheritance graph
Collaboration diagram for SharedWindow:
Collaboration graph

Public Slots

void destroy (void)
 
void start (void)
 
void pause (void)
 
void stop (void)
 
void addTab (void)
 
void changeToTab (int index)
 
void tabClosed (int index)
 
void tabMoved (int to, int from)
 
void tabStartRename (int index)
 
void tabFinishRename (void)
 
void itemClosed (void)
 

Public Member Functions

void addItem (RovizItemBaseDev *item)
 Add an item to the shared window. More...
 
void removeItem (RovizItemBaseDev *item)
 Remove an item from the shared window. More...
 
void load (void)
 Loads the config (if not already done) and shows the window.
 
void closeEvent (QCloseEvent *event) override
 Called when the window is closed. More...
 

Static Public Member Functions

static SharedWindowinstance (SettingsScope *proj)
 Get the SharedWindow instance of a certain project. More...
 

Detailed Description

Provides a shared window that displays data from all items.

There is one SharedWindow per project, each one displaying the images of all items on the scene in one aggregated window. It also handles the start/pause/stop mechanism.

Member Function Documentation

◆ addItem()

void SharedWindow::addItem ( RovizItemBaseDev item)

Add an item to the shared window.

Parameters
itemThe item to add

All items are added to the shared window right from the beginning, because the shared window also has to handle the start/pause/stop events of the items that are not visible.

Here is the call graph for this function:

◆ closeEvent()

void SharedWindow::closeEvent ( QCloseEvent *  event)
override

Called when the window is closed.

Parameters
eventThe close event

See QWidget::closeEvent

◆ instance()

SharedWindow * SharedWindow::instance ( SettingsScope proj)
static

Get the SharedWindow instance of a certain project.

Parameters
projThe current project
Returns
The SharedWindow instance

Projects are identified through their SettingsScope.

Here is the caller graph for this function:

◆ removeItem()

void SharedWindow::removeItem ( RovizItemBaseDev item)

Remove an item from the shared window.

Parameters
itemThe item to remove
Here is the call graph for this function:
Here is the caller graph for this function:

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