MainWindow.h 12.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
/*=====================================================================

QGroundControl Open Source Ground Control Station

(c) 2009, 2010 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>

This file is part of the QGROUNDCONTROL project

    QGROUNDCONTROL is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    QGROUNDCONTROL is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.

======================================================================*/

/**
 * @file
 *   @brief Definition of class MainWindow
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
 *
 */

#ifndef _MAINWINDOW_H_
#define _MAINWINDOW_H_
dogmaphobic's avatar
dogmaphobic committed
33

34
#include <QMainWindow>
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
#include <QStatusBar>
#include <QStackedWidget>
#include <QSettings>
#include <qlist.h>

#include "ui_MainWindow.h"
#include "LinkManager.h"
#include "LinkInterface.h"
#include "UASInterface.h"
#include "UASManager.h"
#include "UASControlWidget.h"
#include "UASInfoWidget.h"
#include "WaypointList.h"
#include "CameraView.h"
#include "UASListWidget.h"
#include "MAVLinkSimulationLink.h"
#include "input/JoystickInput.h"
Don Gagne's avatar
Don Gagne committed
52
#if (defined QGC_MOUSE_ENABLED_WIN) | (defined QGC_MOUSE_ENABLED_LINUX)
53
#include "Mouse6dofInput.h"
Don Gagne's avatar
Don Gagne committed
54
#endif // QGC_MOUSE_ENABLED_WIN
55 56 57
#include "DebugConsole.h"
#include "ParameterInterface.h"
#include "HDDisplay.h"
Don Gagne's avatar
Don Gagne committed
58 59 60 61 62
#include "HSIDisplay.h"
#include "opmapcontrol.h"
#ifdef QGC_GOOGLE_EARTH_ENABLED
#include "QGCGoogleEarthView.h"
#endif
dogmaphobic's avatar
dogmaphobic committed
63
#include "MainToolBar.h"
Don Gagne's avatar
Don Gagne committed
64
#include "QGCToolBar.h"
65 66 67 68 69
#include "LogCompressor.h"

#include "QGCMAVLinkInspector.h"
#include "QGCMAVLinkLogPlayer.h"
#include "MAVLinkDecoder.h"
70
#include "QGCUASFileViewMulti.h"
Don Gagne's avatar
Don Gagne committed
71
#include "QGCFlightGearLink.h"
72
#include "QGCToolWidget.h"
73 74 75 76 77

class QGCMapTool;
class QGCMAVLinkMessageSender;
class QGCFirmwareUpdate;
class QSplashScreen;
78
class QGCStatusBar;
79 80
class Linecharts;
class QGCDataPlot2D;
81
class QGCUASFileViewMulti;
82 83 84 85 86 87 88

/**
 * @brief Main Application Window
 *
 **/
class MainWindow : public QMainWindow
{
dogmaphobic's avatar
dogmaphobic committed
89
    friend class MainToolBar;
90 91 92
    Q_OBJECT

public:
Don Gagne's avatar
Don Gagne committed
93 94 95
    /// @brief Returns the MainWindow singleton. Will not create the MainWindow if it has not already
    ///         been created.
    static MainWindow* instance(void);
96

97 98
    /// @brief Deletes the MainWindow singleton
    void deleteInstance(void);
99

Don Gagne's avatar
Don Gagne committed
100
    /// @brief Creates the MainWindow singleton. Should only be called once by QGCApplication.
101
    static MainWindow* _create(QSplashScreen* splashScreen);
102

Don Gagne's avatar
Don Gagne committed
103 104
    /// @brief Called to indicate that splash screen is no longer being displayed.
    void splashScreenFinished(void) { _splashScreen = NULL; }
105

106 107
    ~MainWindow();

108

109
    /** @brief Get auto link reconnect setting */
110
    bool autoReconnectEnabled() const
111
    {
dogmaphobic's avatar
dogmaphobic committed
112
        return _autoReconnect;
113 114 115
    }

    /** @brief Get low power mode setting */
116
    bool lowPowerModeEnabled() const
117
    {
dogmaphobic's avatar
dogmaphobic committed
118
        return _lowPowerMode;
119 120
    }

121
    void hideSplashScreen(void);
122

123 124 125 126 127
    /// @brief Saves the last used connection
    void saveLastUsedConnection(const QString connection);

    /// @brief Restore (and connects) the last used connection (if any)
    void restoreLastUsedConnection();
128
    
129
    /// @brief Gets a pointer to the Main Tool Bar
130
    MainToolBar* getMainToolBar(void) { return _mainToolBar; }
131

132 133 134
public slots:
    /** @brief Show the application settings */
    void showSettings();
135 136
    /** @brief Simulate a link */
    void simulateLink(bool simulate);
137 138 139 140 141 142 143 144 145 146 147 148 149
    /** @brief Set the currently controlled UAS */
    void setActiveUAS(UASInterface* uas);

    /** @brief Add a new UAS */
    void UASCreated(UASInterface* uas);
    /** Delete an UAS */
    void UASDeleted(UASInterface* uas);
    /** @brief Update system specs of a UAS */
    void UASSpecsChanged(int uas);
    void startVideoCapture();
    void stopVideoCapture();
    void saveScreen();

150
    void handleMisconfiguration(UASInterface* uas);
151
    /** @brief Load configuration views */
152
    void loadSetupView();
153 154
    /** @brief Load view for pilot */
    void loadPilotView();
155 156
    /** @brief Load view for simulation */
    void loadSimulationView();
157 158 159 160
    /** @brief Load view for engineer */
    void loadEngineerView();
    /** @brief Load view for operator */
    void loadOperatorView();
161 162
    /** @brief Load Terminal Console views */
    void loadTerminalView();
163 164 165 166
    /** @brief Load Google Earth View */
    void loadGoogleEarthView();
    /** @brief Load local 3D view */
    void loadLocal3DView();
167 168
    /** @brief Manage Links */
    void manageLinks();
169 170 171 172 173 174 175 176 177 178

    /** @brief Show the online help for users */
    void showHelp();
    /** @brief Show the authors / credits */
    void showCredits();
    /** @brief Show the project roadmap */
    void showRoadMap();

    /** @brief Automatically reconnect last link */
    void enableAutoReconnect(bool enabled);
179

180
    /** @brief Save power by reducing update rates */
dogmaphobic's avatar
dogmaphobic committed
181
    void enableLowPowerMode(bool enabled) { _lowPowerMode = enabled; }
182 183 184 185 186 187

    void closeEvent(QCloseEvent* event);

    /** @brief Update the window name */
    void configureWindowName();

188
    void commsWidgetDestroyed(QObject *obj);
189

190
protected slots:
191 192 193 194 195 196 197 198 199 200 201 202
    /**
     * @brief Unchecks the normalActionItem.
     * Used as a triggered() callback by the fullScreenAction to make sure only one of it or the
     * normalAction are checked at a time, as they're mutually exclusive.
     */
    void fullScreenActionItemCallback();
    /**
     * @brief Unchecks the fullScreenActionItem.
     * Used as a triggered() callback by the normalAction to make sure only one of it or the
     * fullScreenAction are checked at a time, as they're mutually exclusive.
     */
    void normalActionItemCallback();
203

204
signals:
205
    void initStatusChanged(const QString& message, int alignment, const QColor &color);
John Tapsell's avatar
John Tapsell committed
206 207
    /** Emitted when any value changes from any source */
    void valueChanged(const int uasId, const QString& name, const QString& unit, const QVariant& value, const quint64 msec);
208 209
    /** Emitted when any the Canvas elements within QML wudgets need updating */
    void repaintCanvas();
John Tapsell's avatar
John Tapsell committed
210

Don Gagne's avatar
Don Gagne committed
211
#ifdef QGC_MOUSE_ENABLED_LINUX
212 213
    /** @brief Forward X11Event to catch 3DMouse inputs */
    void x11EventOccured(XEvent *event);
Don Gagne's avatar
Don Gagne committed
214
#endif //QGC_MOUSE_ENABLED_LINUX
215 216 217 218 219 220 221 222 223 224 225

public:
    QGCMAVLinkLogPlayer* getLogPlayer()
    {
        return logPlayer;
    }

protected:

    typedef enum _VIEW_SECTIONS
    {
226 227
        VIEW_ENGINEER,         // Engineering/Analyze view mode. Used for analyzing data and modifying onboard parameters
        VIEW_MISSION,          // Mission/Map/Plan view mode. Used for setting mission waypoints and high-level system commands.
Bryant's avatar
Bryant committed
228 229
        VIEW_FLIGHT,           // Flight/Fly/Operate view mode. Used for 1st-person observation of the vehicle.
        VIEW_SIMULATION,       // HIL Simulation view. Useful overview of the entire system when doing hardware-in-the-loop simulations.
230 231 232
        VIEW_SETUP,            // Setup view. Used for initializing the system for operation. Includes UI for calibration, firmware updating/checking, and parameter modifcation.
        VIEW_TERMINAL,         // Terminal interface. Used for communicating with the remote system, usually in a special configuration input mode.
        VIEW_LOCAL3D,          // A local 3D view. Provides a local 3D view that makes visualizing 3D attitude/orientation/pose easy while in operation.
233
        VIEW_GOOGLEEARTH       // 3D Google Earth view. A 3D terrain view, though the vehicle is still 2D.
234 235 236 237 238 239 240 241 242 243 244 245 246
    } VIEW_SECTIONS;

    /** @brief Catch window resize events */
    void resizeEvent(QResizeEvent * event);

    void connectCommonActions();

    void loadSettings();
    void storeSettings();


    QSettings settings;

247
    // Center widgets
248
    QPointer<Linecharts> linechartWidget;
Don Gagne's avatar
Don Gagne committed
249 250 251 252
#ifdef QGC_OSG_ENABLED
    QPointer<QWidget> q3DWidget;
#endif
#ifdef QGC_GOOGLE_EARTH_ENABLED
253
    QPointer<QGCGoogleEarthView> earthWidget;
Don Gagne's avatar
Don Gagne committed
254 255
#endif
    QPointer<QGCFirmwareUpdate> firmwareUpdateWidget;
256

dogmaphobic's avatar
dogmaphobic committed
257
    QPointer<MainToolBar> _mainToolBar;
258 259 260 261 262 263 264
    QPointer<QGCToolBar> toolBar;

    QPointer<QDockWidget> mavlinkInspectorWidget;
    QPointer<MAVLinkDecoder> mavlinkDecoder;
    QPointer<QDockWidget> mavlinkSenderWidget;
    QGCMAVLinkLogPlayer* logPlayer;

265 266
    QPointer<QGCUASFileViewMulti> fileWidget;

267
    JoystickInput* joystick; ///< The joystick manager for QGC
268

Don Gagne's avatar
Don Gagne committed
269
#ifdef QGC_MOUSE_ENABLED_WIN
270
    /** @brief 3d Mouse support (WIN only) */
271 272
    Mouse3DInput* mouseInput;               ///< 3dConnexion 3dMouse SDK
    Mouse6dofInput* mouse;                  ///< Implementation for 3dMouse input
Don Gagne's avatar
Don Gagne committed
273
#endif // QGC_MOUSE_ENABLED_WIN
274

Don Gagne's avatar
Don Gagne committed
275
#ifdef QGC_MOUSE_ENABLED_LINUX
276 277 278
    /** @brief Reimplementation of X11Event to handle 3dMouse Events (magellan) */
    bool x11Event(XEvent *event);
    Mouse6dofInput* mouse;                  ///< Implementation for 3dMouse input
Don Gagne's avatar
Don Gagne committed
279
#endif // QGC_MOUSE_ENABLED_LINUX
280

281 282 283 284 285 286 287 288 289 290 291 292 293 294
    /** User interface actions **/
    QAction* connectUASAct;
    QAction* disconnectUASAct;
    QAction* startUASAct;
    QAction* returnUASAct;
    QAction* stopUASAct;
    QAction* killUASAct;
    QAction* simulateUASAct;


    LogCompressor* comp;
    QTimer* videoTimer;
    QGCFlightGearLink* fgLink;
    QTimer windowNameUpdateTimer;
295

Don Gagne's avatar
Don Gagne committed
296
private slots:
297 298 299
    void _showDockWidgetAction(bool show);
    void _loadCustomWidgetFromFile(void);
    void _createNewCustomWidget(void);
300 301 302 303
#ifdef UNITTEST_BUILD
    void _showQmlTestWidget(void);
#endif
    
304
private:
305
    /// Constructor is private since all creation should be through MainWindow::_create
306
    MainWindow(QSplashScreen* splashScreen);
307

Don Gagne's avatar
Don Gagne committed
308
    void _openUrl(const QString& url, const QString& errorMessage);
309

310 311 312 313 314 315 316 317 318
    // Center widgets
    QPointer<QWidget> _plannerView;
    QPointer<QWidget> _pilotView;
    QPointer<QWidget> _setupView;
    QPointer<QWidget> _engineeringView;
    QPointer<QWidget> _simView;
    QPointer<QWidget> _terminalView;
    QPointer<QWidget> _googleEarthView;
    QPointer<QWidget> _local3DView;
319

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
    // Dock widget names
    static const char* _uasControlDockWidgetName;
    static const char* _uasListDockWidgetName;
    static const char* _waypointsDockWidgetName;
    static const char* _mavlinkDockWidgetName;
    static const char* _parametersDockWidgetName;
    static const char* _filesDockWidgetName;
    static const char* _uasStatusDetailsDockWidgetName;
    static const char* _mapViewDockWidgetName;
    static const char* _hsiDockWidgetName;
    static const char* _hdd1DockWidgetName;
    static const char* _hdd2DockWidgetName;
    static const char* _pfdDockWidgetName;
    static const char* _hudDockWidgetName;
    static const char* _uasInfoViewDockWidgetName;
    static const char* _debugConsoleDockWidgetName;
336

337 338 339
    QMap<QString, QDockWidget*>     _mapName2DockWidget;
    QMap<int, QDockWidget*>         _mapUasId2HilDockWidget;
    QMap<QDockWidget*, QAction*>    _mapDockWidget2Action;
340

341 342 343 344 345 346 347 348
    void _buildPlannerView(void);
    void _buildPilotView(void);
    void _buildSetupView(void);
    void _buildEngineeringView(void);
    void _buildSimView(void);
    void _buildTerminalView(void);
    void _buildGoogleEarthView(void);
    void _buildLocal3DView(void);
349

350 351
    void _storeCurrentViewState(void);
    void _loadCurrentViewState(void);
352

353 354 355 356 357 358 359 360
    void _createDockWidget(const QString& title, const QString& name, Qt::DockWidgetArea area, QWidget* innerWidget);
    void _createInnerDockWidget(const QString& widgetName);
    void _buildCustomWidgets(void);
    void _buildCommonWidgets(void);
    void _hideAllHilDockWidgets(void);
    void _hideAllDockWidgets(void);
    void _showDockWidget(const QString &name, bool show);
    void _showHILConfigurationWidgets(void);
361

dogmaphobic's avatar
dogmaphobic committed
362 363 364 365 366 367 368 369 370 371 372 373
    bool                    _autoReconnect;
    bool                    _lowPowerMode;           ///< If enabled, QGC reduces the update rates of all widgets
    QActionGroup*           _centerStackActionGroup;
    MAVLinkSimulationLink*  _simulationLink;
    QList<QGCToolWidget*>   _customWidgets;
    QVBoxLayout*            _centralLayout;
    QList<QObject*>         _commsWidgetList;
    QWidget*                _currentViewWidget;     ///< Currently displayed view widget
    QSplashScreen*          _splashScreen;          ///< Splash screen, NULL is splash screen not currently being shown
    VIEW_SECTIONS           _currentView;           ///< Currently displayed view
    Ui::MainWindow          _ui;
    QString                 _screenFileName;
374

dogmaphobic's avatar
dogmaphobic committed
375 376
    QString _getWindowStateKey();
    QString _getWindowGeometryKey();
377

378 379 380 381

};

#endif /* _MAINWINDOW_H_ */