window.h 10.9 KB
Newer Older
1 2 3 4 5
#ifndef _WINDOW_H_
#define _WINDOW_H_

#include "ui_window.h"

Pierre Kraemer's avatar
Pierre Kraemer committed
6
#include "system.h"
7
#include <QVBoxLayout>
8

9
class SplitArea;
Pierre Kraemer's avatar
Pierre Kraemer committed
10 11
class PluginDialog;
class CameraDialog;
12
class Texture;
13 14 15 16 17 18 19

class Window : public QMainWindow, Ui::Window
{
	Q_OBJECT

public:
	/**
20
	 * \fn Window(QWidget* parent = NULL)
21 22 23 24
	 * \brief Default (and unique) constructor
	 *
	 * \param parent the parent of the window
	 */
25 26
	Window(QWidget* parent = NULL);

27 28 29 30 31 32
	/**
	 * \fn ~Window()
	 * \brief the class destructor
	 */
	~Window();

33 34 35
	const QString& getAppPath() { return m_appPath; }
	void setAppPath(const QString& path) { m_appPath = path; }

Pierre Kraemer's avatar
Pierre Kraemer committed
36 37 38
	/*********************************************************
	 * MANAGE DOCK
	 *********************************************************/
39 40 41 42 43 44 45

	/**
	 * \fn QTabWidget* getDockTabWidget()
	 * \brief Accessor to the QTabWidget of this interface
	 *
	 * \return a pointer to the TabWidget, NULL if not allocated yet
	 */
46
	QTabWidget* getDockTabWidget() const { return m_dockTabWidget; }
47 48

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
49
	 * \fn void addTabInDock(QWidget* tabWidget, const QString& tabText)
50 51
	 * \brief Adds the widget as a new tab in the interface's dock
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
52
	 * \param tabWidget the created and allocated pointer to the QWidget to add in the dock
53 54 55 56
	 * \param tabText The text that will appears in the tab label
	 *
	 * \see removeTabInDock()
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
57
	void addTabInDock(QWidget* tabWidget, const QString& tabText);
58 59 60 61 62 63 64 65 66 67 68

	/**
	 * \fn void removeTabInDock(QWidget* tabWidget)
	 * \brief removes a given widget from the tab
	 *
	 * \param tabWidget the reference to the widget you want to remove
	 *
	 * If the widget does belong to the tab, it will be destroyed.
	 *
	 * \see addWidgetInDockTab()
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
69 70
	void removeTabInDock(QWidget* tabWidget);

71 72 73
	void enablePluginTabWidgets(Plugin* plugin);
	void disablePluginTabWidgets(Plugin* plugin);

Pierre Kraemer's avatar
Pierre Kraemer committed
74 75 76
	/*********************************************************
	 * MANAGE MENU ACTIONS
	 *********************************************************/
77 78

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
79
	 * \fn bool addMenuAction(const QString& menuPath, QAction* action)
80 81 82
	 * \brief adds an action in the program menu bar
	 *
	 * \param menuPath the menu path (see details below) to specify a location for the action in the menu.
Pierre Kraemer's avatar
Pierre Kraemer committed
83
	 * \param action a pointer to the allocated action to add in the menu. All the details on that action (such as
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
	 *          QObject::connect() calls) are not dealt in this function.
	 *
	 *  The menu path is a string used to specify the location of the new action in the menu bar.
	 *  In such path every menu step of the path should be separate by ';'. The action is the last substring after
	 *  the last ';', and will be added in the menu with that name. All non-existing menu specified in the path
	 *  shall be created.
	 *
	 *  <b>Example 1:</b> if you want to add an entry <em>"action"</em> to the existing menu <em>"Plugins"</em> the
	 *                  menu path shall be: <em>Plugins;action</em>
	 *
	 *  <b>Example 2:</b> if you want to add an entry <em>"action"</em> in a new menu <em>"config"</em> that is also a
	 *                  submenu of a new menu <em>"Settings"</em>, the menu path
	 *                  shall be: <em>Settings;config;action</em>
	 *
	 *  A new action should at least belong to one menu (already existing or not). Otherwise the method will fail.
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
100
	 *  This method is called by Plugin methods
101 102 103 104
	 *
	 *  \return a boolean whether the method succeeded or not.
	 *
	 * If the function failed, the error code ( Error::code ) is affected with a value
Pierre Kraemer's avatar
Pierre Kraemer committed
105
	 *    depending on the error. This error can be shown with Error::showError
106 107
	 *
	 * \see deleteMenuAction()
Pierre Kraemer's avatar
Pierre Kraemer committed
108
	 * \see Plugin::addMenuAction()
109
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
110
	bool addMenuAction(const QString& menuPath, QAction* action);
111 112

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
113
	 * \fn void deleteMenuAction(QAction* action)
114 115
	 * \brief delete an action from the menu bar
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
116
	 * \param action pointer to the allocated action to delete.
117 118 119 120 121
	 *
	 *  If this action was the only action remaining in a menu, this menu will also be deleted.
	 *
	 *  \warning DO NOT use this method with an action that hasn't been added with addMenuAction()
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
122
	 *  This method is called by Plugin methods
123 124
	 *
	 *  \see addMenuAction()
Pierre Kraemer's avatar
Pierre Kraemer committed
125
	 *  \see Plugin::removeMenuAction()
126
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
127 128 129 130 131 132 133
	void removeMenuAction(QAction* action);

	/*********************************************************
	 * MANAGE TOOLBAR ACTIONS
	 *********************************************************/

	bool addToolbarAction(QAction* action);
134

Pierre Kraemer's avatar
Pierre Kraemer committed
135 136
	void removeToolbarAction(QAction* action);

137 138 139 140 141 142 143
	/*********************************************************
	 * MANAGE CAMERAS
	 *********************************************************/

	Camera* addCamera(const QString& name);
	Camera* addCamera();
	void removeCamera(const QString& name);
144 145 146
	Camera* getCamera(const QString& name) const;
	QList<Camera*> getCamerasList() const { return h_cameras.values(); }
	const CameraHash& getCamerasHash() const { return h_cameras; }
147 148 149 150 151 152 153 154

	/*********************************************************
	 * MANAGE VIEWS
	 *********************************************************/

	View* addView(const QString& name);
	View* addView();
	void removeView(const QString& name);
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
	View* getView(const QString& name) const;
	QList<View*> getViewsList() const { return h_views.values(); }
	const ViewHash& getViewsHash() const { return h_views; }

	View* getCurrentView() const { return m_currentView; }
	void setCurrentView(View* view);

	/**
	 * \fn void moveView()
	 * \brief shows a reordering dialog for the Views
	 *
	 * Make a call with the right parameters to the dialog class
	 * GLVSelector and show this dialog.
	 *
	 * This method is meant to be called when the user press
	 * CTRL+Shift+M.
	 */
	void moveView();
173

Pierre Kraemer's avatar
Pierre Kraemer committed
174 175 176
	/*********************************************************
	 * MANAGE PLUGINS
	 *********************************************************/
177 178 179 180 181 182 183 184

	/**
	 * \fn bool loadPlugin(QString pluginPath)
	 * \brief Loads and references a Plugin
	 *
	 * \param pluginPath the absolute path of the Plugin location
	 *
	 * The Plugin is loaded and referenced under a name that is the Plugin file name
Pierre Kraemer's avatar
Pierre Kraemer committed
185
	 * where the extension ('.so', '.dylib') and the prefix 'lib' were removed.
186 187 188 189 190 191
	 *
	 *  <b>Example:</b> <em>/path/libExample.so</em> will be referenced as <em>Example</em>
	 *
	 * You have to make sure that a Plugin file with a similar name hasn't been loaded yet, otherwise
	 * the loading will fail.
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
192 193
	 * This method calls the Plugin::enable() method of the concerned Plugin. That is why
	 * when Plugin are written, this method is overriden and used as an initialization method.
194
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
195
	 * \warning In the program this method is called under specific and controlled circumstances, you should probably not call it.
196
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
197
	 * \return a boolean whether the loading succeeded or not.
198 199
	 *
	 * If the function failed, the error code ( Error::code ) is affected with a value
Pierre Kraemer's avatar
Pierre Kraemer committed
200
	 * depending on the error. This error can be shown with Error::showError
201 202
	 *
	 * \see unloadPlugin()
Pierre Kraemer's avatar
Pierre Kraemer committed
203 204 205
	 * \see getPlugins()
	 * \see Plugin::enable()
	 */
206
	Plugin* loadPlugin(const QString& pluginFilePath);
207 208 209 210 211 212 213

	/**
	 * \fn void unloadPlugin(QString pluginName)
	 * \brief Unload the Plugin of a given name
	 *
	 * \param pluginName the name under which the Plugin is referenced
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
214
	 * The Plugin of the given name is dereferenced and deleted, if it exists and was previously
215 216
	 * referenced, if not, the method does nothing.
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
217 218
	 * This method calls the Plugin::disable() method of the concerned Plugin. That is why,
	 * when Plugin are written, this method is overriden and used as a destruction method.
219 220 221 222
	 *
	 * \warning In the program this method is called under specific and controlled circumstances, you should probably not call it.
	 *
	 * \see loadPlugin()
Pierre Kraemer's avatar
Pierre Kraemer committed
223
	 * \see getPlugins()
224 225
	 * \see Plugin::disable()
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
226
	void unloadPlugin(const QString& pluginName);
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245

	/**
	 * \fn Plugin* checkPluginDependencie(QString name, Plugin* dependantPlugin)
	 * \brief checks for a dependencie Plugin, and set the dependencie link for the found Plugin
	 *
	 * \param name the name of the Plugin you have to check the existence in order to make a dependencie
	 * \param dependantPlugin a reference to the Plugin that asks for the dependencie that will be set as a
	 *          dependant Plugin for the found Plugin
	 *
	 * \warning In the program this method is called under specific and controlled circumstances
	 *          by the Plugins you should probably not call it.
	 *
	 * \return a pointer to the found dependencie Plugin, NULL if this Plugin wasn't referenced
	 *
	 * If the function failed, the error code ( Error::code ) is affected with a value
	     depending on the error. This error can be shown with Error::showError
	 *
	 * \see loadPlugin()
	 * \see VisualPlugin::addDependencie()
Pierre Kraemer's avatar
Pierre Kraemer committed
246 247 248
	 */
//	Plugin *checkPluginDependencie(QString name, Plugin *dependantPlugin);

249 250 251
	Plugin* getPlugin(const QString& name) const;
	QList<Plugin*> getPluginsList() const { return h_plugins.values(); }
	const PluginHash& getPluginsHash() const { return h_plugins; }
252

253 254 255
	/*********************************************************
	 * MANAGE MAPS
	 *********************************************************/
Pierre Kraemer's avatar
Pierre Kraemer committed
256

257
	bool addMap(MapHandlerGen* map);
258
	void removeMap(const QString& name);
259 260 261
	MapHandlerGen* getMap(const QString& name) const;
	QList<MapHandlerGen*> getMapsList() const { return h_maps.values(); }
	const MapHash& getMapsHash() const { return h_maps; }
Pierre Kraemer's avatar
Pierre Kraemer committed
262

263 264 265 266 267 268
	/*********************************************************
	 * MANAGE TEXTURES
	 *********************************************************/

	Texture* getTexture(const QString& image);
	void releaseTexture(const QString& image);
269 270

protected:
271 272
	QString m_appPath;

Pierre Kraemer's avatar
Pierre Kraemer committed
273
	bool m_initialization;
274

Pierre Kraemer's avatar
Pierre Kraemer committed
275 276
	QVBoxLayout* m_verticalLayout;
	SplitArea* m_splitArea;
277

278
	View* m_firstView;
279
	View* m_currentView;
280

Pierre Kraemer's avatar
Pierre Kraemer committed
281 282
	QDockWidget* m_dock;
	QTabWidget* m_dockTabWidget;
283

Pierre Kraemer's avatar
Pierre Kraemer committed
284
	PluginHash h_plugins;
285
	ViewHash h_views;
Pierre Kraemer's avatar
Pierre Kraemer committed
286
	CameraHash h_cameras;
287
	MapHash h_maps;
288

289 290
	TextureHash h_textures;

Pierre Kraemer's avatar
Pierre Kraemer committed
291
	PluginDialog* m_pluginDialog;
Pierre Kraemer's avatar
Pierre Kraemer committed
292
	CameraDialog* m_cameraDialog;
Pierre Kraemer's avatar
Pierre Kraemer committed
293

294 295 296 297 298 299 300 301 302
	/**
	 * \var bool keys[3]
	 * \brief a static tab to store state of some keys (here: M, Shift and CTRL)
	 */
	bool keys[3];
	void keyPressEvent(QKeyEvent *event);
	void keyReleaseEvent(QKeyEvent *event);

public slots:
303 304 305 306 307 308
	/**
	 * \fn void cb_about_SCHNApps();
	 * \brief function that is called when the "about SCHNApps" menu action is triggered
	 */
	void cb_aboutSCHNApps();

309 310 311 312
	/**
	 * \fn void cb_about_CGoGN();
	 * \brief function that is called when the "about CGOGN" menu action is triggered
	 */
313 314
	void cb_aboutCGoGN();

315
	/**
316 317 318
	 * \fn void cb_manageCameras()
	 * \brief method called when the "Cameras" action is triggered.
	 * Show the cameras management dialog:
319
	 */
320
	void cb_manageCameras();
321

322
	/**
323 324 325
	 * \fn void cb_managePlugins()
	 * \brief method called when the "Plugins" action is triggered.
	 * Show the plugins management dialog
326
	 */
327 328
	void cb_managePlugins();

329 330
	void cb_manageMaps();

331 332 333 334 335 336 337
signals:
	void cameraAdded(Camera* camera);
	void cameraRemoved(Camera* camera);

	void viewAdded(View* view);
	void viewRemoved(View* view);

338 339
	void mapAdded(MapHandlerGen* map);
	void mapRemoved(MapHandlerGen* map);
340 341 342

	void pluginAdded(Plugin* plugin);
	void pluginRemoved(Plugin* plugin);
343 344 345
};

#endif