qgsrastershader.h

Go to the documentation of this file.

/* **************************************************************************
                qgsrastershader.h -  description
                       -------------------
begin                : Fri Dec 28 2007
copyright            : (C) 2007 by Peter J. Ersts
email                : [email protected]
 
****************************************************************************/
 
/* **************************************************************************
 *                                                                         *
 *   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 QGSRASTERSHADER_H
#define QGSRASTERSHADER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsreadwritecontext.h"
 
class QDomDocument;
class QDomElement;
class QgsRasterShaderFunction;
 
class CORE_EXPORT QgsRasterShader
{
 
  public:
    QgsRasterShader( double minimumValue = 0.0, double maximumValue = 255.0 );
 
    QgsRasterShader( const QgsRasterShader &rh ) = delete;
    QgsRasterShader &operator=( const QgsRasterShader &rh ) = delete;
 
    /*
     *
     * Non-Static Inline methods
     *
     */
 
    double maximumValue() const { return mMaximumValue; }
 
    double minimumValue() const { return mMinimumValue; }
 
    QgsRasterShaderFunction *rasterShaderFunction() { return mRasterShaderFunction.get(); }
    const QgsRasterShaderFunction *rasterShaderFunction() const SIP_SKIP { return mRasterShaderFunction.get(); }
 
    /*
     *
     * Non-Static methods
     *
     */
 
    bool shade( double value,
                int *returnRedValue SIP_OUT,
                int *returnGreenValue SIP_OUT,
                int *returnBlueValue SIP_OUT,
                int *returnAlpha SIP_OUT ) const;
 
    bool shade( double redValue,
                double greenValue,
                double blueValue,
                double alphaValue,
                int *returnRedValue SIP_OUT,
                int *returnGreenValue SIP_OUT,
                int *returnBlueValue SIP_OUT,
                int *returnAlpha SIP_OUT ) const;
 
    void setRasterShaderFunction( QgsRasterShaderFunction *function SIP_TRANSFER );
 
    void setMaximumValue( double value );
 
    void setMinimumValue( double value );
 
    void writeXml( QDomDocument &doc, QDomElement &parent, const QgsReadWriteContext &context = QgsReadWriteContext() ) const;
 
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context = QgsReadWriteContext() );
 
  private:
#ifdef SIP_RUN
    QgsRasterShader( const QgsRasterShader &rh );
#endif
 
    double mMinimumValue;
 
    double mMaximumValue;
 
    std::unique_ptr< QgsRasterShaderFunction > mRasterShaderFunction;
 
};
#endif