QGroundControlQmlGlobal.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QLoggingCategory>
#include <QtCore/QPointF>
#include <QtCore/QTimer>
#include <QtPositioning/QGeoCoordinate>
#include <QtQml/QJSValue>
#include <QtQmlIntegration/QtQmlIntegration>
 
#include "QmlUnitsConversion.h"
#include "qgc_version.h"
 
Q_DECLARE_LOGGING_CATEGORY(GuidedActionsControllerLog)
 
class ADSBVehicleManager;
class FactGroup;
class LinkManager;
class MissionCommandTree;
class MultiVehicleManager;
class QGCCorePlugin;
class QGCMapEngineManager;
class QGCPalette;
class QGCPositionManager;
class SettingsManager;
class VideoManager;
class QmlObjectListModel;
 
Q_MOC_INCLUDE("ADSBVehicleManager.h")
Q_MOC_INCLUDE("FactGroup.h")
Q_MOC_INCLUDE("LinkManager.h")
Q_MOC_INCLUDE("MissionCommandTree.h")
Q_MOC_INCLUDE("MultiVehicleManager.h")
Q_MOC_INCLUDE("QGCCorePlugin.h")
Q_MOC_INCLUDE("QGCMapEngineManager.h")
Q_MOC_INCLUDE("QGCPalette.h")
Q_MOC_INCLUDE("PositionManager.h")
Q_MOC_INCLUDE("SettingsManager.h")
Q_MOC_INCLUDE("VideoManager.h")
 
class QGroundControlQmlGlobal : public QObject
{
    Q_OBJECT
    QML_NAMED_ELEMENT(QGroundControl)
    QML_SINGLETON
 
public:
    static constexpr int kDefaultMessageDialogButtons = 0x00000400; // Dialog.Ok (Qt 6 StandardButton::Ok)
 
    explicit QGroundControlQmlGlobal(QObject *parent = nullptr);
    ~QGroundControlQmlGlobal();
 
    enum AltMode {
        AltitudeModeMixed,              // Used by global altitude mode for mission planning
        AltitudeModeRelative,           // MAV_FRAME_GLOBAL_RELATIVE_ALT
        AltitudeModeAbsolute,           // MAV_FRAME_GLOBAL
        AltitudeModeCalcAboveTerrain,   // Absolute altitude above terrain calculated from terrain data
        AltitudeModeTerrainFrame,       // MAV_FRAME_GLOBAL_TERRAIN_ALT
        AltitudeModeNone,               // Being used as distance value unrelated to ground (for example distance to structure)
    };
    Q_ENUM(AltMode)
 
    Q_PROPERTY(QString              appName                 READ    appName                 CONSTANT)
    Q_PROPERTY(LinkManager*         linkManager             READ    linkManager             CONSTANT)
    Q_PROPERTY(MultiVehicleManager* multiVehicleManager     READ    multiVehicleManager     CONSTANT)
    Q_PROPERTY(QGCMapEngineManager* mapEngineManager        READ    mapEngineManager        CONSTANT)
    Q_PROPERTY(QGCPositionManager*  qgcPositionManger       READ    qgcPositionManger       CONSTANT)
    Q_PROPERTY(VideoManager*        videoManager            READ    videoManager            CONSTANT)
    Q_PROPERTY(SettingsManager*     settingsManager         READ    settingsManager         CONSTANT)
    Q_PROPERTY(ADSBVehicleManager*  adsbVehicleManager      READ    adsbVehicleManager      CONSTANT)
    Q_PROPERTY(QGCCorePlugin*       corePlugin              READ    corePlugin              CONSTANT)
    Q_PROPERTY(MissionCommandTree*  missionCommandTree      READ    missionCommandTree      CONSTANT)
#ifndef QGC_NO_SERIAL_LINK
    Q_PROPERTY(FactGroup*           gpsRtk                  READ    gpsRtkFactGroup         CONSTANT)
#endif
    Q_PROPERTY(QGCPalette*          globalPalette           MEMBER  _globalPalette          CONSTANT)   
    Q_PROPERTY(QmlUnitsConversion*  unitsConversion         READ    unitsConversion         CONSTANT)
    Q_PROPERTY(bool                 singleFirmwareSupport   READ    singleFirmwareSupport   CONSTANT)
    Q_PROPERTY(bool                 singleVehicleSupport    READ    singleVehicleSupport    CONSTANT)
    Q_PROPERTY(bool                 px4ProFirmwareSupported READ    px4ProFirmwareSupported CONSTANT)
    Q_PROPERTY(int                  apmFirmwareSupported    READ    apmFirmwareSupported    CONSTANT)
    Q_PROPERTY(QGeoCoordinate       flightMapPosition       READ    flightMapPosition       WRITE setFlightMapPosition  NOTIFY flightMapPositionChanged)
    Q_PROPERTY(double               flightMapZoom           READ    flightMapZoom           WRITE setFlightMapZoom      NOTIFY flightMapZoomChanged)
    Q_PROPERTY(double               flightMapInitialZoom    MEMBER  _flightMapInitialZoom   CONSTANT)   
 
    Q_PROPERTY(QString  parameterFileExtension  READ parameterFileExtension CONSTANT)
    Q_PROPERTY(QString  telemetryFileExtension  READ telemetryFileExtension CONSTANT)
 
    Q_PROPERTY(QString qgcVersion       READ qgcVersion         CONSTANT)
    Q_PROPERTY(QString qgcAppDate       READ qgcAppDate         CONSTANT)
    Q_PROPERTY(bool    qgcDailyBuild    READ qgcDailyBuild      CONSTANT)
 
    Q_PROPERTY(qreal zOrderTopMost              READ zOrderTopMost              CONSTANT) 
    Q_PROPERTY(qreal zOrderWidgets              READ zOrderWidgets              CONSTANT) 
    Q_PROPERTY(qreal zOrderMapItems             READ zOrderMapItems             CONSTANT)
    Q_PROPERTY(qreal zOrderVehicles             READ zOrderVehicles             CONSTANT)
    Q_PROPERTY(qreal zOrderWaypointIndicators   READ zOrderWaypointIndicators   CONSTANT)
    Q_PROPERTY(qreal zOrderTrajectoryLines      READ zOrderTrajectoryLines      CONSTANT)
    Q_PROPERTY(qreal zOrderWaypointLines        READ zOrderWaypointLines        CONSTANT)
    Q_PROPERTY(bool     hasAPMSupport           READ hasAPMSupport              CONSTANT)
    Q_PROPERTY(bool     hasMAVLinkInspector     READ hasMAVLinkInspector        CONSTANT)
 
 
    //-------------------------------------------------------------------------
    // Elevation Provider
    Q_PROPERTY(QString  elevationProviderName           READ elevationProviderName              CONSTANT)
    Q_PROPERTY(QString  elevationProviderNotice         READ elevationProviderNotice            CONSTANT)
 
    Q_INVOKABLE void    saveGlobalSetting       (const QString& key, const QString& value);
    Q_INVOKABLE QString loadGlobalSetting       (const QString& key, const QString& defaultValue);
    Q_INVOKABLE void    saveBoolGlobalSetting   (const QString& key, bool value);
    Q_INVOKABLE bool    loadBoolGlobalSetting   (const QString& key, bool defaultValue);
 
    Q_INVOKABLE static void deleteAllSettingsNextBoot();
    Q_INVOKABLE static void clearDeleteAllSettingsNextBoot();
 
    Q_INVOKABLE void    startPX4MockLink            (bool sendStatusText, bool enableCamera, bool enableGimbal);
    Q_INVOKABLE void    startGenericMockLink        (bool sendStatusText, bool enableCamera, bool enableGimbal);
    Q_INVOKABLE void    startAPMArduCopterMockLink  (bool sendStatusText, bool enableCamera, bool enableGimbal);
    Q_INVOKABLE void    startAPMArduPlaneMockLink   (bool sendStatusText, bool enableCamera, bool enableGimbal);
    Q_INVOKABLE void    startAPMArduSubMockLink     (bool sendStatusText, bool enableCamera, bool enableGimbal);
    Q_INVOKABLE void    startAPMArduRoverMockLink   (bool sendStatusText, bool enableCamera, bool enableGimbal);
    Q_INVOKABLE void    stopOneMockLink             (void);
 
    Q_INVOKABLE static QmlObjectListModel *treeLoggingCategoriesModel();
 
    Q_INVOKABLE static QmlObjectListModel *flatLoggingCategoriesModel();
 
    Q_INVOKABLE static void setCategoryLoggingOn(const QString &category, bool enable);
 
    Q_INVOKABLE static bool categoryLoggingOn(const QString &category);
 
    Q_INVOKABLE static void disableAllLoggingCategories();
 
    Q_INVOKABLE bool linesIntersect(QPointF xLine1, QPointF yLine1, QPointF xLine2, QPointF yLine2);
 
    Q_INVOKABLE QString altitudeModeExtraUnits(AltMode altMode);        
    Q_INVOKABLE QString altitudeModeShortDescription(AltMode altMode);  
 
    Q_INVOKABLE void showMessageDialog(
        QObject* owner,
        const QString& title,
        const QString& text,
        int buttons = kDefaultMessageDialogButtons,
        QJSValue acceptFunction = QJSValue(),
        QJSValue closeFunction = QJSValue());
 
    // Property accessors
 
    static QString appName();
    LinkManager*            linkManager         ()  { return _linkManager; }
    MultiVehicleManager*    multiVehicleManager ()  { return _multiVehicleManager; }
    QGCMapEngineManager*    mapEngineManager    ()  { return _mapEngineManager; }
    QGCPositionManager*     qgcPositionManger   ()  { return _qgcPositionManager; }
    MissionCommandTree*     missionCommandTree  ()  { return _missionCommandTree; }
    VideoManager*           videoManager        ()  { return _videoManager; }
    QGCCorePlugin*          corePlugin          ()  { return _corePlugin; }
    SettingsManager*        settingsManager     ()  { return _settingsManager; }
#ifndef QGC_NO_SERIAL_LINK
    FactGroup*              gpsRtkFactGroup     ()  { return _gpsRtkFactGroup; }
#endif
    ADSBVehicleManager*     adsbVehicleManager  ()  { return _adsbVehicleManager; }
    QmlUnitsConversion*     unitsConversion     ()  { return &_unitsConversion; }
    static QGeoCoordinate   flightMapPosition   ()  { return _coord; }
    static double           flightMapZoom       ()  { return _zoom; }
 
    qreal zOrderTopMost             () { return 1000; }
    qreal zOrderWidgets             () { return 100; }
    qreal zOrderMapItems            () { return 50; }
    qreal zOrderWaypointIndicators  () { return 50; }
    qreal zOrderVehicles            () { return 49; }
    qreal zOrderTrajectoryLines     () { return 48; }
    qreal zOrderWaypointLines       () { return 47; }
 
#if defined(QGC_NO_ARDUPILOT_DIALECT)
    bool    hasAPMSupport           () { return false; }
#else
    bool    hasAPMSupport           () { return true; }
#endif
 
#if defined(QGC_DISABLE_MAVLINK_INSPECTOR)
    bool    hasMAVLinkInspector     () { return false; }
#else
    bool    hasMAVLinkInspector     () { return true; }
#endif
 
    QString elevationProviderName   ();
    QString elevationProviderNotice ();
 
    bool    singleFirmwareSupport   ();
    bool    singleVehicleSupport    ();
    bool    px4ProFirmwareSupported ();
    bool    apmFirmwareSupported    ();
 
    void    setFlightMapPosition        (QGeoCoordinate& coordinate);
    void    setFlightMapZoom            (double zoom);
 
    QString parameterFileExtension  (void) const;
    QString telemetryFileExtension  (void) const;
 
    static QString qgcVersion();
    static QString qgcAppDate() { return QGC_APP_DATE; }
#ifdef QGC_DAILY_BUILD
    static bool qgcDailyBuild() { return true; }
#else
    static bool qgcDailyBuild() { return false; }
#endif
 
signals:
    void isMultiplexingEnabledChanged   (bool enabled);
    void mavlinkSystemIDChanged         (int id);
    void flightMapPositionChanged       (QGeoCoordinate flightMapPosition);
    void flightMapZoomChanged           (double flightMapZoom);
    void showMessageDialogRequested     (QObject* owner, QString title, QString text, int buttons, QJSValue acceptFunction, QJSValue closeFunction);
 
private:
    QGCMapEngineManager*    _mapEngineManager       = nullptr;
    ADSBVehicleManager*     _adsbVehicleManager     = nullptr;
    QGCPositionManager*     _qgcPositionManager     = nullptr;
    MissionCommandTree*     _missionCommandTree     = nullptr;
    VideoManager*           _videoManager           = nullptr;
    LinkManager*            _linkManager            = nullptr;
    MultiVehicleManager*    _multiVehicleManager    = nullptr;
    SettingsManager*        _settingsManager        = nullptr;
    QGCCorePlugin*          _corePlugin             = nullptr;
    QGCPalette*             _globalPalette          = nullptr;
#ifndef QGC_NO_SERIAL_LINK
    FactGroup*              _gpsRtkFactGroup        = nullptr;
#endif
 
    double                  _flightMapInitialZoom   = 17.0;
    QmlUnitsConversion      _unitsConversion;
 
    QStringList             _altitudeModeEnumString;
 
    static QGeoCoordinate   _coord;
    static double           _zoom;
    QTimer                  _flightMapPositionSettledTimer;
 
    static constexpr const char* kQmlGlobalKeyName = "QGCQml";
 
    static constexpr const char* _flightMapPositionSettingsGroup =          "FlightMapPosition";
    static constexpr const char* _flightMapPositionLatitudeSettingsKey =    "Latitude";
    static constexpr const char* _flightMapPositionLongitudeSettingsKey =   "Longitude";
    static constexpr const char* _flightMapZoomSettingsKey =                "FlightMapZoom";
};