Merge branch 'timoore/effects-anim-rebase' into next

[simgear.git] / simgear / math / SGGeod.hxx

diff --git a/simgear/math/SGGeod.hxx b/simgear/math/SGGeod.hxx
index e89cd4da60aef502a0b99e6880d5c855648c03fe..a7153334d5d78fe0e9061bde320270179279bfe4 100644 (file)
--- a/simgear/math/SGGeod.hxx
+++ b/simgear/math/SGGeod.hxx
@@ -1,8 +1,29 @@
+// Copyright (C) 2006  Mathias Froehlich - Mathias.Froehlich@web.de
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Library General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+//
+
 #ifndef SGGeod_H
 #define SGGeod_H
 
 #include <simgear/constants.h>
 
+#ifndef NO_OPENSCENEGRAPH_INTERFACE
+#include <osg/Matrix>
+#endif
+
 // #define SG_GEOD_NATIVE_DEGREE
 
 /// Class representing a geodetic location
@@ -10,12 +31,6 @@ class SGGeod {
 public:
   /// Default constructor, initializes the instance to lat = lon = elev = 0
   SGGeod(void);
-  /// Initialize from a cartesian vector assumed to be in meters
-  /// Note that this conversion is relatively expensive to compute
-  SGGeod(const SGVec3<double>& cart);
-  /// Initialize from a geocentric position
-  /// Note that this conversion is relatively expensive to compute
-  SGGeod(const SGGeoc& geoc);
 
   /// Factory from angular values in radians and elevation is 0
   static SGGeod fromRad(double lon, double lat);
@@ -29,6 +44,17 @@ public:
   static SGGeod fromRadM(double lon, double lat, double elevation);
   /// Factory from angular values in degrees and elevation in m
   static SGGeod fromDegM(double lon, double lat, double elevation);
+  /// Factory from an other SGGeod and a different elevation in m
+  static SGGeod fromGeodM(const SGGeod& geod, double elevation);
+  /// Factory from an other SGGeod and a different elevation in ft
+  static SGGeod fromGeodFt(const SGGeod& geod, double elevation);
+  /// Factory to convert position from a cartesian position assumed to be
+  /// in wgs84 measured in meters
+  /// Note that this conversion is relatively expensive to compute
+  static SGGeod fromCart(const SGVec3<double>& cart);
+  /// Factory to convert position from a geocentric position
+  /// Note that this conversion is relatively expensive to compute
+  static SGGeod fromGeoc(const SGGeoc& geoc);
 
   /// Return the geodetic longitude in radians
   double getLongitudeRad(void) const;
@@ -60,13 +86,30 @@ public:
   /// Set the geodetic elevation from the argument given in feet
   void setElevationFt(double elevation);
 
+  // Compare two geodetic positions for equality
+  bool operator == ( const SGGeod & other ) const;
+
+#ifndef NO_OPENSCENEGRAPH_INTERFACE
+  // Create a local coordinate frame in the earth-centered frame of
+  // reference. X points north, Z points down.
+  // makeSimulationFrameRelative() only includes rotation.
+  osg::Matrix makeSimulationFrameRelative() const;
+  osg::Matrix makeSimulationFrame() const;
+
+  // Create a Z-up local coordinate frame in the earth-centered frame
+  // of reference. This is what scenery models, etc. expect.
+  // makeZUpFrameRelative() only includes rotation.
+  osg::Matrix makeZUpFrameRelative() const;
+  osg::Matrix makeZUpFrame() const;
+#endif
 private:
   /// This one is private since construction is not unique if you do
   /// not know the units of the arguments. Use the factory methods for
   /// that purpose
   SGGeod(double lon, double lat, double elevation);
 
-  /// The actual data, angles in degree, elevation in meters
+  //// FIXME: wrong comment!
+  /// The actual data, angles in degrees, elevation in meters
   /// The rationale for storing the values in degrees is that most code places
   /// in flightgear/terragear use degrees as a nativ input and output value.
   /// The places where it makes sense to use radians is when we convert
@@ -90,20 +133,6 @@ SGGeod::SGGeod(double lon, double lat, double elevation) :
 {
 }
 
-inline
-SGGeod::SGGeod(const SGVec3<double>& cart)
-{
-  SGGeodesy::SGCartToGeod(cart, *this);
-}
-
-inline
-SGGeod::SGGeod(const SGGeoc& geoc)
-{
-  SGVec3<double> cart;
-  SGGeodesy::SGGeocToCart(geoc, cart);
-  SGGeodesy::SGCartToGeod(cart, *this);
-}
-
 inline
 SGGeod
 SGGeod::fromRad(double lon, double lat)
@@ -174,6 +203,40 @@ SGGeod::fromDegM(double lon, double lat, double elevation)
 #endif
 }
 
+inline
+SGGeod
+SGGeod::fromGeodM(const SGGeod& geod, double elevation)
+{
+  return SGGeod(geod._lon, geod._lat, elevation);
+}
+
+inline
+SGGeod
+SGGeod::fromGeodFt(const SGGeod& geod, double elevation)
+{
+  return SGGeod(geod._lon, geod._lat, elevation*SG_FEET_TO_METER);
+}
+
+inline
+SGGeod
+SGGeod::fromCart(const SGVec3<double>& cart)
+{
+  SGGeod geod;
+  SGGeodesy::SGCartToGeod(cart, geod);
+  return geod;
+}
+
+inline
+SGGeod
+SGGeod::fromGeoc(const SGGeoc& geoc)
+{
+  SGVec3<double> cart;
+  SGGeodesy::SGGeocToCart(geoc, cart);
+  SGGeod geod;
+  SGGeodesy::SGCartToGeod(cart, geod);
+  return geod;
+}
+
 inline
 double
 SGGeod::getLongitudeRad(void) const
@@ -290,6 +353,15 @@ SGGeod::setElevationFt(double elevation)
   _elevation = elevation*SG_FEET_TO_METER;
 }
 
+inline
+bool
+SGGeod::operator == ( const SGGeod & other ) const
+{
+  return _lon == other._lon &&
+         _lat == other._lat &&
+         _elevation == other._elevation;
+}
+
 /// Output to an ostream
 template<typename char_type, typename traits_type>
 inline