qgsrasterpipe.h

Go to the documentation of this file.

/***************************************************************************
    qgsrasterpipe.h - Internal raster processing modules interface
     --------------------------------------
    Date                 : Jun 21, 2012
    Copyright            : (C) 2012 by Radim Blazek
    email                : radim dot blazek at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSRASTERPIPE_H
#define QGSRASTERPIPE_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgspropertycollection.h"
 
#include <QImage>
#include <QMap>
#include <QObject>
 
class QgsRasterInterface;
class QgsRasterRenderer;
class QgsRasterResampleFilter;
class QgsBrightnessContrastFilter;
class QgsHueSaturationFilter;
class QgsRasterProjector;
class QgsRasterNuller;
class QgsRasterResampleFilter;
class QgsContrastEnhancement;
class QgsRasterDataProvider;
 
#if defined( Q_OS_WIN )
#undef interface
#endif

class CORE_EXPORT QgsRasterPipe
{
  public:
    // *INDENT-OFF*

    enum class Property SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRasterPipe, Property ) : int
    {
      RendererOpacity, 
    };
    // *INDENT-ON*

    QgsRasterPipe() = default;
 
    QgsRasterPipe( const QgsRasterPipe &pipe ) SIP_SKIP;
 
    ~QgsRasterPipe();
 
    QgsRasterPipe &operator=( const QgsRasterPipe &rh ) = delete;

    void moveToThread( QThread *thread );

    bool insert( int idx, QgsRasterInterface *interface SIP_TRANSFER );
#ifdef SIP_RUN
    // clang-format off
    % MethodCode
    sipRes = sipCpp->insert( a0, a1 );
    if ( !sipRes )
    {
      // if insertion failed transfer ownership back to python
      PyObject *o = sipGetPyObject( a1, sipType_QgsRasterInterface );
      if ( o )
        sipTransferTo( o, NULL );
    }
    % End
// clang-format on
#endif

      bool replace( int idx, QgsRasterInterface *interface SIP_TRANSFER );

    bool set( QgsRasterInterface *interface SIP_TRANSFER );

    bool remove( int idx );

    bool remove( QgsRasterInterface *interface );

    int size() const { return mInterfaces.size(); }

    QgsRasterInterface *at( int idx ) const { return mInterfaces.at( idx ); }

    QgsRasterInterface *last() const { return mInterfaces.last(); }

    bool setOn( int idx, bool on );

    bool canSetOn( int idx, bool on );
 
    // Getters for special types of interfaces

    QgsRasterDataProvider *provider() const;

    QgsRasterRenderer *renderer() const;

    QgsRasterResampleFilter *resampleFilter() const;

    QgsBrightnessContrastFilter *brightnessFilter() const;

    QgsHueSaturationFilter *hueSaturationFilter() const;

    QgsRasterProjector *projector() const;

    QgsRasterNuller *nuller() const;

    void setResamplingStage( Qgis::RasterResamplingStage stage );

    Qgis::RasterResamplingStage resamplingStage() const { return mResamplingStage; }

    QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }

    const QgsPropertyCollection &dataDefinedProperties() const SIP_SKIP { return mDataDefinedProperties; }

    void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }

    void evaluateDataDefinedProperties( QgsExpressionContext &context );

    static QgsPropertiesDefinition propertyDefinitions();
 
  private:
#ifdef SIP_RUN
    QgsRasterPipe( const QgsRasterPipe &pipe );
#endif

    Qgis::RasterPipeInterfaceRole interfaceRole( QgsRasterInterface *iface ) const;
 
    // Interfaces in pipe, the first is always provider
    QVector<QgsRasterInterface *> mInterfaces;
 
    QMap<Qgis::RasterPipeInterfaceRole, int> mRoleMap;
 
    // Set role in mRoleMap
    void setRole( QgsRasterInterface *interface, int idx );
 
    // Unset role in mRoleMap
    void unsetRole( QgsRasterInterface *interface );
 
    // Check if index is in bounds
    bool checkBounds( int idx ) const;

    QgsRasterInterface *interface( Qgis::RasterPipeInterfaceRole role ) const;

    bool connect( QVector<QgsRasterInterface *> interfaces );
 
    Qgis::RasterResamplingStage mResamplingStage = Qgis::RasterResamplingStage::ResampleFilter;

    QgsPropertyCollection mDataDefinedProperties;

    static QgsPropertiesDefinition sPropertyDefinitions;
 
    static void initPropertyDefinitions();
};
 
#endif