Merge pull request #197 from TwinFan/Next

v2.10

Author: TwinFan

CMakeLists.txt

@@ -3,7 +3,7 @@
 #               Set up to be used in a Visual Studio environment to build win (File > Open > Folder, then VS recognized the CMAKE configuration)
 
 cmake_minimum_required(VERSION 3.16)
-project(LiveTraffic VERSION 2.09 DESCRIPTION "LiveTraffic X-Plane plugin" LANGUAGES C CXX)
+project(LiveTraffic VERSION 2.10 DESCRIPTION "LiveTraffic X-Plane plugin" LANGUAGES C CXX)
 
 # By default, use optimized release configuration.
 if (NOT CMAKE_BUILD_TYPE OR CMAKE_BUILD_TYPE STREQUAL "")
@@ -68,6 +68,7 @@ set(Header_Files
     Include/LTImgWindow.h
     Include/LTOpenSky.h
     Include/LTRealTraffic.h
+    Include/LTWeather.h
     Include/Network.h
     Include/SettingsUI.h
     Include/TextIO.h
@@ -109,6 +110,7 @@ set(Source_Files
     Src/LTOpenSky.cpp
     Src/LTRealTraffic.cpp
     Src/LTVersion.cpp
+    Src/LTWeather.cpp
     Src/Network.cpp
     Src/SettingsUI.cpp
     Src/TextIO.cpp

Include/ACInfoWnd.h

@@ -119,6 +119,7 @@ class ACIWnd : public LTImgWindow
     // hide/show all windows, returns new state
     static bool ToggleHideShowAll();
     static bool AreShown() { return bAreShown; }
+    static ACIWnd* GetWnd (const LTFlightData::FDKeyTy& _key);
     static void CloseAll();
 
 };

Include/ACTable.h

@@ -60,6 +60,7 @@ enum ACTColumnsTy {
     ACT_COL_GEAR,           ///< gear deployment ratio
     ACT_COL_FLAPS,          ///< flap deployment ratio
     ACT_COL_LIGHTS,         ///< which lights are on?
+    ACT_COL_TCAS_IDX,       ///< TCAS Idx (1-63) of plane - if any
 
     // these must stay last
     ACT_COL_ACTIONS,        ///< actions like a/c info wnd, camera, visibility
@@ -99,8 +100,8 @@ class FDInfo {
     /// @warning Can return `nullptr`!
     LTFlightData* GetFD () const;
 
-    /// @brief Does _any_ value match this filter string?
-    /// @param _s Substring to be searched for, expected in _upper case_
+    /// @brief Does any value match this filter string?
+    /// @param _s Substring to be searched for, expected in upper case
     bool matches (const std::string& _s) const;
 };
 

Include/Constants.h

@@ -29,8 +29,8 @@
 //
 // MARK: Version Information (CHANGE VERSION HERE)
 //
-constexpr float VERSION_NR = 2.09f;
-constexpr bool VERSION_BETA = true;
+constexpr float VERSION_NR = 2.10f;
+constexpr bool VERSION_BETA = false;
 extern float verXPlaneOrg;          // version on X-Plane.org
 extern int verDateXPlaneOrg;        // and its date
 
@@ -58,7 +58,7 @@ constexpr double PI         = 3.141592653589793238462643383279502884197169399375
 constexpr double EARTH_D_M  = 6371.0 * 2 * 1000;    // earth diameter in meter
 constexpr double JAN_FIRST_2019 = 1546344000;   // 01.01.2019
 constexpr double HPA_STANDARD   = 1013.25;      // air pressure
-constexpr double INCH_STANDARD  = 2992.126;
+constexpr double INCH_STANDARD  = 29.92126;
 constexpr double HPA_per_INCH   = HPA_STANDARD/INCH_STANDARD;
 // The pressure drops approximately by 11.3 Pa per meter in first 1000 meters above sea level.
 constexpr double PA_per_M       = 11.3;         // https://en.wikipedia.org/wiki/Barometric_formula
@@ -157,7 +157,7 @@ constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
 #define MSG_WELCOME             "LiveTraffic %s successfully loaded!"
 #define MSG_REINIT              "LiveTraffic is re-initializing itself"
 #define MSG_DISABLE_MYSELF      "LiveTraffic disables itself due to unhandable exceptions"
-#define MSG_LT_NEW_VER_AVAIL    "The new version %01.2f of LiveTraffic is available at X-Plane.com!"
+#define MSG_LT_NEW_VER_AVAIL    "The new version %01.2f of LiveTraffic is available at X-Plane.org!"
 #define MSG_TIMESTAMPS          "Current System time is %sZ, current simulated time is %s"
 #define MSG_AI_LOAD_ACF         "Changing AI control: X-Plane is now loading AI Aircraft models..."
 #define MSG_REQUESTING_LIVE_FD  "Requesting live flight data online..."
@@ -166,6 +166,7 @@ constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
 #define MSG_NUM_AC_ZERO         "No more aircraft displayed"
 #define MSG_BUF_FILL_COUNTDOWN  "Filling buffer: seeing %d aircraft, displaying %d, still %ds to buffer"
 #define MSG_HIST_WITH_SYS_TIME  "When using historic data you cannot run X-Plane with 'always track system time',\ninstead, choose the historic date in X-Plane's date/time settings."
+#define INFO_WEATHER_UPDATED    "Weather updated: QNH %.f hPa at %s (%.2f°, %.2f°)"
 #define INFO_AC_ADDED           "Added aircraft %s, operator '%s', a/c model '%s', flight model [%s], bearing %.0f, distance %.1fnm, from channel %s"
 #define INFO_AC_MDL_CHANGED     "Changed CSL model for aircraft %s, operator '%s': a/c model now '%s'"
 #define INFO_GND_VEHICLE_APT    "Vehicle %s: Decided for ground vehicle based on operator name '%s'"
@@ -218,6 +219,7 @@ constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
 #define MENU_HELP_DOCUMENTATION "Documentation"
 #define MENU_HELP_FAQ           "FAQ"
 #define MENU_HELP_MENU_ITEMS    "Menu Items"
+#define MENU_HELP_INFO_LIST_WND "Status / Info Window"
 #define MENU_HELP_AC_INFO_WND   "A/C Info Window"
 #define MENU_HELP_SETTINGS      "Settings"
 #define MENU_NEWVER             "New Version %01.2f available!"
@@ -230,6 +232,11 @@ constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
 #define HELP_URL                "https://twinfan.gitbook.io/livetraffic/"
 #define HELP_FAQ                "reference/faq"
 #define HELP_MENU_ITEMS         "using-lt/menu-items"
+#define HELP_ILW                "using-lt/info-list-window"
+#define HELP_ILW_AC_LIST        "using-lt/info-list-window/aircraft-list"
+#define HELP_ILW_MESSAGES       "using-lt/info-list-window/messages"
+#define HELP_ILW_STATUS         "using-lt/info-list-window/status-about"
+#define HELP_ILW_SETTINGS       "using-lt/info-list-window/ui-settings"
 #define HELP_AC_INFO_WND        "using-lt/aircraft-information-window"
 #define HELP_SETTINGS           "setup/configuration#settings-ui"
 #define HELP_SET_BASICS         "setup/configuration/settings-basics"
@@ -243,7 +250,6 @@ constexpr int LT_NEW_VER_CHECK_TIME = 48;   // [h] between two checks of a new
 #define HELP_SET_ADVANCED       "setup/configuration/settings-advanced"
 #define HELP_SET_CSL            "setup/configuration/settings-csl"
 #define HELP_SET_DEBUG          "setup/configuration/settings-debug"
-#define HELP_ILW                "using-lt/info-list-window"
 
 //MARK: File Paths
 // these are under the plugins directory
@@ -289,7 +295,8 @@ constexpr int SERR_LEN = 100;                   // size of buffer for IO error t
 #define ERR_CURL_DISABLE_REV_QU "%s: Querying revocation list failed - have set CURLSSLOPT_NO_REVOKE and am trying again"
 #define ERR_HTTP_NOT_OK         "HTTP response was not HTTP_OK"
 #define ERR_FOUND_NO_VER_INFO   "Found no version info in response"
-#define ERR_CH_NONE_ACTIVE      "No enabled active channel for tracking data! Check Basic Settings and enable channels."
+#define ERR_CH_NONE_ACTIVE1     "No enabled active channel for tracking data!"
+#define ERR_CH_NONE_ACTIVE      ERR_CH_NONE_ACTIVE1 " Check Basic Settings and enable channels."
 #define ERR_CH_UNKNOWN_NAME     "(unknown channel)"
 #define ERR_CH_INVALID          "%s: Channel invalid and disabled"
 #define ERR_CH_MAX_ERR_INV      "%s: Channel invalid and disabled after too many errors"

Include/DataRefs.h

@@ -358,6 +358,7 @@ enum dataRefsLT {
     DR_CFG_HIDE_TAXIING,
     DR_CFG_HIDE_NEARBY_GND,
     DR_CFG_HIDE_NEARBY_AIR,
+    DR_CFG_COPY_OBJ_FILES,
     DR_CFG_LAST_CHECK_NEW_VER,
 
     // debug options
@@ -616,6 +617,7 @@ class DataRefs
     int hideTaxiing     = 0;            // hide a/c while taxiing?
     int hideNearbyGnd   = 0;            // [m] hide a/c if closer than this to user's aircraft on the ground
     int hideNearbyAir   = 0;            // [m] hide a/c if closer than this to user's aircraft in the air
+    int cpyObjFiles     = 1;            ///< copy `.obj` files for replacing dataRefs and textures
 
     // channel config options
     int rtListenPort    = 10747;        // port opened for RT to connect
@@ -639,6 +641,14 @@ class DataRefs
     std::string keyAc;                  // key (transpIcao) for a/c whose data is returned
     const LTAircraft* pAc = nullptr;    // ptr to that a/c
 
+    // Weather
+    double      altPressCorr_ft = 0.0;  ///< [ft] barometric correction for pressure altitude, in meter
+    float       lastWeatherUpd = 0.0f;  ///< last time the weather was updated? (in XP's network time)
+    float       lastWeatherHPA = HPA_STANDARD; ///< last barometric pressure received
+    positionTy  lastWeatherPos;         ///< last position for which weather was retrieved
+    std::string lastWeatherStationId;   ///< last weather station we got weather from
+    std::string lastWeatherMETAR;       ///< last full METAR string
+    
 //MARK: Debug helpers (public)
 public:
     std::string cslFixAcIcaoType;       // set of fixed values to use for...
@@ -688,7 +698,7 @@ class DataRefs
 public:
     void ThisThreadIsXP() { xpThread = std::this_thread::get_id();  }
     bool IsXPThread() const { return std::this_thread::get_id() == xpThread; }
-    inline float GetMiscNetwTime() const        { return lastNetwTime; }
+    float GetMiscNetwTime() const;
     inline bool  IsViewExternal() const         { return XPLMGetDatai(adrXP[DR_VIEW_EXTERNAL]) != 0; }
     inline XPViewTypes GetViewType () const     { return (XPViewTypes)XPLMGetDatai(adrXP[DR_VIEW_TYPE]); }
     inline bool UsingModernDriver () const      { return bUsingModernDriver; }
@@ -786,6 +796,7 @@ class DataRefs
     inline bool IsAutoHidingActive() const  ///< any auto-hiding activated?
     { return hideBelowAGL > 0  || hideTaxiing != 0 ||
              hideNearbyGnd > 0 || hideNearbyAir > 0; }
+    bool ShallCpyObjFiles () const { return cpyObjFiles != 0; }
 
     bool NeedNewVerCheck () const;
     void SetLastCheckedNewVerNow ();
@@ -799,7 +810,7 @@ class DataRefs
     bool SetDefaultCarIcaoType(const std::string type);
 
     // livetraffic/channel/...
-    inline void SetChannelEnabled (dataRefsLT ch, bool bEnable) { bChannel[ch - DR_CHANNEL_FIRST] = bEnable; }
+    void SetChannelEnabled (dataRefsLT ch, bool bEnable);
     inline bool IsChannelEnabled (dataRefsLT ch) const { return bChannel[ch - DR_CHANNEL_FIRST]; }
     int CntChannelEnabled () const;
 
@@ -864,6 +875,19 @@ class DataRefs
     bool ShallDrawLabels() const;
     bool ShallDrawMapLabels() const { return labelShown.bMap; }
     bool ToggleLabelDraw();                 // returns new value
+    
+    // Weather
+    bool WeatherUpdate ();              ///< check if weather updated needed, then do
+    /// @brief set/update current weather
+    /// @details if lat/lon ar NAN, then location of provided station is taken if found, else current camera pos
+    void SetWeather (float hPa, float lat, float lon, const std::string& stationId,
+                     const std::string& METAR);
+    /// Compute geometric altitude [ft] from pressure altitude and current weather in a very simplistic manner good enough for the first 3,000ft
+    double WeatherAltCorr_ft (double pressureAlt_ft) { return pressureAlt_ft + altPressCorr_ft; }
+    /// Compute geometric altitude [m] from pressure altitude and current weather in a very simplistic manner good enough for the first 3,000ft
+    double WeatherAltCorr_m (double pressureAlt_m) { return pressureAlt_m + altPressCorr_ft * M_per_FT; }
+    /// Thread-safely gets current weather info
+    void GetWeather (float& hPa, std::string& stationId, std::string& METAR);
 };
 
 extern DataRefs::dataRefDefinitionT DATA_REFS_LT[CNT_DATAREFS_LT];

Include/InfoListWnd.h

@@ -45,9 +45,12 @@ class InfoListWnd : public LTImgWindow
     LogMsgListTy::const_iterator lastEnd;
 
     // Info/Status
+    float lastStatusUpdate = 0.0f;  ///< when last updates periodic status info?
     std::string verText;            ///< version information
     std::string aiCtrlPlugin;       ///< name of plugin controlling AI planes
-    float lastAIPluginCheck = 0.0f; ///< when last checked for AI-controlling plugin name?
+    float weatherHPA = HPA_STANDARD;///< Weather: QNH
+    std::string weatherStationId;   ///< Weather: reporting station
+    std::string weatherMETAR;       ///< Weather: full METAR
 
 public:
     /// Constructor shows the window

Include/LTADSBEx.h

@@ -34,6 +34,10 @@
 #include "LTChannel.h"
 
 //MARK: ADS-B Exchange Constants
+#define ADSBEX_CHECK_NAME       "ADSBX Radar View"
+#define ADSBEX_CHECK_URL        "https://globe.adsbexchange.com/"
+#define ADSBEX_CHECK_POPUP      "Check ADS-B Exchange's coverage"
+
 #define ADSBEX_NAME             "ADS-B Exchange Online"
 #define ADSBEX_URL              "https://adsbexchange.com/api/aircraft/json/lat/%f/lon/%f/dist/%d/"
 #define ADSBEX_API_AUTH         "api-auth:"     // additional HTTP header
@@ -55,7 +59,7 @@
 #define ADSBEX_LAT              "lat"
 #define ADSBEX_LON              "lon"
 #define ADSBEX_ELEVATION        "galt"          // geometric altitude
-// #define ADSBEX_ALT              "alt"           // barometric altitude
+#define ADSBEX_ALT              "alt"           // barometric altitude
 #define ADSBEX_HEADING          "trak"
 #define ADSBEX_GND              "gnd"
 // #define ADSBEX_IN_HG            "InHg"
@@ -116,10 +120,7 @@ class ADSBExchangeConnection : public LTOnlineChannel, LTFlightDataChannel
     keyTypeE keyTy = ADSBEX_KEY_NONE;
     struct curl_slist* slistKey = NULL;
 public:
-    ADSBExchangeConnection () :
-    LTChannel(DR_CHANNEL_ADSB_EXCHANGE_ONLINE),
-    LTOnlineChannel(),
-    LTFlightDataChannel()  {}
+    ADSBExchangeConnection ();
     virtual std::string GetURL (const positionTy& pos);
     virtual bool ProcessFetchedData (mapLTFlightDataTy& fdMap);
     virtual bool IsLiveFeed() const { return true; }

Include/LTChannel.h

@@ -54,6 +54,12 @@ class LTChannel
         CHT_MASTER_DATA,
         CHT_TRAFFIC_SENDER,         // sends out data (not receiving)
     };
+    
+public:
+    std::string urlLink;            ///< an URL related to that channel, eg. a radar view for testing coverage, or a home page
+    std::string urlName;            ///< Name for the URL, could show on link buttons
+    std::string urlPopup;           ///< more detailed text, shows eg. as popup when hovering over the link button
+    
 protected:
     dataRefsLT channel;             // id of channel (see dataRef)
 
@@ -237,6 +243,9 @@ void LTFlightDataHideAircraft();
 void LTFlightDataDisable();
 void LTFlightDataStop();
 
+/// Is at least one tracking data channel enabled?
+bool LTFlightDataAnyTrackingChEnabled ();
+
 //
 //MARK: Aircraft Maintenance (called from flight loop callback)
 //

Include/LTForeFlight.h

@@ -31,6 +31,10 @@
 // MARK: ForeFlight Constants
 //
 
+#define FF_CHECK_NAME           "ForeFlight Mobile EFB"
+#define FF_CHECK_URL            "https://foreflight.com/products/foreflight-mobile/"
+#define FF_CHECK_POPUP          "Open ForeFlight's web site about the Mobile EFB"
+
 #define FOREFLIGHT_NAME        "ForeFlight"
 #define FF_LOCALHOST            "0.0.0.0"
 constexpr size_t FF_NET_BUF_SIZE    = 512;

Include/LTImgWindow.h

@@ -106,6 +106,34 @@ IMGUI_API bool ButtonURL(const char* label,
                          ImU32 colBg = IM_COL32(1,1,1,0),
                          const ImVec2& size = ImVec2(0,0));
 
+/// @brief Selectable with handling of disabled and with tooltip
+/// @param label Text on Button
+/// @param p_selected Passes in and receives the selected state
+/// @param bEnabled Is the selectable enabled or disabled (greyed out)?
+/// @param tip Tooltip text when hovering over the button (or NULL of none)
+/// @param flags are ImGui's standard set of Selectable flags
+/// @param size button size, 0 for either axis means: auto size
+IMGUI_API bool SelectableTooltip(const char* label,
+                                 bool* p_selected,
+                                 bool bEnabled = true,
+                                 const char* tip = nullptr,
+                                 ImGuiSelectableFlags flags = 0,
+                                 const ImVec2& size = ImVec2(0, 0));
+
+/// @brief Selectable with handling of disabled and with tooltip
+/// @param label Text on Button
+/// @param bSelected Currently selected?
+/// @param bEnabled Is the selectable enabled or disabled (greyed out)?
+/// @param tip Tooltip text when hovering over the button (or NULL of none)
+/// @param flags are ImGui's standard set of Selectable flags
+/// @param size button size, 0 for either axis means: auto size
+IMGUI_API bool SelectableTooltip(const char* label,
+                                 bool bSelected,
+                                 bool bEnabled = true,
+                                 const char* tip = nullptr,
+                                 ImGuiSelectableFlags flags = 0,
+                                 const ImVec2& size = ImVec2(0, 0));
+
 /// @brief A checkbox toggling a defined integer dataRef
 /// @param label Checkbox's label
 /// @param idx Index into `DATA_REFS_LT`, defining the integer dataRef to toggle between 0 and 1. Can be -1 for an always deactivated checkbox