]> git.mxchange.org Git - flightgear.git/blobdiff - src/Main/bfi.hxx
Added support for managing fov via the property manager so the --fov= option
[flightgear.git] / src / Main / bfi.hxx
index 759f6d5244a833cc518d79a933ec341fe28c875d..dc2bd2f91ac847acd42bf58f0e5a85e11a07e8f0 100644 (file)
@@ -4,6 +4,8 @@
 //
 // Copyright (C) 2000  David Megginson - david@megginson.com
 //
+// THIS INTERFACE IS DEPRECATED; USE THE PROPERTY MANAGER INSTEAD.
+//
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU General Public License as
 // published by the Free Software Foundation; either version 2 of the
@@ -46,154 +48,143 @@ class FGBFI
 {
 public:
 
+                               // Initialize before first use.
+  static void init ();
+
                                // Reinit if necessary.
   static void update ();
 
                                // Simulation
   static int getFlightModel ();
-  static const string getAircraft ();
-  static const string getAircraftDir ();
-  static time_t getTimeGMT ();
-  static bool getHUDVisible ();
-  static bool getPanelVisible ();
-
   static void setFlightModel (int flightModel);
-  static void setAircraft (const string &aircraft);
-  static void setAircraftDir (const string &aircraftDir);
-  static void setTimeGMT (time_t time);
-  static void setHUDVisible (bool hudVisible);
-  static void setPanelVisible (bool panelVisible);
 
+  static string getAircraft ();
+  static void setAircraft (string aircraft);
+
+  static string getAircraftDir ();
+  static void setAircraftDir (string aircraftDir);
+
+//   static time_t getTimeGMT ();
+//   static void setTimeGMT (time_t time);
+  static string getDateString ();// ISO 8601 subset
+  static void setDateString (string time_string); // ISO 8601 subset
+
+                               // deprecated
+  static string getGMTString ();
 
                                // Position
-  static double getLatitude ();
-  static double getLongitude ();
-  static double getAltitude ();
-  static double getAGL ();
+  static double getLatitude ();        // degrees
+  static void setLatitude (double latitude); // degrees
+
+  static double getLongitude (); // degrees
+  static void setLongitude (double longitude); // degrees
+
+  static double getAltitude ();        // feet
+  static void setAltitude (double altitude); // feet
 
-  static void setLatitude (double latitude);
-  static void setLongitude (double longitude);
-  static void setAltitude (double altitude);
+  static double getAGL ();     // feet
 
 
                                // Attitude
-  static double getHeading ();
-  static double getPitch ();
-  static double getRoll ();
+  static double getHeading ();   // degrees
+  static void setHeading (double heading); // degrees
 
-  static void setHeading (double heading);
-  static void setPitch (double pitch);
-  static void setRoll (double roll);
+  static double getHeadingMag (); // degrees
 
+  static double getPitch ();   // degrees
+  static void setPitch (double pitch); // degrees
+
+  static double getRoll ();    // degrees
+  static void setRoll (double roll); // degrees
+
+                               // Engine
+  static double getRPM ();     // revolutions/minute
+  static void setRPM ( double rpm ); // revolutions/minute
+
+  static double getEGT ();     // [unit??]
+  static double getCHT ();     // [unit??]
+  static double getMP ();      // [unit??]
 
                                // Velocities
-  static double getAirspeed ();
-  static double getSideSlip ();
-  static double getVerticalSpeed ();
-  static double getSpeedNorth ();
-  static double getSpeedEast ();
-  static double getSpeedDown ();
-
-  static void setSpeedNorth (double speed);
-  static void setSpeedEast (double speed);
-  static void setSpeedDown (double speed);
-
-
-                               // Controls
-  static double getThrottle ();
-  static double getFlaps ();
-  static double getAileron ();
-  static double getRudder ();
-  static double getElevator ();
-  static double getElevatorTrim ();
-  static double getBrake ();
-
-  static void setThrottle (double throttle);
-  static void setFlaps (double flaps);
-  static void setAileron (double aileron);
-  static void setRudder (double rudder);
-  static void setElevator (double elevator);
-  static void setElevatorTrim (double trim);
-  static void setBrake (double brake);
+  static double getAirspeed ();        // knots
+  static void setAirspeed (double speed); // knots
+
+  static double getSideSlip ();        // [unit??]
+
+  static double getVerticalSpeed (); // feet/second
+
+  static double getSpeedNorth (); // feet/second
+
+  static double getSpeedEast (); // feet/second
+
+  static double getSpeedDown (); // feet/second
+
+//   static void setSpeedNorth (double speed);
+//   static void setSpeedEast (double speed);
+//   static void setSpeedDown (double speed);
 
 
                                // Autopilot
   static bool getAPAltitudeLock ();
-  static double getAPAltitude ();
-  static bool getAPHeadingLock ();
-  static double getAPHeadingMag ();
-
   static void setAPAltitudeLock (bool lock);
-  static void setAPAltitude (double altitude);
-  static void setAPHeadingLock (bool lock);
-  static void setAPHeadingMag (double heading);
 
-  static bool getAPNAV1Lock ();
-  static void setAPNAV1Lock (bool lock);
+  static double getAPAltitude (); // feet
+  static void setAPAltitude (double altitude); // feet
 
-                               // Radio Navigation
-  static double getNAV1Freq ();
-  static double getNAV1AltFreq ();
-  static double getNAV1Radial ();
-  static double getNAV1SelRadial ();
-  static double getNAV1DistDME ();
+  static bool getAPHeadingLock ();
+  static void setAPHeadingLock (bool lock);
 
-  static double getNAV2Freq ();
-  static double getNAV2AltFreq ();
-  static double getNAV2Radial ();
-  static double getNAV2SelRadial ();
-  static double getNAV2DistDME ();
+  static double getAPHeading (); // degrees
+  static void setAPHeading (double heading); // degrees
 
-  static double getADFFreq ();
-  static double getADFAltFreq ();
-  static double getADFRotation ();
+  static double getAPHeadingDG (); // degrees
+  static void setAPHeadingDG (double heading); // degrees
 
-  static void setNAV1Freq (double freq);
-  static void setNAV1AltFreq (double freq);
-  static void setNAV1SelRadial (double radial);
+  static double getAPHeadingMag (); // degrees
+  static void setAPHeadingMag (double heading);        // degrees
 
-  static void setNAV2Freq (double freq);
-  static void setNAV2AltFreq (double freq);
-  static void setNAV2SelRadial (double radial);
+  static bool getAPNAV1Lock ();
+  static void setAPNAV1Lock (bool lock);
 
-  static void setADFFreq (double freq);
-  static void setADFAltFreq (double freq);
-  static void setADFRotation (double rot);
 
                                // GPS
-  static const string getTargetAirport ();
-  static bool getGPSLock ();
-  static double getGPSTargetLatitude ();
-  static double getGPSTargetLongitude ();
+  static string getTargetAirport ();
+  static void setTargetAirport (string targetAirport);
 
-  static void setTargetAirport (const string &targetAirport);
+  static bool getGPSLock ();
   static void setGPSLock (bool lock);
-  static void setGPSTargetLatitude (double latitude);
-  static void setGPSTargetLongitude (double longitude);
 
+  static double getGPSTargetLatitude (); // degrees
+
+  static double getGPSTargetLongitude (); // degrees
 
-                               // Weather
-  static double getVisibility ();
-  static bool getClouds ();
-  static double getCloudsASL ();
 
-  static void setVisibility (double visiblity);
-  static void setClouds (bool clouds);
-  static void setCloudsASL (double cloudsASL);
+                               // Weather
+  static double getVisibility ();// meters
+  static void setVisibility (double visiblity);        // meters
+  static double getWindNorth (); // feet/second
+  static void setWindNorth (double speed); // feet/second
+  static double getWindEast ();        // feet/second
+  static void setWindEast (double speed); // feet/second
+  static double getWindDown ();        // feet/second
+  static void setWindDown (double speed); // feet/second
+
+                               // View
+  static double getFOV ();     // degrees
+  static void setFOV (double fov); // degrees
+  static void setViewAxisLong (double axis);// -1.0:1.0
+  static void setViewAxisLat (double axis); // -1.0:1.0
 
 
                                 // Time (this varies with time) huh, huh
-  static double getMagVar (); 
-  static double getMagDip (); 
+  static double getMagVar ();  // degrees
+  static double getMagDip ();  // degrees
 
 
 private:
                                // Will cause a linking error if invoked.
   FGBFI ();
 
-  static void reinit ();
-  static void needReinit () { _needReinit = true; }
-  static bool _needReinit;
 };
 
 // end of bfi.hxx