geo/tcChannelDem.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 _tcChannelDem_h_
  21 #define _tcChannelDem_h_
  22
  23 /**
  24  * @file tcChannelDem.h
  25  * @brief An abstract image channel which needs access to the digital elevation model.
  26  */
  27
  28 #include "tcChannel.h"
  29 #include "tcGeo.h"
  30 #include <Vector.h>
  31
  32 class tcSrtmModel;
  33 class tcGeoImageData;
  34
  35 /// An abstract image channel which needs access to the digital elevation model.
  36 class tcChannelDem : public tcChannel
  37 {
  38   public:
  39
  40     /*
  41      * Constructors + destructor
  42      */
  43
  44     /// Primary constructor.
  45     tcChannelDem(tcSrtmModel* dem, tcGeoImageData* imagery, const QString& name, const QString& description, bool depend1 = true, bool depend2 = false);
  46
  47     /// Destructor.
  48     virtual ~tcChannelDem();
  49
  50   protected:
  51
  52     /*
  53      * Interface for derived classes to access elevation model data
  54      */
  55
  56     // Main transformation
  57
  58     /// Get the geographical coordinate at a pixel.
  59     tcGeo geoAt(const maths::Vector<2,float>& textureCoordinate, tcGeoImageData* imagery = 0) const;
  60
  61     /// Get the texture coordinate at a geographical coordinate.
  62     maths::Vector<2,float> textureAt(const tcGeo& geoCoordinate, tcGeoImageData* imagery = 0) const;
  63
  64     // Wrapper functions
  65
  66     /// Get the altitude at a geographical coordinate.
  67     float altitudeAt(const tcGeo& coordinate, bool corrected = false, bool* accurate = 0) const;
  68
  69     /// Get the texture-space normal vector at a geographical coordinate.
  70     maths::Vector<3,float> normalAt(const tcGeo& coordinate, bool corrected = false, bool* accurate = 0) const;
  71
  72     /// Get the lighting direction vector at a geographical coordinate.
  73     maths::Vector<3,float> lightDirectionAt(const tcGeo& coordinate, tcGeoImageData* imagery = 0) const;
  74
  75     /// Find whether a point is lit by the light.
  76     bool isLitAt(const tcGeo& coordinate, bool corrected = false, bool* accurate = 0, tcGeoImageData* imagery = 0) const;
  77
  78     /// Find how lit a point is by the light.
  79     float litAt(const tcGeo& coordinate, bool corrected = false, bool* accurate = 0, tcGeoImageData* imagery = 0) const;
  80
  81     // Lower level accessors
  82
  83     /// Get the digital elevation model.
  84     tcSrtmModel* dem() const;
  85
  86     /// Get the imagery.
  87     tcGeoImageData* imagery() const;
  88
  89   private:
  90
  91     /*
  92      * Variables
  93      */
  94
  95     /// Digital elevation model.
  96     tcSrtmModel* m_dem;
  97
  98     /// Imagery object.
  99     tcGeoImageData* m_imagery;
 100 };
 101
 102 #endif