SimpleMissionItem.h 9.49 KB
Newer Older
1 2 3 4 5 6 7 8 9
/****************************************************************************
 *
 *   (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.
 *
 ****************************************************************************/

10 11 12 13

#ifndef SimpleMissionItem_H
#define SimpleMissionItem_H

14
#include "VisualMissionItem.h"
15
#include "MissionItem.h"
16
#include "MissionCommandTree.h"
17
#include "CameraSection.h"
18
#include "SpeedSection.h"
19

20 21
/// A SimpleMissionItem is used to represent a single MissionItem to the ui.
class SimpleMissionItem : public VisualMissionItem
22 23 24 25 26
{
    Q_OBJECT
    
public:
    SimpleMissionItem(Vehicle* vehicle, QObject* parent = NULL);
27
    SimpleMissionItem(Vehicle* vehicle, bool editMode, const MissionItem& missionItem, QObject* parent = NULL);
28 29
    SimpleMissionItem(const SimpleMissionItem& other, QObject* parent = NULL);

30 31
    ~SimpleMissionItem();

32 33 34 35 36 37 38
    enum AltitudeMode {
        AltitudeRelative,
        AltitudeAMSL,
        AltitudeAboveTerrain
    };

    Q_ENUM(AltitudeMode)
39 40 41 42
    
    Q_PROPERTY(QString          category                READ category                                           NOTIFY commandChanged)
    Q_PROPERTY(bool             friendlyEditAllowed     READ friendlyEditAllowed                                NOTIFY friendlyEditAllowedChanged)
    Q_PROPERTY(bool             rawEdit                 READ rawEdit                WRITE setRawEdit            NOTIFY rawEditChanged)              ///< true: raw item editing with all params
43 44 45 46
    Q_PROPERTY(bool             specifiesAltitude       READ specifiesAltitude                                  NOTIFY commandChanged)
    Q_PROPERTY(Fact*            altitude                READ altitude                                           CONSTANT)                           ///< Altitude as specified by altitudeMode. Not necessarily true mission item altitude
    Q_PROPERTY(AltitudeMode     altitudeMode            READ altitudeMode           WRITE setAltitudeMode       NOTIFY altitudeModeChanged)
    Q_PROPERTY(Fact*            amslAltAboveTerrain     READ amslAltAboveTerrain                                CONSTANT)                           ///< Actual AMSL altitude for item if altitudeMode == AltitudeAboveTerrain
47
    Q_PROPERTY(int              command                 READ command                WRITE setCommand            NOTIFY commandChanged)
48

49
    /// Optional sections
50
    Q_PROPERTY(QObject*         speedSection            READ speedSection                                       NOTIFY speedSectionChanged)
51 52
    Q_PROPERTY(QObject*         cameraSection           READ cameraSection                                      NOTIFY cameraSectionChanged)

53
    // These properties are used to display the editing ui
54 55 56
    Q_PROPERTY(QmlObjectListModel*  comboboxFacts   READ comboboxFacts  CONSTANT)
    Q_PROPERTY(QmlObjectListModel*  textFieldFacts  READ textFieldFacts CONSTANT)
    Q_PROPERTY(QmlObjectListModel*  nanFacts        READ nanFacts       CONSTANT)
57

58 59 60 61
    /// Scans the loaded items for additional section settings
    ///     @param visualItems List of all visual items
    ///     @param scanIndex Index to start scanning from
    ///     @param vehicle Vehicle associated with this mission
62
    /// @return true: section found, scanIndex updated
63
    bool scanForSections(QmlObjectListModel* visualItems, int scanIndex, Vehicle* vehicle);
64

65 66 67
    // Property accesors
    
    QString         category            (void) const;
68
    int             command(void) const { return _missionItem._commandFact.cookedValue().toInt(); }
69 70
    bool            friendlyEditAllowed (void) const;
    bool            rawEdit             (void) const;
71 72 73 74 75
    bool            specifiesAltitude   (void) const;
    AltitudeMode    altitudeMode        (void) const { return _altitudeMode; }
    Fact*           altitude            (void) { return &_altitudeFact; }
    Fact*           amslAltAboveTerrain (void) { return &_amslAltAboveTerrainFact; }

76
    CameraSection*  cameraSection       (void) { return _cameraSection; }
77
    SpeedSection*   speedSection        (void) { return _speedSection; }
78

79 80 81
    QmlObjectListModel* textFieldFacts  (void) { return &_textFieldFacts; }
    QmlObjectListModel* nanFacts        (void) { return &_nanFacts; }
    QmlObjectListModel* comboboxFacts   (void) { return &_comboboxFacts; }
82 83

    void setRawEdit(bool rawEdit);
84
    void setAltitudeMode(AltitudeMode altitudeMode);
85 86 87
    
    void setCommandByIndex(int index);

88
    void setCommand(int command);
89 90 91 92 93 94 95

    void setAltDifference   (double altDifference);
    void setAltPercent      (double altPercent);
    void setAzimuth         (double azimuth);
    void setDistance        (double distance);

    bool load(QTextStream &loadStream);
Don Gagne's avatar
Don Gagne committed
96
    bool load(const QJsonObject& json, int sequenceNumber, QString& errorString);
97 98

    MissionItem& missionItem(void) { return _missionItem; }
99
    const MissionItem& missionItem(void) const { return _missionItem; }
100 101 102 103 104 105 106

    // Overrides from VisualMissionItem

    bool            dirty                   (void) const final { return _dirty; }
    bool            isSimpleItem            (void) const final { return true; }
    bool            isStandaloneCoordinate  (void) const final;
    bool            specifiesCoordinate     (void) const final;
107
    bool            specifiesAltitudeOnly   (void) const final;
108 109
    QString         commandDescription      (void) const final;
    QString         commandName             (void) const final;
110
    QString         abbreviation            (void) const final;
111 112
    QGeoCoordinate  coordinate              (void) const final { return _missionItem.coordinate(); }
    QGeoCoordinate  exitCoordinate          (void) const final { return coordinate(); }
113
    int             sequenceNumber          (void) const final { return _missionItem.sequenceNumber(); }
DonLakeFlyer's avatar
DonLakeFlyer committed
114 115
    double          specifiedFlightSpeed    (void) final;
    double          specifiedGimbalYaw      (void) final;
116
    double          specifiedGimbalPitch    (void) final;
117
    QString         mapVisualQML            (void) const final { return QStringLiteral("SimpleItemMapVisual.qml"); }
118
    void            appendMissionItems      (QList<MissionItem*>& items, QObject* missionItemParent) final;
DonLakeFlyer's avatar
DonLakeFlyer committed
119
    void            applyNewAltitude        (double newAltitude) final;
120
    void            setMissionFlightStatus  (MissionController::MissionFlightStatus_t& missionFlightStatus) final;
121
    bool            readyForSave            (void) const final;
122 123 124 125 126 127

    bool coordinateHasRelativeAltitude      (void) const final { return _missionItem.relativeAltitude(); }
    bool exitCoordinateHasRelativeAltitude  (void) const final { return coordinateHasRelativeAltitude(); }
    bool exitCoordinateSameAsEntry          (void) const final { return true; }

    void setDirty           (bool dirty) final;
128 129
    void setCoordinate      (const QGeoCoordinate& coordinate) final;
    void setSequenceNumber  (int sequenceNumber) final;
130 131
    int  lastSequenceNumber (void) const final;
    void save               (QJsonArray&  missionItems) final;
132 133 134 135 136 137 138 139 140

public slots:
    void setDefaultsForCommand(void);

signals:
    void commandChanged             (int command);
    void friendlyEditAllowedChanged (bool friendlyEditAllowed);
    void headingDegreesChanged      (double heading);
    void rawEditChanged             (bool rawEdit);
141
    void cameraSectionChanged       (QObject* cameraSection);
142
    void speedSectionChanged        (QObject* cameraSection);
143
    void altitudeModeChanged        (void);
144

145
private slots:
146 147 148 149 150 151 152 153 154 155 156
    void _setDirty                      (void);
    void _sectionDirtyChanged           (bool dirty);
    void _sendCommandChanged            (void);
    void _sendCoordinateChanged         (void);
    void _sendFriendlyEditAllowedChanged(void);
    void _altitudeChanged               (void);
    void _altitudeModeChanged           (void);
    void _terrainAltChanged             (void);
    void _updateLastSequenceNumber      (void);
    void _rebuildFacts                  (void);
    void _rebuildTextFieldFacts         (void);
157

158
private:
159 160
    void _connectSignals        (void);
    void _setupMetaData         (void);
161
    void _updateOptionalSections(void);
162 163
    void _rebuildNaNFacts       (void);
    void _rebuildComboBoxFacts  (void);
164

165 166 167 168
    MissionItem     _missionItem;
    bool            _rawEdit;
    bool            _dirty;
    bool            _ignoreDirtyChangeSignals;
169

170
    SpeedSection*   _speedSection;
171 172
    CameraSection* _cameraSection;

173 174
    MissionCommandTree* _commandTree;

175 176 177 178 179
    Fact                _supportedCommandFact;

    AltitudeMode    _altitudeMode;
    Fact            _altitudeFact;
    Fact            _amslAltAboveTerrainFact;
180 181 182 183

    QmlObjectListModel  _textFieldFacts;
    QmlObjectListModel  _nanFacts;
    QmlObjectListModel  _comboboxFacts;
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
    
    static FactMetaData*    _altitudeMetaData;
    static FactMetaData*    _commandMetaData;
    static FactMetaData*    _defaultParamMetaData;
    static FactMetaData*    _frameMetaData;
    static FactMetaData*    _latitudeMetaData;
    static FactMetaData*    _longitudeMetaData;

    FactMetaData    _param1MetaData;
    FactMetaData    _param2MetaData;
    FactMetaData    _param3MetaData;
    FactMetaData    _param4MetaData;
    FactMetaData    _param5MetaData;
    FactMetaData    _param6MetaData;
    FactMetaData    _param7MetaData;

200 201 202 203 204
    bool _syncingHeadingDegreesAndParam4;   ///< true: already in a sync signal, prevents signal loop

    static const char* _jsonAltitudeModeKey;
    static const char* _jsonAltitudeKey;
    static const char* _jsonAMSLAltAboveTerrainKey;
205 206 207
};

#endif