traffic.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
#ifndef SWIFT_SIM_XSWIFTBUS_TRAFFIC_H
#define SWIFT_SIM_XSWIFTBUS_TRAFFIC_H

 
#include <XPLM/XPLMCamera.h>
#include <XPLM/XPLMDisplay.h>
 
#include <functional>
#include <utility>
 
#include "XPMPMultiplayer.h"
#include "command.h"
#include "datarefs.h"
#include "dbusobject.h"
#include "drawable.h"
#include "menus.h"
#include "settings.h"
#include "terrainprobe.h"

#define XSWIFTBUS_TRAFFIC_INTERFACENAME "org.swift_project.xswiftbus.traffic"
#define XSWIFTBUS_TRAFFIC_OBJECTPATH "/xswiftbus/traffic"
 
namespace XSwiftBus
{
    class CTraffic : public CDBusObject
    {
    public:
        CTraffic(CSettingsProvider *settingsProvider);

        virtual ~CTraffic() override;

        static const std::string &InterfaceName()
        {
            static std::string s(XSWIFTBUS_TRAFFIC_INTERFACENAME);
            return s;
        }

        static const std::string &ObjectPath()
        {
            static std::string s(XSWIFTBUS_TRAFFIC_OBJECTPATH);
            return s;
        }

        void setPlaneViewMenu(const CMenu &planeViewSubMenu);

        bool initialize();

        bool acquireMultiplayerPlanes(std::string *owner = nullptr);

        void cleanup();

        std::string loadPlanesPackage(const std::string &path);

        static void setDefaultIcao(const std::string &defaultIcao);

        void setDrawingLabels(bool drawing, int rgb = -1);

        bool isDrawingLabels() const;

        void setMaxPlanes(int planes);

        void setMaxDrawDistance(double nauticalMiles);

        void addPlane(const std::string &callsign, const std::string &modelName, const std::string &aircraftIcao,
                      const std::string &airlineIcao, const std::string &livery);

        void removePlane(const std::string &callsign);

        void removeAllPlanes();

        void setPlanesPositions(const std::vector<std::string> &callsigns, const std::vector<double> &latitudesDeg,
                                const std::vector<double> &longitudesDeg, const std::vector<double> &altitudesFt,
                                const std::vector<double> &pitchesDeg, const std::vector<double> &rollsDeg,
                                const std::vector<double> &headingsDeg, const std::vector<bool> &onGrounds);

        void setPlanesSurfaces(const std::vector<std::string> &callsigns, const std::vector<double> &gears,
                               const std::vector<double> &flaps, const std::vector<double> &spoilers,
                               const std::vector<double> &speedBrakes, const std::vector<double> &slats,
                               const std::vector<double> &wingSweeps, const std::vector<double> &thrusts,
                               const std::vector<double> &elevators, const std::vector<double> &rudders,
                               const std::vector<double> &ailerons, const std::vector<bool> &landLights,
                               const std::vector<bool> &taxiLights, const std::vector<bool> &beaconLights,
                               const std::vector<bool> &strobeLights, const std::vector<bool> &navLights,
                               const std::vector<int> &lightPatterns);

        void setPlanesTransponders(const std::vector<std::string> &callsigns, const std::vector<int> &codes,
                                   const std::vector<bool> &modeCs, const std::vector<bool> &idents);

        void getRemoteAircraftData(std::vector<std::string> &callsigns, std::vector<double> &latitudesDeg,
                                   std::vector<double> &longitudesDeg, std::vector<double> &elevationsM,
                                   std::vector<bool> &waterFlags, std::vector<double> &verticalOffsets) const;

        std::array<double, 3> getElevationAtPosition(const std::string &callsign, double latitudeDeg,
                                                     double longitudeDeg, double altitudeMeters, bool &o_isWater) const;

        void setFollowedAircraft(const std::string &callsign);

        int process();

        static const std::string &ownAircraftString()
        {
            static const std::string o = "ownAircraft";
            return o;
        }
 
    protected:
        virtual void dbusDisconnectedHandler() override;

        DBusHandlerResult dbusMessageHandler(const CDBusMessage &message) override;
 
    private:
        struct DeltaCameraPosition
        {
            double dxMeters = 0.0;
            double dyMeters = 0.0;
            double dzMeters = 0.0;
            double headingDeg = 0.0;
            double pitchDeg = 0.0;
            bool isInitialized = false;
        };
 
        bool m_initialized = false;
        bool m_enabledMultiplayer = false;
        CTerrainProbe m_terrainProbe;
 
        void emitSimFrame();
        void emitPlaneAdded(const std::string &callsign);
        void emitPlaneAddingFailed(const std::string &callsign);
        void switchToFollowPlaneView(const std::string &callsign);
        void followNextPlane();
        void followPreviousPlane();
        bool containsCallsign(const std::string &callsign) const;
 
        static CTraffic *s_instance;
        XPMPConfiguration_t m_configuration = {};
        void updateConfiguration();
 
        static int orbitPlaneFunc(XPLMCameraPosition_t *cameraPosition, int isLosingControl, void *refcon);
        static int followAircraftKeySniffer(char character, XPLMKeyFlags flags, char virtualKey, void *refcon);

        struct Plane
        {
            void *id = nullptr;
            std::string callsign;
            std::string aircraftIcao;
            std::string airlineIcao;
            std::string livery;
            std::string modelName;
            std::string nightTextureMode;
            bool hasSurfaces = false;
            bool isOnGround = false;
            char label[32] {};
            CTerrainProbe terrainProbe;
            XPMPPlaneSurfaces_t surfaces;
            float targetGearPosition = 0;
            std::chrono::steady_clock::time_point prevSurfacesLerpTime;
            std::chrono::steady_clock::time_point positionTimes[3];
            XPMPPlanePosition_t positions[4]; // 1 as input for extrapolation, 1 as next input, 1 latest, 1 as output
            XPMPPlaneSurveillance_t surveillance;
            Plane(void *id_, const std::string &callsign_, const std::string &aircraftIcao_,
                  const std::string &airlineIcao_, const std::string &livery_, const std::string &modelName_);
        };

        class Labels : public CDrawable
        {
        public:
            Labels(CTraffic *traffic) : CDrawable(xplm_Phase_Window, false), m_traffic(traffic) {}
            void setColor(int r, int g, int b)
            {
                m_color = { { static_cast<float>(r) / 255.f, static_cast<float>(g) / 255.f,
                              static_cast<float>(b) / 255.f } };
            }
 
        protected:
            virtual void draw() override;
 
        private:
            static void matrixMultVec(double out[4], const float m[16], const double v[4]);
            double distanceSquared(const double pos[3]) const;
            CTraffic *m_traffic = nullptr;
            std::array<float, 3> m_color { { 1.0f, 0.75f, 0.0f } };
            ArrayDataRef<xplane::data::sim::graphics::view::world_matrix> m_worldMat;
            ArrayDataRef<xplane::data::sim::graphics::view::projection_matrix_3d> m_projMat;
            DataRef<xplane::data::sim::graphics::view::window_width> m_windowWidth;
            DataRef<xplane::data::sim::graphics::view::window_height> m_windowHeight;
            DataRef<xplane::data::sim::graphics::view::visibility_effective_m> m_visibilityM;
            DataRef<xplane::data::sim::graphics::view::view_x> m_viewX;
            DataRef<xplane::data::sim::graphics::view::view_y> m_viewY;
            DataRef<xplane::data::sim::graphics::view::view_z> m_viewZ;
        };
        Labels m_labels { this };

        static bool isPlusMinus180(float v);
        static bool isPlusMinus180(double v);

        static float normalizeToPlusMinus180Deg(float v);
        static double normalizeToPlusMinus180Deg(double v);
        static float normalizeToZero360Deg(float v);
        static double normalizeToZero360Deg(double v);

        static bool isValidPosition(const XPMPPlanePosition_t &position);
        static bool isValidPosition(const XPLMCameraPosition_t *camPos);

        static std::string pos2String(const XPMPPlanePosition_t &position);
        static std::string pos2String(const XPLMCameraPosition_t *camPos);
 
        std::unordered_map<std::string, std::string> m_modelStrings; // mapping uppercase to mixedcase
        std::unordered_map<std::string, Plane *> m_planesByCallsign;
        std::unordered_map<void *, Plane *> m_planesById;
        std::vector<std::string> m_followPlaneViewSequence;
        // std::chrono::system_clock::time_point m_timestampLastSimFrame = std::chrono::system_clock::now();
 
        CMenu m_followPlaneViewSubMenu;
        std::unordered_map<std::string, CMenuItem> m_followPlaneViewMenuItems;
        std::string m_followPlaneViewCallsign;
        CCommand m_followPlaneViewNextCommand;
        CCommand m_followPlaneViewPreviousCommand;
 
        DataRef<xplane::data::sim::flightmodel::position::local_x> m_ownAircraftPositionX;
        DataRef<xplane::data::sim::flightmodel::position::local_y> m_ownAircraftPositionY;
        DataRef<xplane::data::sim::flightmodel::position::local_z> m_ownAircraftPositionZ;
 
        bool m_isSpacePressed = false;
        int m_lastMouseX = -1;
        int m_lastMouseY = -1;
        double m_followAircraftDistanceMultiplier = 1.0;
        DeltaCameraPosition m_deltaCameraPosition;
 
        bool m_emitSimFrame = true;
        int m_countFrame = 0; 
 
        std::vector<XPMPUpdate_t> m_updates;
        void doPlaneUpdates();
        static void interpolatePosition(Plane *);
        void interpolateGear(Plane *);
    };
} // namespace XSwiftBus
 
#endif // SWIFT_SIM_XSWIFTBUS_TRAFFIC_H