geo/tcGlobe.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 _tcGlobe_h_
  21 #define _tcGlobe_h_
  22
  23 /**
  24  * @file tcGlobe.h
  25  * @brief Manages data for a globe.
  26  */
  27
  28 #include "tcSrtmModel.h"
  29
  30 #include <QList>
  31
  32 class tcGeo;
  33 class tcGeoImageData;
  34 class tcObserver;
  35
  36 /** Manages data for a globe.
  37  * Holds terrain elevation and imagery data.
  38  */
  39 class tcGlobe
  40 {
  41   public:
  42
  43     /*
  44      * Enumerations
  45      */
  46
  47     /// Elevation modes.
  48     enum ElevationMode
  49     {
  50       NoElevation,
  51       RawElevation,
  52       CorrectedElevation
  53     };
  54
  55     /// Colour codings.
  56     enum ColourCoding {
  57       NoColourCoding = 0,
  58       ElevationSampleAlignment
  59     };
  60
  61     /*
  62      * Constructors + destructor
  63      */
  64
  65     /// Primary constructor.
  66     tcGlobe(double meanRadius);
  67
  68     /// Destructor.
  69     virtual ~tcGlobe();
  70
  71     /*
  72      * Data sets
  73      */
  74
  75     /// Add a dataset to the globe.
  76     void addDataSet(tcGeoImageData* data);
  77
  78     /*
  79      * Rendering
  80      */
  81
  82     /// Render from the POV of an observer.
  83     void render(tcObserver* const observer, const tcGeo* extent = 0);
  84
  85     /// Set the elevation mode to render in.
  86     void setElevationMode(ElevationMode mode);
  87
  88     /// Set the level of correction to show.
  89     void setElevationCorrection(float correction);
  90
  91     /// Set the elevation data set name.
  92     void setElevationDataSet(const QString& name);
  93
  94     /// Set colour coding method.
  95     void setColourCoding(ColourCoding colourCoding);
  96
  97     /*
  98      * Accessors
  99      */
 100
 101     /// Get the mean radius.
 102     double meanRadius() const;
 103
 104     /// Get the altitude above sea level at a sample in a render state.
 105     double altitudeAt(const tcSrtmModel::RenderState& state, int x, int y, tcGeo* outCoord, bool* isAccurate = 0) const;
 106
 107     /// Get the altitude above sea level at a coordinate.
 108     double altitudeAt(const tcGeo& coord, bool* isAccurate = 0) const;
 109
 110     /// Get the radius at a coordinate.
 111     double radiusAt(const tcGeo& coord) const;
 112
 113   private:
 114
 115     /*
 116      * Rendering
 117      */
 118
 119     /// Draw a line of latitude.
 120     void drawLineOfLatitude(double latitude) const;
 121
 122     /// Render a cell.
 123     void renderCell(tcObserver* const observer, const tcGeo& swCorner, const tcGeo& neCorner, int samples,
 124                     bool northEdge = false, bool eastEdge = false, bool southEdge = false, bool westEdge = false) const;
 125
 126   private:
 127
 128     /*
 129      * Variables
 130      */
 131
 132     /// Mean radius in metres.
 133     double m_meanRadius;
 134
 135     /// Elevation model.
 136     tcSrtmModel* m_elevation;
 137
 138     /// List of geo data sets.
 139     QList<tcGeoImageData*> m_data;
 140
 141     /*
 142      * Rendering options
 143      */
 144
 145     /// Current elevation mode.
 146     ElevationMode m_elevationMode;
 147
 148     /// Current level of elevation correction.
 149     float m_elevationCorrection;
 150
 151     /// Colour coding method.
 152     ColourCoding m_colourCoding;
 153 };
 154
 155 #endif
 156