CorridorScanComplexItem.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QLoggingCategory>
 
#include "TransectStyleComplexItem.h"
#include "SettingsFact.h"
#include "QGCMapPolyline.h"
 
Q_DECLARE_LOGGING_CATEGORY(CorridorScanComplexItemLog)
 
class CorridorScanComplexItem : public TransectStyleComplexItem
{
    Q_OBJECT
 
public:
    CorridorScanComplexItem(PlanMasterController* masterController, bool flyView, const QString& kmlOrShpFile);
 
    Q_PROPERTY(QGCMapPolyline*  corridorPolyline    READ corridorPolyline   CONSTANT)
    Q_PROPERTY(Fact*            corridorWidth       READ corridorWidth      CONSTANT)
 
    // Note1: These values are persisted to plan files so they cannot be changed with breaking plan file back compat
    // Note2: rotateEntryPoint expects these values in this order
    enum EntryPointLocation {
        EntryPointDefaultOrder = 0,                 // Standard transect generation order
        EntryPointStartSameEndOppositeSide = 1,     // Start at same end, opposite side of center
        EntryPointStartOppositeEndSameSide = 2,     // Start at opposite end, same side
        EntryPointStartOppositeEndOppositeSide = 3, // Start at opposite end, opposite side
    };
    Q_ENUM(EntryPointLocation)
 
    Fact*           corridorWidth   (void) { return &_corridorWidthFact; }
    QGCMapPolyline* corridorPolyline(void) { return &_corridorPolyline; }
 
    Q_INVOKABLE void rotateEntryPoint(void);
 
    // Overrides from TransectStyleComplexItem
    QString patternName         (void) const final { return name; }
    void    save                (QJsonArray&  planItems) final;
    bool    specifiesCoordinate (void) const final;
    double  timeBetweenShots    (void) final;
 
    // Overrides from ComplexMissionItem
    bool    load                (const QJsonObject& complexObject, int sequenceNumber, QString& errorString) final;
    QString mapVisualQML        (void) const final { return QStringLiteral("CorridorScanMapVisual.qml"); }
    QString presetsSettingsGroup(void) { return settingsGroup; }
    void    savePreset          (const QString& name);
    void    loadPreset          (const QString& name);
 
    // Overrides from VisualMissionionItem
    QString             commandDescription  (void) const final { return tr("Corridor Scan"); }
    QString             commandName         (void) const final { return tr("Corridor Scan"); }
    QString             abbreviation        (void) const final { return tr("C"); }
    void                setCoordinate       (const QGeoCoordinate& coordinate) final;
    ReadyForSaveState   readyForSaveState   (void) const final;
    double              additionalTimeDelay (void) const final { return 0; }
 
    static const QString name;
 
    static constexpr const char* settingsGroup =            "CorridorScan";
    static constexpr const char* corridorWidthName =        "CorridorWidth";
 
    static constexpr const char* jsonComplexItemTypeValue = "CorridorScan";
 
private slots:
    void _polylineDirtyChanged          (bool dirty);
    void _rebuildCorridorPolygon        (void);
    void _updateWizardMode              (void);
 
    // Overrides from TransectStyleComplexItem
    void _rebuildTransectsPhase1    (void) final;
    void _recalcCameraShots         (void) final;
 
private:
    double  _calcTransectSpacing    (void) const;
    int     _calcTransectCount      (void) const;
    void    _saveCommon             (QJsonObject& complexObject);
    bool    _loadWorker              (const QJsonObject& complexObject, int sequenceNumber, QString& errorString, bool forPresets);
 
    QGCMapPolyline                  _corridorPolyline;
    QList<QList<QGeoCoordinate>>    _transectSegments;      
 
    EntryPointLocation              _entryPointLocation;
 
    QMap<QString, FactMetaData*>    _metaDataMap;
    SettingsFact                    _corridorWidthFact;
 
    static constexpr const char* _jsonEntryPointKey =       "EntryPoint";
};