QGCCorePlugin.h 8.62 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/****************************************************************************
 *
 *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * 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 21 22 23 24 25 26 27

#include <QObject>
#include <QVariantList>

/// @file
///     @brief Core Plugin Interface for QGroundControl
///     @author Gus Grubba <mavlink@grubba.com>

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 47 48 49 50 51 52 53 54 55
    Q_PROPERTY(QVariantList         settingsPages           READ settingsPages                                  NOTIFY settingsPagesChanged)
    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)
56

57
    Q_INVOKABLE bool guidedActionsControllerLogging() const;
58

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

63 64
    /// The list of PageWidget pages shown in the instrument panel
    /// @return A list of QmlPageInfo
65
    virtual QVariantList& instrumentPages();
66

67 68
    /// The default settings panel to show
    /// @return The settings index
69
    virtual int defaultSettings();
70 71 72

    /// Global options
    /// @return An instance of QGCOptions
73
    virtual QGCOptions* options();
74

Don Gagne's avatar
Don Gagne committed
75
    /// Allows the core plugin to override the visibility for a settings group
76
    ///     @param name - SettingsGroup name
77
    /// @return true: Show settings ui, false: Hide settings ui
78
    virtual bool overrideSettingsGroupVisibility(QString name);
79

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

86
    /// Return the resource file which contains the brand image for for Indoor theme.
87
    virtual QString brandImageIndoor() const { return QString(); }
88 89

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

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

Patrick José Pereira's avatar
Patrick José Pereira committed
95
    /// @return An instance of an alternate position source (or NULL if not available)
96
    virtual QGeoPositionInfoSource* createPositionSource(QObject* parent) { Q_UNUSED(parent); return nullptr; }
97 98 99

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

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

104 105 106
    /// Allows the plugin to override the creation of the root (native) window.
    virtual QQmlApplicationEngine* createRootWindow(QObject* parent);

107 108 109
    /// Allows the plugin to override the creation of VideoReceiver.
    virtual VideoReceiver* createVideoReceiver(QObject* parent);

110 111 112 113
    /// 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);

114 115
    /// Allows custom builds to add custom items to the FlightMap. Objects put into QmlObjectListModel
    /// should derive from QmlComponentInfo and set the url property.
116
    virtual QmlObjectListModel* customMapItems();
117

118 119 120 121 122 123 124 125 126 127 128 129 130 131
    /// Allows custom builds to add custom items to the plan file. Either before the document is
    /// created or after.
    virtual void    preSaveToJson           (PlanMasterController* pController, QJsonObject& json) { Q_UNUSED(pController); Q_UNUSED(json); }
    virtual void    postSaveToJson          (PlanMasterController* pController, QJsonObject& json) { Q_UNUSED(pController); Q_UNUSED(json); }

    /// Same for the specific "mission" portion
    virtual void    preSaveToMissionJson    (PlanMasterController* pController, QJsonObject& missionJson) { Q_UNUSED(pController); Q_UNUSED(missionJson); }
    virtual void    postSaveToMissionJson   (PlanMasterController* pController, QJsonObject& missionJson) { Q_UNUSED(pController); Q_UNUSED(missionJson); }

    /// Allows custom builds to load custom items from the plan file. Either before the document is
    /// parsed or after.
    virtual void    preLoadFromJson     (PlanMasterController* pController, QJsonObject& json) { Q_UNUSED(pController); Q_UNUSED(json); }
    virtual void    postLoadFromJson    (PlanMasterController* pController, QJsonObject& json) { Q_UNUSED(pController); Q_UNUSED(json); }

Don Gagne's avatar
Don Gagne committed
132
    /// Returns the url to download the stable version check file. Return QString() to indicate no version check should be performed.
133 134
    /// 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
135 136 137
    /// The contents of this file should be a single line in the form:
    ///     v3.4.4
    /// This indicates the latest stable version number.
138
    virtual QString stableVersionCheckFileUrl() const;
Don Gagne's avatar
Don Gagne committed
139 140 141

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

144 145 146 147 148
    /// Returns the complex mission items to display in the Plan UI
    ///     @param complexMissionItemNames Default set of complex items
    /// @return Complex items to be made available to user
    virtual QStringList complexMissionItemNames(Vehicle* vehicle, const QStringList& complexMissionItemNames) { Q_UNUSED(vehicle); return complexMissionItemNames; }

149 150
    bool showTouchAreas() const { return _showTouchAreas; }
    bool showAdvancedUI() const { return _showAdvancedUI; }
DonLakeFlyer's avatar
DonLakeFlyer committed
151 152
    void setShowTouchAreas(bool show);
    void setShowAdvancedUI(bool show);
153

154
    // Override from QGCTool
155
    void                            setToolbox              (QGCToolbox* toolbox);
156 157

signals:
158 159
    void settingsPagesChanged   ();
    void instrumentPagesChanged ();
160 161 162
    void showTouchAreasChanged  (bool showTouchAreas);
    void showAdvancedUIChanged  (bool showAdvancedUI);

163 164 165 166
protected slots:
    void _activeVehicleChanged  (Vehicle* activeVehicle);
    void _dynamicCamerasChanged ();
    void _currentCameraChanged  ();
167
    void _autoStreamChanged     ();
168 169 170 171

protected:
    void _resetInstrumentPages  ();

172 173 174
protected:
    bool                _showTouchAreas;
    bool                _showAdvancedUI;
175 176
    Vehicle*            _activeVehicle  = nullptr;
    QGCCameraManager*   _dynamicCameras = nullptr;
177
    QGCCameraControl*   _currentCamera  = nullptr;
178

179
private:
180
    QGCCorePlugin_p*    _p;
181
};