window.h 10.6 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

Pierre Kraemer's avatar
Pierre Kraemer committed
8 9 10
class QVBoxLayout;
class QSplitter;

Pierre Kraemer's avatar
Pierre Kraemer committed
11 12 13 14 15 16
namespace CGoGN
{

namespace SCHNApps
{

Pierre Kraemer's avatar
Pierre Kraemer committed
17 18 19 20
class CamerasDialog;
class PluginsDialog;
class MapsDialog;

Pierre Kraemer's avatar
Pierre Kraemer committed
21
struct Texture;
22 23 24 25 26 27 28

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

public:
	/**
29
	 * \fn Window(QWidget* parent = NULL)
30 31 32 33
	 * \brief Default (and unique) constructor
	 *
	 * \param parent the parent of the window
	 */
34
	Window(const QString& appPath, QWidget* parent = NULL);
35

36 37 38 39 40 41
	/**
	 * \fn ~Window()
	 * \brief the class destructor
	 */
	~Window();

42 43
	const QString& getAppPath() { return m_appPath; }

Pierre Kraemer's avatar
Pierre Kraemer committed
44 45 46
	/*********************************************************
	 * MANAGE DOCK
	 *********************************************************/
47 48 49 50 51 52 53

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

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
57
	 * \fn void addTabInDock(QWidget* tabWidget, const QString& tabText)
58 59
	 * \brief Adds the widget as a new tab in the interface's dock
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
60
	 * \param tabWidget the created and allocated pointer to the QWidget to add in the dock
61 62 63 64
	 * \param tabText The text that will appears in the tab label
	 *
	 * \see removeTabInDock()
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
65
	void addTabInDock(QWidget* tabWidget, const QString& tabText);
66 67 68 69 70 71 72 73 74 75 76

	/**
	 * \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
77 78
	void removeTabInDock(QWidget* tabWidget);

79 80 81
	void enablePluginTabWidgets(Plugin* plugin);
	void disablePluginTabWidgets(Plugin* plugin);

Pierre Kraemer's avatar
Pierre Kraemer committed
82 83 84
	/*********************************************************
	 * MANAGE MENU ACTIONS
	 *********************************************************/
85 86

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
87
	 * \fn bool addMenuAction(const QString& menuPath, QAction* action)
88 89 90
	 * \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
91
	 * \param action a pointer to the allocated action to add in the menu. All the details on that action (such as
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
	 *          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
108
	 *  This method is called by Plugin methods
109 110 111 112
	 *
	 *  \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
113
	 *    depending on the error. This error can be shown with Error::showError
114 115
	 *
	 * \see deleteMenuAction()
Pierre Kraemer's avatar
Pierre Kraemer committed
116
	 * \see Plugin::addMenuAction()
117
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
118
	bool addMenuAction(const QString& menuPath, QAction* action);
119 120

	/**
Pierre Kraemer's avatar
Pierre Kraemer committed
121
	 * \fn void deleteMenuAction(QAction* action)
122 123
	 * \brief delete an action from the menu bar
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
124
	 * \param action pointer to the allocated action to delete.
125 126 127 128 129
	 *
	 *  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
130
	 *  This method is called by Plugin methods
131 132
	 *
	 *  \see addMenuAction()
Pierre Kraemer's avatar
Pierre Kraemer committed
133
	 *  \see Plugin::removeMenuAction()
134
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
135 136 137 138 139 140 141
	void removeMenuAction(QAction* action);

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

	bool addToolbarAction(QAction* action);
142

Pierre Kraemer's avatar
Pierre Kraemer committed
143 144
	void removeToolbarAction(QAction* action);

145 146 147 148 149 150 151
	/*********************************************************
	 * MANAGE CAMERAS
	 *********************************************************/

	Camera* addCamera(const QString& name);
	Camera* addCamera();
	void removeCamera(const QString& name);
152 153 154
	Camera* getCamera(const QString& name) const;
	QList<Camera*> getCamerasList() const { return h_cameras.values(); }
	const CameraHash& getCamerasHash() const { return h_cameras; }
155 156 157 158 159 160 161 162

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

	View* addView(const QString& name);
	View* addView();
	void removeView(const QString& name);
163 164 165 166 167 168 169
	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);

Pierre Kraemer's avatar
Pierre Kraemer committed
170
	void splitView(const QString& name, Qt::Orientation orientation);
171

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

	/**
	 * \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
183
	 * where the extension ('.so', '.dylib') and the prefix 'lib' were removed.
184 185 186 187 188 189
	 *
	 *  <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
190 191
	 * 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.
192
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
193
	 * \warning In the program this method is called under specific and controlled circumstances, you should probably not call it.
194
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
195
	 * \return a boolean whether the loading succeeded or not.
196 197
	 *
	 * If the function failed, the error code ( Error::code ) is affected with a value
Pierre Kraemer's avatar
Pierre Kraemer committed
198
	 * depending on the error. This error can be shown with Error::showError
199 200
	 *
	 * \see unloadPlugin()
Pierre Kraemer's avatar
Pierre Kraemer committed
201 202 203
	 * \see getPlugins()
	 * \see Plugin::enable()
	 */
204
	Plugin* loadPlugin(const QString& pluginFilePath);
205 206 207 208 209 210 211

	/**
	 * \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
212
	 * The Plugin of the given name is dereferenced and deleted, if it exists and was previously
213 214
	 * referenced, if not, the method does nothing.
	 *
Pierre Kraemer's avatar
Pierre Kraemer committed
215 216
	 * 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.
217 218 219 220
	 *
	 * \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
221
	 * \see getPlugins()
222 223
	 * \see Plugin::disable()
	 */
Pierre Kraemer's avatar
Pierre Kraemer committed
224
	void unloadPlugin(const QString& pluginName);
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

	/**
	 * \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
244 245 246
	 */
//	Plugin *checkPluginDependencie(QString name, Plugin *dependantPlugin);

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

251 252 253
	/*********************************************************
	 * MANAGE MAPS
	 *********************************************************/
Pierre Kraemer's avatar
Pierre Kraemer committed
254

255
	bool addMap(MapHandlerGen* map);
256
	void removeMap(const QString& name);
257 258 259
	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
260

261 262 263 264 265 266
	/*********************************************************
	 * MANAGE TEXTURES
	 *********************************************************/

	Texture* getTexture(const QString& image);
	void releaseTexture(const QString& image);
267 268

protected:
269 270
	QString m_appPath;

Pierre Kraemer's avatar
Pierre Kraemer committed
271
	bool m_initialization;
272

Pierre Kraemer's avatar
Pierre Kraemer committed
273 274 275
	QVBoxLayout* m_centralLayout;
	QSplitter* m_rootSplitter;
	bool b_rootSplitterInitialized;
276

277
	View* m_firstView;
278
	View* m_currentView;
279

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

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

288 289
	TextureHash h_textures;

Pierre Kraemer's avatar
Pierre Kraemer committed
290 291 292
	CamerasDialog* m_camerasDialog;
	PluginsDialog* m_pluginsDialog;
	MapsDialog* m_mapsDialog;
293 294

public slots:
295 296 297 298 299 300
	/**
	 * \fn void cb_about_SCHNApps();
	 * \brief function that is called when the "about SCHNApps" menu action is triggered
	 */
	void cb_aboutSCHNApps();

301 302 303 304
	/**
	 * \fn void cb_about_CGoGN();
	 * \brief function that is called when the "about CGOGN" menu action is triggered
	 */
305
	void cb_aboutCGoGN();
306 307
	
	void cb_showHideDock();
308

309
	/**
310 311 312
	 * \fn void cb_manageCameras()
	 * \brief method called when the "Cameras" action is triggered.
	 * Show the cameras management dialog:
313
	 */
314
	void cb_manageCameras();
315

316
	/**
317 318 319
	 * \fn void cb_managePlugins()
	 * \brief method called when the "Plugins" action is triggered.
	 * Show the plugins management dialog
320
	 */
321 322
	void cb_managePlugins();

323 324
	void cb_manageMaps();

325 326 327 328 329 330 331
signals:
	void cameraAdded(Camera* camera);
	void cameraRemoved(Camera* camera);

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

332 333
	void mapAdded(MapHandlerGen* map);
	void mapRemoved(MapHandlerGen* map);
334 335 336

	void pluginAdded(Plugin* plugin);
	void pluginRemoved(Plugin* plugin);
337 338
};

Pierre Kraemer's avatar
Pierre Kraemer committed
339 340 341 342
} // namespace SCHNApps

} // namespace CGoGN

343
#endif