src/core/raster/qgsrastershaderfunction.h

Go to the documentation of this file.

/* **************************************************************************
                qgsrastershaderfunction.h -  description
                       -------------------
begin                : Fri Dec 28 2007
copyright            : (C) 2007 by Peter J. Ersts
email                : ersts@amnh.org

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

/* **************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/


#ifndef QGSRASTERSHADERFUNCTION_H
#define QGSRASTERSHADERFUNCTION_H

#include <QColor>
#include <QPair>

class CORE_EXPORT QgsRasterShaderFunction
{

  public:
    QgsRasterShaderFunction( double theMinimumValue = 0.0, double theMaximumValue = 255.0 );
    virtual ~QgsRasterShaderFunction() {}

    virtual void setMaximumValue( double );

    virtual void setMinimumValue( double );

    virtual bool shade( double, int*, int*, int*, int* );

    virtual bool shade( double, double, double, double, int*, int*, int*, int* );

    double minimumMaximumRange() const { return mMinimumMaximumRange; }

    double minimumValue() const { return mMinimumValue; }
    double maximumValue() const { return mMaximumValue; }

    virtual void legendSymbologyItems( QList< QPair< QString, QColor > >& symbolItems ) const { Q_UNUSED( symbolItems ); }

  protected:
    double mMaximumValue;

    double mMinimumValue;

    double mMinimumMaximumRange;
};
#endif