]> 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 48681cbbc46020f496b1cc0855a8dfad66c17319..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
@@ -64,185 +66,86 @@ public:
 
 //   static time_t getTimeGMT ();
 //   static void setTimeGMT (time_t time);
-  static string getDateString ();
-  static void setDateString (string time_string);
+  static string getDateString ();// ISO 8601 subset
+  static void setDateString (string time_string); // ISO 8601 subset
 
                                // deprecated
   static string getGMTString ();
 
-  static bool getHUDVisible ();
-  static void setHUDVisible (bool hudVisible);
-
-  static bool getPanelVisible ();
-  static void setPanelVisible (bool panelVisible);
-
-  static int getPanelXOffset ();
-  static void setPanelXOffset (int i);
-
-  static int getPanelYOffset ();
-  static void setPanelYOffset (int i);
-
-
                                // Position
-  static double getLatitude ();
-  static void setLatitude (double latitude);
+  static double getLatitude ();        // degrees
+  static void setLatitude (double latitude); // degrees
 
-  static double getLongitude ();
-  static void setLongitude (double longitude);
+  static double getLongitude (); // degrees
+  static void setLongitude (double longitude); // degrees
 
-  static double getAltitude ();
-  static void setAltitude (double altitude);
+  static double getAltitude ();        // feet
+  static void setAltitude (double altitude); // feet
 
-  static double getAGL ();
+  static double getAGL ();     // feet
 
 
                                // Attitude
-  static double getHeading ();   // true heading
-  static void setHeading (double heading);
+  static double getHeading ();   // degrees
+  static void setHeading (double heading); // degrees
 
-  static double getHeadingMag (); // exact magnetic heading
+  static double getHeadingMag (); // degrees
 
-  static double getPitch ();
-  static void setPitch (double pitch);
+  static double getPitch ();   // degrees
+  static void setPitch (double pitch); // degrees
 
-  static double getRoll ();
-  static void setRoll (double roll);
+  static double getRoll ();    // degrees
+  static void setRoll (double roll); // degrees
 
                                // Engine
-  static double getRPM ();
-  static void setRPM ( double rpm );
+  static double getRPM ();     // revolutions/minute
+  static void setRPM ( double rpm ); // revolutions/minute
 
-  static double getEGT ();
-  static double getCHT ();
-  static double getMP ();
+  static double getEGT ();     // [unit??]
+  static double getCHT ();     // [unit??]
+  static double getMP ();      // [unit??]
 
                                // Velocities
-  static double getAirspeed ();
-  static void setAirspeed (double speed);
+  static double getAirspeed ();        // knots
+  static void setAirspeed (double speed); // knots
 
-  static double getSideSlip ();
+  static double getSideSlip ();        // [unit??]
 
-  static double getVerticalSpeed ();
+  static double getVerticalSpeed (); // feet/second
 
-  static double getSpeedNorth ();
+  static double getSpeedNorth (); // feet/second
 
-  static double getSpeedEast ();
+  static double getSpeedEast (); // feet/second
 
-  static double getSpeedDown ();
+  static double getSpeedDown (); // feet/second
 
 //   static void setSpeedNorth (double speed);
 //   static void setSpeedEast (double speed);
 //   static void setSpeedDown (double speed);
 
 
-                               // Controls
-  static double getThrottle ();
-  static void setThrottle (double throttle);
-
-  static double getMixture ();
-  static void setMixture (double mixture);
-
-  static double getPropAdvance ();
-  static void setPropAdvance (double pitch);
-
-  static double getFlaps ();
-  static void setFlaps (double flaps);
-
-  static double getAileron ();
-  static void setAileron (double aileron);
-
-  static double getRudder ();
-  static void setRudder (double rudder);
-
-  static double getElevator ();
-  static void setElevator (double elevator);
-
-  static double getElevatorTrim ();
-  static void setElevatorTrim (double trim);
-
-  static double getBrakes ();
-  static void setBrakes (double brake);
-
-  static double getLeftBrake ();
-  static void setLeftBrake (double brake);
-
-  static double getRightBrake ();
-  static void setRightBrake (double brake);
-
-  static double getCenterBrake ();
-  static void setCenterBrake (double brake);
-
-
                                // Autopilot
   static bool getAPAltitudeLock ();
   static void setAPAltitudeLock (bool lock);
 
-  static double getAPAltitude ();
-  static void setAPAltitude (double altitude);
+  static double getAPAltitude (); // feet
+  static void setAPAltitude (double altitude); // feet
 
   static bool getAPHeadingLock ();
   static void setAPHeadingLock (bool lock);
 
-  static double getAPHeading ();
-  static void setAPHeading (double heading);
+  static double getAPHeading (); // degrees
+  static void setAPHeading (double heading); // degrees
+
+  static double getAPHeadingDG (); // degrees
+  static void setAPHeadingDG (double heading); // degrees
 
-  static double getAPHeadingMag ();
-  static void setAPHeadingMag (double heading);
+  static double getAPHeadingMag (); // degrees
+  static void setAPHeadingMag (double heading);        // degrees
 
   static bool getAPNAV1Lock ();
   static void setAPNAV1Lock (bool lock);
 
-                               // Radio Navigation
-  static double getNAV1Freq ();
-  static void setNAV1Freq (double freq);
-
-  static double getNAV1AltFreq ();
-  static void setNAV1AltFreq (double freq);
-
-  static double getNAV1Radial ();
-
-  static double getNAV1SelRadial ();
-  static void setNAV1SelRadial (double radial);
-
-  static double getNAV1DistDME ();
-
-  static bool getNAV1TO ();
-
-  static bool getNAV1FROM ();
-
-  static bool getNAV1InRange ();
-
-  static bool getNAV1DMEInRange ();
-
-  static double getNAV2Freq ();
-  static void setNAV2Freq (double freq);
-
-  static double getNAV2AltFreq ();
-  static void setNAV2AltFreq (double freq);
-
-  static double getNAV2Radial ();
-
-  static double getNAV2SelRadial ();
-  static void setNAV2SelRadial (double radial);
-
-  static double getNAV2DistDME ();
-
-  static bool getNAV2TO ();
-
-  static bool getNAV2FROM ();
-
-  static bool getNAV2InRange ();
-
-  static bool getNAV2DMEInRange ();
-
-  static double getADFFreq ();
-  static void setADFFreq (double freq);
-
-  static double getADFAltFreq ();
-  static void setADFAltFreq (double freq);
-
-  static double getADFRotation ();
-  static void setADFRotation (double rot);
 
                                // GPS
   static string getTargetAirport ();
@@ -251,26 +154,31 @@ public:
   static bool getGPSLock ();
   static void setGPSLock (bool lock);
 
-  static double getGPSTargetLatitude ();
+  static double getGPSTargetLatitude (); // degrees
 
-  static double getGPSTargetLongitude ();
+  static double getGPSTargetLongitude (); // degrees
 
 
                                // Weather
-  static double getVisibility ();
-  static void setVisibility (double visiblity);
-  static double getWindNorth ();
-  static double getWindEast ();
-  static double getWindDown ();
+  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 void setViewAxisLong (double axis);
-  static void setViewAxisLat (double axis);
+  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: