geo/tcGeo.h

   1 /***************************************************************************
   2  *   This file is part of Tecorrec.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   Tecorrec is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   Tecorrec is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with Tecorrec.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 #ifndef _tcGeo_h_
  21 #define _tcGeo_h_
  22
  23 /**
  24  * @file tcGeo.h
  25  * @brief Geographical coordinates.
  26  */
  27
  28 #include <Vector.h>
  29
  30 /// Use doubles for angles.
  31 typedef double tcGeoAngle;
  32
  33 /// Geographical coordinates.
  34 class tcGeo
  35 {
  36   public:
  37
  38     /*
  39      * Constructors + destructor
  40      */
  41
  42     /// Primary constructor.
  43     tcGeo()
  44     : m_longitude(0.0)
  45     , m_latitude(0.0)
  46     {
  47     }
  48
  49     /// Primary constructor.
  50     tcGeo(const tcGeoAngle lon, const tcGeoAngle lat)
  51     : m_longitude(lon)
  52     , m_latitude(lat)
  53     {
  54     }
  55
  56     /*
  57      * Conversions
  58      */
  59
  60     /// Convert to a 3d direction vector.
  61     operator maths::Vector<3,double> () const
  62     {
  63       double z = sin(m_latitude);
  64       double xy = cos(m_latitude);
  65       return maths::Vector<3,double>(xy*sin(m_longitude), xy*cos(m_longitude), z);
  66     }
  67
  68     /*
  69      * Accessors
  70      */
  71
  72     /// Get the longitude.
  73     tcGeoAngle lon() const
  74     {
  75       return m_longitude;
  76     }
  77
  78     /// Get the latitude.
  79     tcGeoAngle lat() const
  80     {
  81       return m_latitude;
  82     }
  83
  84     /*
  85      * Mutators
  86      */
  87
  88     /// Set the longitude.
  89     void setLon(const tcGeoAngle lon)
  90     {
  91       m_longitude = lon;
  92     }
  93
  94     /// Set the latitude.
  95     void setLat(const tcGeoAngle lat)
  96     {
  97       m_latitude = lat;
  98     }
  99
 100     /// Set the longitude and latitude.
 101     void setLonLat(const tcGeoAngle lon, const tcGeoAngle lat)
 102     {
 103       m_longitude = lon;
 104       m_latitude = lat;
 105     }
 106
 107   private:
 108
 109     /*
 110      * Variables
 111      */
 112
 113     /** East-West geographical coordinate.
 114      * Units are radians.
 115      */
 116     tcGeoAngle m_longitude;
 117
 118     /** North-South geographical coordinate.
 119      * Units are radians.
 120      */
 121     tcGeoAngle m_latitude;
 122
 123 };
 124
 125 #endif // _tcGeo_h_
 126