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 #include <Vector.h>
  30
  31 #include <QObject>
  32
  33 class tcSrtmCache;
  34
  35 class QString;
  36
  37 /// SRTM elevation model.
  38 class tcSrtmModel : public QObject
  39 {
  40     Q_OBJECT
  41
  42   public:
  43
  44     /*
  45      * Types
  46      */
  47
  48     /// Render state.
  49     class RenderState
  50     {
  51       public:
  52
  53         /// Number of longitudenal samples in the tile.
  54         int samplesLon;
  55
  56         /// Number of latitudenal samples in the tile.
  57         int samplesLat;
  58
  59         /// Is there more detail available longitudely.
  60         bool moreAvailableLon;
  61
  62         /// Is there more detail available latitudely
  63         bool moreAvailableLat;
  64
  65       private:
  66         friend class tcSrtmModel;
  67
  68         /// South west corner of tile.
  69         tcGeo swCorner;
  70
  71         /// North east corner of tile.
  72         tcGeo neCorner;
  73
  74         /// Coordinate of most south westly sample inside tile.
  75         tcGeo swSample;
  76
  77         /// Diagonal angles between samples.
  78         tcGeo sampleDelta;
  79     };
  80
  81     /*
  82      * Constructors + destructor
  83      */
  84
  85     /// Default constructor.
  86     tcSrtmModel();
  87
  88     /// Destructor.
  89     virtual ~tcSrtmModel();
  90
  91     /*
  92      * Main interface
  93      */
  94
  95     /** Get information to allow alignment with actual samples.
  96      * @param swCorner South West corner of tile.
  97      * @param neCorner North East corner of tile.
  98      * @param state[out] Gets various information put into it to allow optimized rendering.
  99      * @param maxSamples Maximum number of inner samples.
 100      */
 101     void sampleAlign(const tcGeo& swCorner, const tcGeo& neCorner, RenderState* state, int maxSamples = 0);
 102
 103     /// Get the altitude at a sample in a render state.
 104     double altitudeAt(const RenderState& state, int x, int y, tcGeo* outCoord, bool corrected = false, bool* accurate = 0);
 105
 106     /// Get the altitude at a coordinate.
 107     double altitudeAt(const tcGeo& coord, bool corrected = false, bool* accurate = 0);
 108
 109     /// Get the normal at a coordinate.
 110     maths::Vector<3,float> normalAt(const tcGeo& coord, bool corrected = false, bool* accurate = 0);
 111
 112     /// Use raytracing to find whether a point is lit.
 113     bool isLitAt(const tcGeo& coord, const maths::Vector<3,float>& light, bool corrected = false, bool* accurate = 0);
 114
 115     /// Use raytracing to find how lit a point is.
 116     float litAt(const tcGeo& coord, const maths::Vector<3,float>& light, float angularRadius = 0.0f, bool corrected = false, bool* accurate = 0);
 117
 118     /// Set the data set to use.
 119     void setDataSet(const QString& name);
 120
 121   signals:
 122
 123     /*
 124      * Signals
 125      */
 126
 127     /// Emitted when the dataset is changed.
 128     void dataSetChanged();
 129
 130     /// Progress notifier.
 131     void progressing(const QString& progress);
 132
 133   private:
 134
 135     /*
 136      * Variables
 137      */
 138
 139     /// SRTM cache.
 140     tcSrtmCache* m_cache;
 141
 142 };
 143
 144 #endif
 145