qgsrastershader.cpp

一个非常好的GIS开源新版本

/* **************************************************************************
                qgsrastershader.cpp -  description
                       -------------------
begin                : Fri Dec 28 2007
copyright            : (C) 2007 by Peter J. Ersts
email                : [e-mail]

****************************************************************************/

/* **************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#include "qgslogger.h"

#include "qgsrastershader.h"

QgsRasterShader::QgsRasterShader(double theMinimumValue, double theMaximumValue)
{
#ifdef QGISDEBUG
      QgsDebugMsg("QgsRasterShader::QgsRasterShader called");
#endif
  mMinimumValue = theMinimumValue;
  mMaximumValue = theMaximumValue;
  mRasterShaderFunction = new QgsRasterShaderFunction(mMinimumValue, mMaximumValue);
}

QgsRasterShader::~QgsRasterShader()
{
}

/** 
  Generates and new RGB value based on one input value
  
  @param theValue The original value to base a new RGB value on
  @param theReturnRedValue  The red component of the new RGB value
  @param theReturnGreenValue  The green component of the new RGB value
  @param theReturnBlueValue  The blue component of the new RGB value
  @return True if the return values are valid otherwise false
*/
bool QgsRasterShader::generateShadedValue(double theValue, int* theReturnRedValue, int* theReturnGreenValue, int* theReturnBlueValue)
{
  if(0 != mRasterShaderFunction)
  {
    return mRasterShaderFunction->generateShadedValue(theValue, theReturnRedValue, theReturnGreenValue, theReturnBlueValue);
  }
  
  return false;
}
/** 
  Generates and new RGB value based on an original RGB value
  
    
  @param theRedValue The red component of the original value to base a new RGB value on
  @param theGreenValue The green component of the original value to base a new RGB value on
  @param theBlueValue The blue component of the original value to base a new RGB value on
  @param theReturnRedValue  The red component of the new RGB value
  @param theReturnGreenValue  The green component of the new RGB value
  @param theReturnBlueValue  The blue component of the new RGB value
  @return True if the return values are valid otherwise false
*/
bool QgsRasterShader::generateShadedValue(double theRedValue, double theGreenValue, double theBlueValue, int* theReturnRedValue, int* theReturnGreenValue, int* theReturnBlueValue)
{
  if(0 != mRasterShaderFunction)
  {
    return mRasterShaderFunction->generateShadedValue(theRedValue, theGreenValue, theBlueValue, theReturnRedValue, theReturnGreenValue, theReturnBlueValue);
  }
  
  return false;
}

/**
    A public function that allows the user to set their own custom shader function. 
    
    @param theFunction A pointer to the new raster shader function
*/
void QgsRasterShader::setRasterShaderFunction(QgsRasterShaderFunction* theFunction)
{
#ifdef QGISDEBUG
      QgsDebugMsg("QgsRasterShader::setRasterShaderFunction called");
#endif
  if(0 != theFunction)
  {
    mRasterShaderFunction = theFunction;
  }
}

/**
    Set the maximum value for the raster shader. 
    
    @param theValue The new maximum value
*/
void QgsRasterShader::setMaximumValue(double theValue)
{
#ifdef QGISDEBUG
      QgsDebugMsg("QgsRasterShader::setMaximumValue called - Value = " + QString::number(theValue));
#endif
  mMaximumValue = theValue;
  if(0 != mRasterShaderFunction)
  {
    mRasterShaderFunction->setMaximumValue(theValue);
  }
}

/**
    Set the maximum value for the raster shader
    
    @param theValue The new minimum value
*/
void QgsRasterShader::setMinimumValue(double theValue)
{
#ifdef QGISDEBUG
      QgsDebugMsg("QgsRasterShader::setMinimumValue called - Value = " + QString::number(theValue));
#endif
  mMinimumValue = theValue;
  if(0 != mRasterShaderFunction)
  {
    mRasterShaderFunction->setMinimumValue(theValue);
  }
}