QGCCorePlugin.h 9.15 KB
Newer Older
1 2
/****************************************************************************
 *
Gus Grubba's avatar
Gus Grubba committed
3
 * (c) 2009-2020 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
4 5 6 7 8 9 10 11 12
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/

#pragma once

#include "QGCToolbox.h"
13
#include "QGCPalette.h"
14
#include "QGCMAVLink.h"
15
#include "QmlObjectListModel.h"
16 17 18 19 20

#include <QObject>
#include <QVariantList>

/// @file
Gus Grubba's avatar
Gus Grubba committed
21 22
/// @brief Core Plugin Interface for QGroundControl
/// @author Gus Grubba <gus@auterion.com>
23 24 25 26 27

class QGCApplication;
class QGCOptions;
class QGCSettings;
class QGCCorePlugin_p;
28
class FactMetaData;
29
class QGeoPositionInfoSource;
30
class QQmlApplicationEngine;
31 32
class Vehicle;
class LinkInterface;
33
class QmlObjectListModel;
34
class VideoReceiver;
35
class PlanMasterController;
36
class QGCCameraManager;
37
class QGCCameraControl;
38

39 40 41 42
class QGCCorePlugin : public QGCTool
{
    Q_OBJECT
public:
43
    QGCCorePlugin(QGCApplication* app, QGCToolbox* toolbox);
44 45
    ~QGCCorePlugin();

46
    Q_PROPERTY(QVariantList         settingsPages           READ settingsPages                                  NOTIFY settingsPagesChanged)
47
    Q_PROPERTY(QVariantList         analyzePages            READ analyzePages                                   NOTIFY analyzePagesChanged)
48 49 50 51 52 53 54 55 56
    Q_PROPERTY(QVariantList         instrumentPages         READ instrumentPages                                NOTIFY instrumentPagesChanged)
    Q_PROPERTY(int                  defaultSettings         READ defaultSettings                                CONSTANT)
    Q_PROPERTY(QGCOptions*          options                 READ options                                        CONSTANT)
    Q_PROPERTY(bool                 showTouchAreas          READ showTouchAreas         WRITE setShowTouchAreas NOTIFY showTouchAreasChanged)
    Q_PROPERTY(bool                 showAdvancedUI          READ showAdvancedUI         WRITE setShowAdvancedUI NOTIFY showAdvancedUIChanged)
    Q_PROPERTY(QString              showAdvancedUIMessage   READ showAdvancedUIMessage                          CONSTANT)
    Q_PROPERTY(QString              brandImageIndoor        READ brandImageIndoor                               CONSTANT)
    Q_PROPERTY(QString              brandImageOutdoor       READ brandImageOutdoor                              CONSTANT)
    Q_PROPERTY(QmlObjectListModel*  customMapItems          READ customMapItems                                 CONSTANT)
57

58
    Q_INVOKABLE bool guidedActionsControllerLogging() const;
59

60 61
    /// The list of settings under the Settings Menu
    /// @return A list of QGCSettings
62
    virtual QVariantList& settingsPages();
63

64 65 66 67
    /// The list of pages/buttons under the Analyze Menu
    /// @return A list of QmlPageInfo
    virtual QVariantList& analyzePages();

68 69
    /// The list of PageWidget pages shown in the instrument panel
    /// @return A list of QmlPageInfo
70
    virtual QVariantList& instrumentPages();
71

72 73
    /// The default settings panel to show
    /// @return The settings index
74
    virtual int defaultSettings();
75 76 77

    /// Global options
    /// @return An instance of QGCOptions
78
    virtual QGCOptions* options();
79

Don Gagne's avatar
Don Gagne committed
80
    /// Allows the core plugin to override the visibility for a settings group
81
    ///     @param name - SettingsGroup name
82
    /// @return true: Show settings ui, false: Hide settings ui
83
    virtual bool overrideSettingsGroupVisibility(QString name);
84

85
    /// Allows the core plugin to override the setting meta data before the setting fact is created.
86
    ///     @param settingsGroup - QSettings group which contains this item
87 88
    ///     @param metaData - MetaData for setting fact
    /// @return true: Setting should be visible in ui, false: Setting should not be shown in ui
89
    virtual bool adjustSettingMetaData(const QString& settingsGroup, FactMetaData& metaData);
90

91
    /// Return the resource file which contains the brand image for for Indoor theme.
92
    virtual QString brandImageIndoor() const { return QString(); }
93 94

    /// Return the resource file which contains the brand image for for Outdoor theme.
95
    virtual QString brandImageOutdoor() const { return QString(); }
96

Donald Gagne's avatar
Donald Gagne committed
97
    /// @return The message to show to the user when they a re prompted to confirm turning on advanced ui.
98
    virtual QString showAdvancedUIMessage() const;
Donald Gagne's avatar
Donald Gagne committed
99

Patrick José Pereira's avatar
Patrick José Pereira committed
100
    /// @return An instance of an alternate position source (or NULL if not available)
Gus Grubba's avatar
Gus Grubba committed
101
    virtual QGeoPositionInfoSource* createPositionSource(QObject* /*parent*/) { return nullptr; }
102 103 104

    /// Allows a plugin to override the specified color name from the palette
    virtual void paletteOverride(QString colorName, QGCPalette::PaletteColorInfo_t& colorInfo);
105

106
    /// Allows the plugin to override the default settings for the Values Widget large and small values
107 108
    virtual void valuesWidgetDefaultSettings(QStringList& largeValues, QStringList& smallValues);

109 110 111
    /// Allows the plugin to override the creation of the root (native) window.
    virtual QQmlApplicationEngine* createRootWindow(QObject* parent);

112 113
    /// Allows the plugin to override the creation of VideoManager.
    virtual VideoManager* createVideoManager(QGCApplication* app, QGCToolbox* toolbox);
114 115 116
    /// Allows the plugin to override the creation of VideoReceiver.
    virtual VideoReceiver* createVideoReceiver(QObject* parent);

117 118 119 120
    /// Allows the plugin to see all mavlink traffic to a vehicle
    /// @return true: Allow vehicle to continue processing, false: Vehicle should not process message
    virtual bool mavlinkMessage(Vehicle* vehicle, LinkInterface* link, mavlink_message_t message);

Gus Grubba's avatar
Gus Grubba committed
121
    /// Allows custom builds to add custom items to the FlightMap. Objects put into QmlObjectListModel should derive from QmlComponentInfo and set the url property.
122
    virtual QmlObjectListModel* customMapItems();
123

Gus Grubba's avatar
Gus Grubba committed
124 125 126 127
    /// Allows custom builds to add custom items to the plan file before the document is created.
    virtual void    preSaveToJson           (PlanMasterController* /*pController*/, QJsonObject& /*json*/) {}
    /// Allows custom builds to add custom items to the plan file after the document is created.
    virtual void    postSaveToJson          (PlanMasterController* /*pController*/, QJsonObject& /*json*/) {}
128

Gus Grubba's avatar
Gus Grubba committed
129 130 131 132
    /// Allows custom builds to add custom items to the mission section of the plan file before the item is created.
    virtual void    preSaveToMissionJson    (PlanMasterController* /*pController*/, QJsonObject& /*missionJson*/) {}
    /// Allows custom builds to add custom items to the mission section of the plan file after the item is created.
    virtual void    postSaveToMissionJson   (PlanMasterController* /*pController*/, QJsonObject& /*missionJson*/) {}
133

Gus Grubba's avatar
Gus Grubba committed
134 135 136 137
    /// Allows custom builds to load custom items from the plan file before the document is parsed.
    virtual void    preLoadFromJson     (PlanMasterController* /*pController*/, QJsonObject& /*json*/) {}
    /// Allows custom builds to load custom items from the plan file after the document is parsed.
    virtual void    postLoadFromJson    (PlanMasterController* /*pController*/, QJsonObject& /*json*/) {}
138

Don Gagne's avatar
Don Gagne committed
139
    /// Returns the url to download the stable version check file. Return QString() to indicate no version check should be performed.
140 141
    /// Default QGC mainline implemenentation returns QGC Stable file location. Default QGC custom build code returns QString().
    /// Custom builds can override to turn on and provide their own location.
Don Gagne's avatar
Don Gagne committed
142 143 144
    /// The contents of this file should be a single line in the form:
    ///     v3.4.4
    /// This indicates the latest stable version number.
145
    virtual QString stableVersionCheckFileUrl() const;
Don Gagne's avatar
Don Gagne committed
146 147 148

    /// Returns the user visible url to show user where to download new stable builds from.
    /// Custom builds must override to provide their own location.
149
    virtual QString stableDownloadLocation() const { return QString("qgroundcontrol.com"); }
Don Gagne's avatar
Don Gagne committed
150

151
    /// Returns the complex mission items to display in the Plan UI
Gus Grubba's avatar
Gus Grubba committed
152
    /// @param complexMissionItemNames Default set of complex items
153
    /// @return Complex items to be made available to user
Gus Grubba's avatar
Gus Grubba committed
154
    virtual QStringList complexMissionItemNames(Vehicle* /*vehicle*/, const QStringList& complexMissionItemNames) { return complexMissionItemNames; }
155

156 157
    bool showTouchAreas() const { return _showTouchAreas; }
    bool showAdvancedUI() const { return _showAdvancedUI; }
DonLakeFlyer's avatar
DonLakeFlyer committed
158 159
    void setShowTouchAreas(bool show);
    void setShowAdvancedUI(bool show);
160

161
    // Override from QGCTool
162
    void                            setToolbox              (QGCToolbox* toolbox);
163 164

signals:
165
    void settingsPagesChanged   ();
166
    void analyzePagesChanged    ();
167
    void instrumentPagesChanged ();
168 169 170
    void showTouchAreasChanged  (bool showTouchAreas);
    void showAdvancedUIChanged  (bool showAdvancedUI);

171 172 173 174
protected slots:
    void _activeVehicleChanged  (Vehicle* activeVehicle);
    void _dynamicCamerasChanged ();
    void _currentCameraChanged  ();
175
    void _autoStreamChanged     ();
176 177 178 179

protected:
    void _resetInstrumentPages  ();

180 181 182
protected:
    bool                _showTouchAreas;
    bool                _showAdvancedUI;
183 184
    Vehicle*            _activeVehicle  = nullptr;
    QGCCameraManager*   _dynamicCameras = nullptr;
185
    QGCCameraControl*   _currentCamera  = nullptr;
186

187
private:
188
    QGCCorePlugin_p*    _p;
189
};