geo/tcSrtmModel.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 _tcSrtmModel_h_
  21 #define _tcSrtmModel_h_
  22
  23 /**
  24  * @file tcSrtmModel.h
  25  * @brief SRTM elevation model.
  26  */
  27
  28 #include "tcGeo.h"
  29
  30 class tcSrtmCache;
  31
  32 class QString;
  33
  34 /// SRTM elevation model.
  35 class tcSrtmModel
  36 {
  37   public:
  38
  39     /*
  40      * Types
  41      */
  42
  43     /// Render state.
  44     class RenderState
  45     {
  46       public:
  47
  48         /// Number of longitudenal samples in the tile.
  49         int samplesLon;
  50
  51         /// Number of latitudenal samples in the tile.
  52         int samplesLat;
  53
  54         /// Is there more detail available longitudely.
  55         bool moreAvailableLon;
  56
  57         /// Is there more detail available latitudely
  58         bool moreAvailableLat;
  59
  60       private:
  61         friend class tcSrtmModel;
  62
  63         /// South west corner of tile.
  64         tcGeo swCorner;
  65
  66         /// North east corner of tile.
  67         tcGeo neCorner;
  68
  69         /// Coordinate of most south westly sample inside tile.
  70         tcGeo swSample;
  71
  72         /// Diagonal angles between samples.
  73         tcGeo sampleDelta;
  74     };
  75
  76     /*
  77      * Constructors + destructor
  78      */
  79
  80     /// Default constructor.
  81     tcSrtmModel();
  82
  83     /// Destructor.
  84     virtual ~tcSrtmModel();
  85
  86     /*
  87      * Main interface
  88      */
  89
  90     /** Get information to allow alignment with actual samples.
  91      * @param swCorner South West corner of tile.
  92      * @param neCorner North East corner of tile.
  93      * @param state[out] Gets various information put into it to allow optimized rendering.
  94      * @param maxSamples Maximum number of inner samples.
  95      */
  96     void sampleAlign(const tcGeo& swCorner, const tcGeo& neCorner, RenderState* state, int maxSamples = 0);
  97
  98     /// Get the altitude at a sample in a render state.
  99     double altitudeAt(const RenderState& state, int x, int y, tcGeo* outCoord, bool corrected = false, bool* accurate = 0);
 100
 101     /// Get the altitude at a coordinate.
 102     double altitudeAt(const tcGeo& coord, bool corrected = false, bool* accurate = 0);
 103
 104     /// Set the data set to use.
 105     void setDataSet(const QString& name);
 106
 107   private:
 108
 109     /*
 110      * Variables
 111      */
 112
 113     /// SRTM cache.
 114     tcSrtmCache* m_cache;
 115
 116 };
 117
 118 #endif
 119