QGCCorePlugin.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QLoggingCategory>
#include <QtCore/QObject>
#include <QtCore/QVariantList>
#include <QtQmlIntegration/QtQmlIntegration>
 
#include "QGCPalette.h"
 
class FactMetaData;
class LinkInterface;
class PlanMasterController;
class QFile;
class QGCOptions;
class QGeoPositionInfoSource;
class QmlObjectListModel;
class QQmlApplicationEngine;
class QQuickItem;
class Vehicle;
class VideoReceiver;
class VideoSink;
class FactValueGrid;
typedef struct __mavlink_message mavlink_message_t;
 
Q_DECLARE_LOGGING_CATEGORY(QGCCorePluginLog)
 
class QGCCorePlugin : public QObject
{
    Q_OBJECT
    QML_UNCREATABLE("")
    Q_MOC_INCLUDE("QGCOptions.h")
    Q_MOC_INCLUDE("QmlObjectListModel.h")
    Q_PROPERTY(bool showAdvancedUI                      READ showAdvancedUI                     WRITE _setShowAdvancedUI    NOTIFY showAdvancedUIChanged)
    Q_PROPERTY(bool showTouchAreas                      READ showTouchAreas                     WRITE _setShowTouchAreas    NOTIFY showTouchAreasChanged)
    Q_PROPERTY(int defaultSettings                      READ defaultSettings                                                CONSTANT)
    Q_PROPERTY(int offlineVehicleFirstRunPromptId       MEMBER kOfflineVehicleFirstRunPromptId                              CONSTANT)
    Q_PROPERTY(int unitsFirstRunPromptId                MEMBER kUnitsFirstRunPromptId                                       CONSTANT)
    Q_PROPERTY(const QGCOptions *options                READ options                                                        CONSTANT)
    Q_PROPERTY(const QmlObjectListModel *customMapItems READ customMapItems                                                 CONSTANT)
    Q_PROPERTY(QString brandImageIndoor                 READ brandImageIndoor                                               CONSTANT)
    Q_PROPERTY(QString brandImageOutdoor                READ brandImageOutdoor                                              CONSTANT)
    Q_PROPERTY(QString showAdvancedUIMessage            READ showAdvancedUIMessage                                          CONSTANT)
    Q_PROPERTY(QVariantList analyzePages                READ analyzePages                                                   CONSTANT)
    Q_PROPERTY(QVariantList toolBarIndicators           READ toolBarIndicators                                              CONSTANT)
 
public:
    explicit QGCCorePlugin(QObject *parent = nullptr);
    virtual ~QGCCorePlugin();
 
    static QGCCorePlugin *instance();
 
    virtual void init() { }
    virtual void cleanup() { }
 
    virtual const QVariantList &analyzePages();
 
    virtual int defaultSettings() { return 0; }
 
    virtual QGCOptions *options();
 
    virtual bool overrideSettingsGroupVisibility(const QString &name) { Q_UNUSED(name); return true; }
 
    virtual void adjustSettingMetaData(const QString &settingsGroup, FactMetaData &metaData, bool &visible);
 
    virtual QString brandImageIndoor() const { return QString(); }
 
    virtual QString brandImageOutdoor() const { return QString(); }
 
    virtual QString showAdvancedUIMessage() const;
 
    virtual QGeoPositionInfoSource *createPositionSource(QObject *parent) { Q_UNUSED(parent); return nullptr; }
 
    virtual void paletteOverride(const QString &colorName, QGCPalette::PaletteColorInfo_t &colorInfo) { Q_UNUSED(colorName); Q_UNUSED(colorInfo); };
 
    virtual void factValueGridCreateDefaultSettings(FactValueGrid* factValueGrid);
 
    virtual QQmlApplicationEngine *createQmlApplicationEngine(QObject *parent);
 
    virtual void createRootWindow(QQmlApplicationEngine *qmlEngine);
 
    virtual VideoReceiver *createVideoReceiver(QObject *parent);
    virtual void *createVideoSink(QQuickItem *widget, QObject *parent);
    virtual void releaseVideoSink(void *sink);
 
    virtual bool mavlinkMessage(Vehicle *vehicle, LinkInterface *link, const mavlink_message_t &message) { Q_UNUSED(vehicle); Q_UNUSED(link); Q_UNUSED(message); return true; }
 
    virtual const QmlObjectListModel *customMapItems();
 
    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); }
 
    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); }
 
    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); }
 
#ifdef QGC_CUSTOM_BUILD
    virtual QString stableVersionCheckFileUrl() const { return QString(); }
#else
    virtual QString stableVersionCheckFileUrl() const { return QStringLiteral("https://s3-us-west-2.amazonaws.com/qgroundcontrol/latest/QGC.version.txt"); }
#endif
 
    virtual QString stableDownloadLocation() const { return QStringLiteral("qgroundcontrol.com"); }
 
    virtual QStringList complexMissionItemNames(Vehicle *vehicle, const QStringList &complexMissionItemNames) { Q_UNUSED(vehicle); return complexMissionItemNames; }
 
    virtual QList<int> firstRunPromptStdIds() { return QList<int>({ kUnitsFirstRunPromptId, kOfflineVehicleFirstRunPromptId }); }
 
    virtual QList<int> firstRunPromptCustomIds() { return QList<int>(); }
 
    Q_INVOKABLE virtual QString firstRunPromptResource(int id) const;
 
    virtual const QVariantList &toolBarIndicators();
 
    virtual bool getOfflineCameraDefinitionFile(const QString &cameraName, QFile &file) { Q_UNUSED(cameraName); Q_UNUSED(file); return false; }
 
    struct JoystickAction {
        QString name;
        bool canRepeat = false;
    };
    virtual QList<JoystickAction> joystickActions() { return {}; }
 
    Q_INVOKABLE QVariantList firstRunPromptsToShow();
 
    bool showTouchAreas() const { return _showTouchAreas; }
    bool showAdvancedUI() const { return _showAdvancedUI; }
 
    // Standard first run prompt ids
    static constexpr int kUnitsFirstRunPromptId = 1;
    static constexpr int kOfflineVehicleFirstRunPromptId = 2;
 
    // Custom builds can start there first run prompt ids from here
    static constexpr int kFirstRunPromptIdsFirstCustomId = 10000;
 
signals:
    void showTouchAreasChanged(bool showTouchAreas);
    void showAdvancedUIChanged(bool showAdvancedUI);
 
protected:
    bool _showTouchAreas = false;
    bool _showAdvancedUI = true;
 
private:
    void _setShowTouchAreas(bool show);
    void _setShowAdvancedUI(bool show);
 
    QGCOptions *_defaultOptions = nullptr;
    QmlObjectListModel *_emptyCustomMapItems = nullptr;
};