MainWindow.h 15.3 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_
33
#include <QMainWindow>
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
#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"
50
#include "submainwindow.h"
51
#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 63
#include "HSIDisplay.h"
#include "opmapcontrol.h"
#ifdef QGC_GOOGLE_EARTH_ENABLED
#include "QGCGoogleEarthView.h"
#endif
#include "QGCToolBar.h"
64 65 66 67 68
#include "LogCompressor.h"

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

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

/**
 * @brief Main Application Window
 *
 **/
class MainWindow : public QMainWindow
{
    Q_OBJECT

public:
Don Gagne's avatar
Don Gagne committed
91 92 93 94
    /// @brief Returns the MainWindow singleton. Will not create the MainWindow if it has not already
    ///         been created.
    static MainWindow* instance(void);
    
95 96 97
    /// @brief Deletes the MainWindow singleton
    void deleteInstance(void);
    
Don Gagne's avatar
Don Gagne committed
98
    /// @brief Creates the MainWindow singleton. Should only be called once by QGCApplication.
99
    static MainWindow* _create(QSplashScreen* splashScreen);
Don Gagne's avatar
Don Gagne committed
100 101 102
    
    /// @brief Called to indicate that splash screen is no longer being displayed.
    void splashScreenFinished(void) { _splashScreen = NULL; }
103

104 105
    ~MainWindow();

106

107
    /** @brief Get auto link reconnect setting */
108
    bool autoReconnectEnabled() const
109 110 111 112
    {
        return autoReconnect;
    }

113
    /** @brief Get title bar mode setting */
114
    bool dockWidgetTitleBarsEnabled() const;
115

116
    /** @brief Get low power mode setting */
117
    bool lowPowerModeEnabled() const
118 119 120 121
    {
        return lowPowerMode;
    }

122
    QList<QAction*> listLinkMenuActions();
123 124
    
    void hideSplashScreen(void);
125 126 127 128 129

public slots:
    /** @brief Show the application settings */
    void showSettings();
    /** @brief Add a communication link */
130
    LinkInterface* addLink();
131
    bool configLink(LinkInterface *link);
132 133
    /** @brief Simulate a link */
    void simulateLink(bool simulate);
134 135 136 137 138 139 140 141 142 143 144 145 146
    /** @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();

147
    /** @brief Sets advanced mode, allowing for editing of tool widget locations */
148
    void setAdvancedMode(bool isAdvancedMode);
149
    void handleMisconfiguration(UASInterface* uas);
150
    /** @brief Load configuration views */
151
    void loadSetupView();
152 153
    /** @brief Load view for pilot */
    void loadPilotView();
154 155
    /** @brief Load view for simulation */
    void loadSimulationView();
156 157 158 159
    /** @brief Load view for engineer */
    void loadEngineerView();
    /** @brief Load view for operator */
    void loadOperatorView();
160 161
    /** @brief Load Terminal Console views */
    void loadTerminalView();
162 163 164 165
    /** @brief Load Google Earth View */
    void loadGoogleEarthView();
    /** @brief Load local 3D view */
    void loadLocal3DView();
166 167 168 169 170 171 172 173

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

174 175
    /** @breif Enable title bars on dock widgets when no in advanced mode */
    void enableDockWidgetTitleBars(bool enabled);
176 177
    /** @brief Automatically reconnect last link */
    void enableAutoReconnect(bool enabled);
178

179 180 181 182 183 184
    /** @brief Save power by reducing update rates */
    void enableLowPowerMode(bool enabled) { lowPowerMode = enabled; }

    /** @brief Add a custom tool widget */
    void createCustomWidget();

Don Gagne's avatar
Don Gagne committed
185
    /** @brief Load a custom tool widget from a file chosen by user (QGCFileDialog) */
186 187 188 189
    void loadCustomWidget();

    /** @brief Load a custom tool widget from a file */
    void loadCustomWidget(const QString& fileName, bool singleinstance=false);
190
    void loadCustomWidget(const QString& fileName, int view);
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

    /** @brief Load custom widgets from default file */
    void loadCustomWidgetsFromDefaults(const QString& systemType, const QString& autopilotType);

    /** @brief Loads and shows the HIL Configuration Widget for the given UAS*/
    void showHILConfigurationWidget(UASInterface *uas);

    void closeEvent(QCloseEvent* event);

    /**
     * @brief Shows a Widget from the center stack based on the action sender
     *
     * This slot is written to be used in conjunction with the addCentralWidget() function
     * It shows the Widget based on the action sender
     *
     */
    void showCentralWidget();

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

212
    void commsWidgetDestroyed(QObject *obj);
Don Gagne's avatar
Don Gagne committed
213
    
214
protected slots:
215
    void showDockWidget(const QString &name, bool show);
216 217 218 219 220 221 222 223 224 225 226 227
    /**
     * @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();
228

229
signals:
230
    void initStatusChanged(const QString& message, int alignment, const QColor &color);
John Tapsell's avatar
John Tapsell committed
231 232 233
    /** 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);

Don Gagne's avatar
Don Gagne committed
234
#ifdef QGC_MOUSE_ENABLED_LINUX
235 236
    /** @brief Forward X11Event to catch 3DMouse inputs */
    void x11EventOccured(XEvent *event);
Don Gagne's avatar
Don Gagne committed
237
#endif //QGC_MOUSE_ENABLED_LINUX
238 239 240 241 242 243 244 245 246 247 248

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

protected:

    typedef enum _VIEW_SECTIONS
    {
249 250
        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
251 252
        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.
253
        UNUSED1,               // Unused spacer for backwards compatibility with older settings files.
254
        VIEW_SETUP,            // Setup view. Used for initializing the system for operation. Includes UI for calibration, firmware updating/checking, and parameter modifcation.
255
        UNUSED2,               // Unused spacer for backwards compatibility with older settings files.
256 257
        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.
258
        VIEW_GOOGLEEARTH       // 3D Google Earth view. A 3D terrain view, though the vehicle is still 2D.
259 260 261 262 263 264 265 266 267 268 269 270 271
    } VIEW_SECTIONS;

    /**
     * @brief Adds an already instantiated QDockedWidget to the Tools Menu
     *
     * This function does all the hosekeeping to have a QDockedWidget added to the
     * tools menu and connects the QMenuAction to a slot that shows the widget and
     * checks/unchecks the tools menu item
     *
     * @param widget    The QDockWidget being added
     * @param title     The entry that will appear in the Menu and in the QDockedWidget title bar
     * @param location  The default location for the QDockedWidget in case there is no previous key in the settings
     */
272
    void addTool(SubMainWindow *parent,VIEW_SECTIONS view,QDockWidget* widget, const QString& title, Qt::DockWidgetArea area);
273 274 275
    void loadDockWidget(const QString &name);

    QDockWidget* createDockWidget(QWidget *subMainWindowParent,QWidget *child,const QString& title,const QString& objectname,VIEW_SECTIONS view,Qt::DockWidgetArea area,const QSize& minSize = QSize());
276 277 278 279 280 281 282 283 284 285 286
    /**
     * @brief Adds an already instantiated QWidget to the center stack
     *
     * This function does all the hosekeeping to have a QWidget added to the tools menu
     * tools menu and connects the QMenuAction to a slot that shows the widget and
     * checks/unchecks the tools menu item. This is used for all the central widgets (those in
     * the center stack.
     *
     * @param widget        The QWidget being added
     * @param title         The entry that will appear in the Menu
     */
287
    void addToCentralStackedWidget(QWidget* widget, VIEW_SECTIONS viewSection, const QString& title);
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313

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

    /** @brief Keeps track of the current view */
    VIEW_SECTIONS currentView;

    void storeViewState();
    void loadViewState();

    void buildCustomWidget();
    void buildCommonWidgets();
    void connectCommonWidgets();
    void connectCommonActions();

    void loadSettings();
    void storeSettings();


    LinkInterface* udpLink;

    QSettings settings;
    QStackedWidget *centerStack;
    QActionGroup* centerStackActionGroup;

    // Center widgets
314 315
    QPointer<SubMainWindow> plannerView;
    QPointer<SubMainWindow> pilotView;
316
    QPointer<SubMainWindow> setupView;
317
    QPointer<SubMainWindow> softwareConfigView;
318 319
    QPointer<SubMainWindow> engineeringView;
    QPointer<SubMainWindow> simView;
320
    QPointer<SubMainWindow> terminalView;
321 322
    QPointer<SubMainWindow> googleEarthView;
    QPointer<SubMainWindow> local3DView;
323 324

    // Center widgets
325
    QPointer<Linecharts> linechartWidget;
Don Gagne's avatar
Don Gagne committed
326 327 328 329 330 331 332
#ifdef QGC_OSG_ENABLED
    QPointer<QWidget> q3DWidget;
#endif
#ifdef QGC_GOOGLE_EARTH_ENABLED
	QPointer<QGCGoogleEarthView> earthWidget;
#endif
    QPointer<QGCFirmwareUpdate> firmwareUpdateWidget;
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364

    // Dock widgets
    QPointer<QDockWidget> controlDockWidget;
    QPointer<QDockWidget> controlParameterWidget;
    QPointer<QDockWidget> infoDockWidget;
    QPointer<QDockWidget> cameraDockWidget;
    QPointer<QDockWidget> listDockWidget;
    QPointer<QDockWidget> waypointsDockWidget;
    QPointer<QDockWidget> detectionDockWidget;
    QPointer<QDockWidget> debugConsoleDockWidget;
    QPointer<QDockWidget> parametersDockWidget;
    QPointer<QDockWidget> headDown1DockWidget;
    QPointer<QDockWidget> headDown2DockWidget;
    QPointer<QDockWidget> watchdogControlDockWidget;

    QPointer<QDockWidget> headUpDockWidget;
    QPointer<QDockWidget> video1DockWidget;
    QPointer<QDockWidget> video2DockWidget;
    QPointer<QDockWidget> rgbd1DockWidget;
    QPointer<QDockWidget> rgbd2DockWidget;
    QPointer<QDockWidget> logPlayerDockWidget;

    QPointer<QDockWidget> hsiDockWidget;
    QPointer<QDockWidget> rcViewDockWidget;
    QPointer<QDockWidget> hudDockWidget;

    QPointer<QGCToolBar> toolBar;

    QPointer<QDockWidget> mavlinkInspectorWidget;
    QPointer<MAVLinkDecoder> mavlinkDecoder;
    QPointer<QDockWidget> mavlinkSenderWidget;
    QGCMAVLinkLogPlayer* logPlayer;
365
    QMap<int, QDockWidget*> hilDocks;
366

367 368
    QPointer<QGCUASFileViewMulti> fileWidget;

369
    JoystickInput* joystick; ///< The joystick manager for QGC
370

Don Gagne's avatar
Don Gagne committed
371
#ifdef QGC_MOUSE_ENABLED_WIN
372
    /** @brief 3d Mouse support (WIN only) */
373 374
    Mouse3DInput* mouseInput;               ///< 3dConnexion 3dMouse SDK
    Mouse6dofInput* mouse;                  ///< Implementation for 3dMouse input
Don Gagne's avatar
Don Gagne committed
375
#endif // QGC_MOUSE_ENABLED_WIN
376

Don Gagne's avatar
Don Gagne committed
377
#ifdef QGC_MOUSE_ENABLED_LINUX
378 379 380
    /** @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
381
#endif // QGC_MOUSE_ENABLED_LINUX
382

383 384 385 386 387 388 389 390 391 392 393 394 395 396
    /** User interface actions **/
    QAction* connectUASAct;
    QAction* disconnectUASAct;
    QAction* startUASAct;
    QAction* returnUASAct;
    QAction* stopUASAct;
    QAction* killUASAct;
    QAction* simulateUASAct;


    LogCompressor* comp;
    QString screenFileName;
    QTimer* videoTimer;
    bool autoReconnect;
397
    MAVLinkSimulationLink* simulationLink;
398 399 400 401
    Qt::WindowStates windowStateVal;
    bool lowPowerMode; ///< If enabled, QGC reduces the update rates of all widgets
    QGCFlightGearLink* fgLink;
    QTimer windowNameUpdateTimer;
Don Gagne's avatar
Don Gagne committed
402 403
    
private slots:
404
    void _addLinkMenu(LinkInterface* link);
405 406

private:
407
    /// Constructor is private since all creation should be through MainWindow::_create
408
    MainWindow(QSplashScreen* splashScreen);
Don Gagne's avatar
Don Gagne committed
409 410 411
    
    void _openUrl(const QString& url, const QString& errorMessage);
    
412
    QList<QObject*> commsWidgetList;
413
    QMap<QString,QString> customWidgetNameToFilenameMap;
414
    MenuActionHelper *menuActionHelper;
415 416
    Ui::MainWindow ui;

417 418 419 420 421
    /** @brief Set the appropriate titlebar for a given dock widget.
      * Relies on the isAdvancedMode and dockWidgetTitleBarEnabled member variables.
      */
    void setDockWidgetTitleBar(QDockWidget* widget);

422 423
    QString getWindowStateKey();
    QString getWindowGeometryKey();
Don Gagne's avatar
Don Gagne committed
424 425
    
    QSplashScreen* _splashScreen;   ///< Splash screen, NULL is splash screen not currently being shown
426

427
    friend class MenuActionHelper; //For VIEW_SECTIONS
428 429 430
};

#endif /* _MAINWINDOW_H_ */