geo/tcLambertianShading.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 _tcLambertianShading_h_
  21 #define _tcLambertianShading_h_
  22
  23 /**
  24  * @file tcLambertianShading.h
  25  * @brief Shading channel using lambertian reflectance.
  26  */
  27
  28 #include "tcChannelDem.h"
  29
  30 /// Shading channel using lambertian reflectance.
  31 class tcLambertianShading : public tcChannelDem
  32 {
  33   public:
  34
  35     /*
  36      * Constructors + destructor
  37      */
  38
  39     /// Primary constructor.
  40     tcLambertianShading(tcChannel* reference, tcSrtmModel* dem, tcGeoImageData* imagery);
  41
  42     /// Primary constructor.
  43     tcLambertianShading(tcChannel* reference, tcSrtmModel* dem, tcGeoImageData* imagery, const maths::Vector<3,float>& direction);
  44
  45     /// Destructor.
  46     virtual ~tcLambertianShading();
  47
  48   protected:
  49
  50     /*
  51      * Interface for derived class to implement
  52      */
  53
  54     // Reimplemented
  55     virtual void roundPortion(double* x1, double* y1, double* x2, double* y2);
  56
  57     // Reimplemented
  58     virtual tcAbstractPixelData* loadPortion(double x1, double y1, double x2, double y2, bool changed);
  59
  60   private:
  61
  62     /*
  63      * Variables
  64      */
  65
  66     /// We'll use the same resolution as this reference channel.
  67     tcChannel* m_referenceChannel;
  68
  69     /// Whether to use a custom direction instead of the light direction.
  70     bool m_customDirectionEnabled;
  71
  72     /// What custom direction to use instead of the light direction.
  73     maths::Vector<3,float> m_customDirection;
  74 };
  75
  76 #endif