qgsrasterrendererregistry.h

Go to the documentation of this file.

/***************************************************************************
                         qgsrasterrendererregistry.h
                         ---------------------------
    begin                : January 2012
    copyright            : (C) 2012 by Marco Hugentobler
    email                : marco at sourcepole dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSRASTERRENDERERREGISTRY_H
#define QGSRASTERRENDERERREGISTRY_H
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QHash>
#include <QString>
 
class QDomElement;
class QgsRasterInterface;
class QgsRasterLayer;
class QgsRasterRenderer;
class QgsRasterRendererWidget;
class QgsRasterDataProvider;
class QgsRectangle;
 
#ifndef SIP_RUN
typedef QgsRasterRenderer *( *QgsRasterRendererCreateFunc )( const QDomElement &, QgsRasterInterface *input );
typedef QgsRasterRendererWidget *( *QgsRasterRendererWidgetCreateFunc )( QgsRasterLayer *, const QgsRectangle &extent );

struct CORE_EXPORT QgsRasterRendererRegistryEntry
{
    QgsRasterRendererRegistryEntry(
      const QString &name,
      const QString &visibleName,
      QgsRasterRendererCreateFunc rendererFunction,
      QgsRasterRendererWidgetCreateFunc widgetFunction,
      Qgis::RasterRendererCapabilities capabilities = Qgis::RasterRendererCapabilities()
    );
 
    QgsRasterRendererRegistryEntry() = default;
    QString name;
    QString visibleName; //visible (and translatable) name

    Qgis::RasterRendererCapabilities capabilities;
 
    QIcon icon();
    QgsRasterRendererCreateFunc rendererCreateFunction = nullptr;     //pointer to create function
    QgsRasterRendererWidgetCreateFunc widgetCreateFunction = nullptr; //pointer to create function for renderer widget
};
 
#endif

class CORE_EXPORT QgsRasterRendererRegistry
{
  public:
    QgsRasterRendererRegistry();

    void insert( const QgsRasterRendererRegistryEntry &entry ) SIP_SKIP;

    void insertWidgetFunction( const QString &rendererName, QgsRasterRendererWidgetCreateFunc func ) SIP_SKIP;

    bool rendererData( const QString &rendererName, QgsRasterRendererRegistryEntry &data ) const SIP_SKIP;

    QStringList renderersList() const;

    QList< QgsRasterRendererRegistryEntry > entries() const SIP_SKIP;

    Qgis::RasterRendererCapabilities rendererCapabilities( const QString &rendererName ) const;

    QgsRasterRenderer *defaultRendererForDrawingStyle( Qgis::RasterDrawingStyle drawingStyle, QgsRasterDataProvider *provider ) const SIP_FACTORY;
 
  private:
    QHash< QString, QgsRasterRendererRegistryEntry > mEntries;
    QStringList mSortedEntries;
 
    //read min/max values from
    bool minMaxValuesForBand( int band, QgsRasterDataProvider *provider, double &minValue, double &maxValue ) const;
};
 
#endif // QGSRASTERRENDERERREGISTRY_H