Quantum GIS API Documentation  1.7.4
src/core/raster/qgsrastershader.h
Go to the documentation of this file.
00001 /* **************************************************************************
00002                 qgsrastershader.h -  description
00003                        -------------------
00004 begin                : Fri Dec 28 2007
00005 copyright            : (C) 2007 by Peter J. Ersts
00006 email                : ersts@amnh.org
00007 
00008 ****************************************************************************/
00009 
00010 /* **************************************************************************
00011  *                                                                         *
00012  *   This program is free software; you can redistribute it and/or modify  *
00013  *   it under the terms of the GNU General Public License as published by  *
00014  *   the Free Software Foundation; either version 2 of the License, or     *
00015  *   (at your option) any later version.                                   *
00016  *                                                                         *
00017  ***************************************************************************/
00018 
00019 
00020 #ifndef QGSRASTERSHADER_H
00021 #define QGSRASTERSHADER_H
00022 
00023 #include "qgsrastershaderfunction.h"
00024 
00028 class CORE_EXPORT QgsRasterShader
00029 {
00030 
00031   public:
00032     QgsRasterShader( double theMinimumValue = 0.0, double theMaximumValue = 255.0 );
00033     ~QgsRasterShader();
00034 
00035     /*
00036      *
00037      * Non-Static Inline methods
00038      *
00039      */
00041     double maximumValue() { return mMaximumValue; }
00042 
00044     double minimumValue() { return mMinimumValue; }
00045 
00046     QgsRasterShaderFunction* rasterShaderFunction() { return mRasterShaderFunction; }
00047 
00048     /*
00049      *
00050      * Non-Static methods
00051      *
00052      */
00054     bool shade( double, int*, int*, int* );
00055 
00057     bool shade( double, double, double, int*, int*, int* );
00058 
00061     void setRasterShaderFunction( QgsRasterShaderFunction* );
00062 
00064     void setMaximumValue( double );
00065 
00067     void setMinimumValue( double );
00068 
00069   private:
00071     double mMinimumValue;
00072 
00074     double mMaximumValue;
00075 
00077     QgsRasterShaderFunction* mRasterShaderFunction;
00078 };
00079 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines