geo/tcChannel.cpp

   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 /**
  21  * @file tcChannel.cpp
  22  * @brief A single abstract image channel.
  23  */
  24
  25 #include "tcChannel.h"
  26
  27 /*
  28  * Static variables
  29  */
  30
  31 /// Current processing step.
  32 QString tcChannel::s_processingStep;
  33
  34 /// Last progress percent.
  35 int tcChannel::s_processingLastPercent;
  36
  37 /*
  38  * Constructors + destructor
  39  */
  40
  41 /// Primary constructor.
  42 tcChannel::tcChannel(const QString& name, const QString& description)
  43 : m_channelManager(0)
  44 , m_name(name)
  45 , m_description(description)
  46 , m_radianceOffset(0.0f)
  47 , m_radianceGain(1.0f)
  48 {
  49 }
  50
  51 /// Destructor.
  52 tcChannel::~tcChannel()
  53 {
  54 }
  55
  56 /*
  57  * Metadata
  58  */
  59
  60 /// Get the channel manager.
  61 tcChannelManager* tcChannel::channelManager() const
  62 {
  63   return m_channelManager;
  64 }
  65
  66 /// Set the channel manager.
  67 void tcChannel::setChannelManager(tcChannelManager* channelManager)
  68 {
  69   m_channelManager = channelManager;
  70 }
  71
  72 /// Get the channel name.
  73 const QString& tcChannel::name() const
  74 {
  75   return m_name;
  76 }
  77
  78 /// Get the channel description;
  79 const QString& tcChannel::description() const
  80 {
  81   return m_description;
  82 }
  83
  84 /// Set the channel name.
  85 void tcChannel::setName(const QString& name)
  86 {
  87   m_name = name;
  88 }
  89
  90 /// Set the channel description.
  91 void tcChannel::setDescription(const QString& description)
  92 {
  93   m_description = description;
  94 }
  95
  96 /// Set radiance offset and gain.
  97 void tcChannel::setRadianceTransform(float offset, float gain)
  98 {
  99   m_radianceOffset = offset;
 100   m_radianceGain = gain;
 101 }
 102
 103 /*
 104  * Dependencies
 105  */
 106
 107 /// Add derivitive of this channel.
 108 void tcChannel::addDerivitive(tcChannel* derivitive)
 109 {
 110   m_derivitives += derivitive;
 111 }
 112
 113 /// Remove a derivitive of this channel.
 114 void tcChannel::removeDerivitive(tcChannel* derivitive)
 115 {
 116   m_derivitives.removeOne(derivitive);
 117 }
 118
 119 /*
 120  * Main image interface
 121  */
 122
 123 /// Get configuration widget.
 124 tcChannelConfigWidget* tcChannel::configWidget()
 125 {
 126   return 0;
 127 }
 128
 129 /// Get GL texture ID of thumbnail of the channel.
 130 GLuint tcChannel::thumbnailTexture()
 131 {
 132   return 0;
 133 }
 134
 135 /// Get a reference to the pixel data of the current portion of the image.
 136 Reference<tcAbstractPixelData> tcChannel::portion() const
 137 {
 138   return m_portion;
 139 }
 140
 141 /// Get a reference to the pixel data of a portion of the image.
 142 Reference<tcAbstractPixelData> tcChannel::portion(double* x1, double* y1, double* x2, double* y2)
 143 {
 144   // If the portion is out of date, remove it
 145   roundPortion(x1,y1,x2,y2);
 146   bool changed = false;
 147   if (0 != m_portion)
 148   {
 149     if (m_portionPosition[0][0] != *x1 ||
 150         m_portionPosition[0][1] != *y1 ||
 151         m_portionPosition[1][0] != *x2 ||
 152         m_portionPosition[1][1] != *y2)
 153     {
 154       m_portion = 0;
 155       changed = true;
 156     }
 157   }
 158   m_portionPosition[0][0] = *x1;
 159   m_portionPosition[0][1] = *y1;
 160   m_portionPosition[1][0] = *x2;
 161   m_portionPosition[1][1] = *y2;
 162   // Create the new portion
 163   if (0 == m_portion)
 164   {
 165     m_portion = loadPortion(*x1,*y1,*x2,*y2, changed);
 166   }
 167   return m_portion;
 168 }
 169
 170 /// Get a reference to the pixel data of a portion of the image.
 171 Reference<tcAbstractPixelData> tcChannel::portion(double x1, double y1, double x2, double y2)
 172 {
 173   return portion(&x1, &y1, &x2, &y2);
 174 }
 175
 176 /// Get GL texture ID of portion of the channel.
 177 GLuint tcChannel::portionTexture(double* x1, double* y1, double* x2, double* y2)
 178 {
 179   Reference<tcAbstractPixelData> data = portion(x1,y1,x2,y2);
 180   if (0 != data)
 181   {
 182     return data->texture();
 183   }
 184   else
 185   {
 186     return 0;
 187   }
 188 }
 189
 190 /*
 191  * Interface for derived classes
 192  */
 193
 194 /// Invalidate this channel.
 195 void tcChannel::invalidate()
 196 {
 197   m_portion = 0;
 198   foreach (tcChannel* derivitive, m_derivitives)
 199   {
 200     derivitive->invalidate();
 201   }
 202 }
 203
 204 /*
 205  * Progress functions
 206  */
 207
 208 /// Start a processing step.
 209 void tcChannel::startProcessing(const QString& step)
 210 {
 211   if (step.isEmpty())
 212   {
 213     s_processingStep = step;
 214   }
 215   else
 216   {
 217     s_processingStep = step + ": ";
 218   }
 219   s_processingLastPercent = -1;
 220   emit progressing(tr("%1: %2").arg(name()).arg(s_processingStep));
 221 }
 222
 223 /// Update progress.
 224 void tcChannel::progress(float progress)
 225 {
 226   int percent = progress*100.0f;
 227   if (percent != s_processingLastPercent)
 228   {
 229     s_processingLastPercent = percent;
 230     emit progressing(tr("%1: %2%3%").arg(name()).arg(s_processingStep).arg(percent));
 231   }
 232 }
 233
 234 /// Update progress.
 235 void tcChannel::progress(const QString& info)
 236 {
 237   emit progressing(tr("%1: %2%3").arg(name()).arg(s_processingStep).arg(info));
 238 }
 239
 240 /// End processing step.
 241 void tcChannel::endProcessing()
 242 {
 243   emit progressing(tr("%1: %2Complete").arg(name()).arg(s_processingStep));
 244 }