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