qgsrastervectorfieldrenderer.h

Go to the documentation of this file.

/***************************************************************************
                         qgsrastervectorfieldrenderer.h
                         ------------------------------
    begin                : September 2026
    copyright            : (C) 2026 by Stefanos Natsis
    email                : uclaros 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 QGSRASTERVECTORFIELDRENDERER_H
#define QGSRASTERVECTORFIELDRENDERER_H
 
#include <limits>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsrasterrenderer.h"
#include "qgsvectorfieldsettings.h"

class CORE_EXPORT QgsRasterVectorFieldRenderer : public QgsRasterRenderer
{
  public:
    explicit QgsRasterVectorFieldRenderer( QgsRasterInterface *input );
    ~QgsRasterVectorFieldRenderer() override;

    QgsRasterVectorFieldRenderer( const QgsRasterVectorFieldRenderer & ) = delete;
    const QgsRasterVectorFieldRenderer &operator=( const QgsRasterVectorFieldRenderer & ) = delete;
 
    QgsRasterVectorFieldRenderer *clone() const override SIP_FACTORY;
    Qgis::RasterRendererFlags flags() const override;

    static std::unique_ptr<QgsRasterRenderer> create( const QDomElement &elem, QgsRasterInterface *input );
 
    void writeXml( QDomDocument &doc, QDomElement &parentElem ) const override;
 
    QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) override SIP_FACTORY;
 
    QList<int> usesBands() const override;
    QList<QPair<QString, QColor>> legendSymbologyItems() const override;

    Qgis::RasterVectorFieldSourceMode sourceMode() const { return mSourceMode; }

    void setSourceMode( Qgis::RasterVectorFieldSourceMode mode ) { mSourceMode = mode; }

    int directionBand() const { return mDirectionBand; }

    bool setDirectionBand( int band );

    Qgis::RasterDirectionEncoding directionEncoding() const { return mDirectionEncoding; }

    void setDirectionEncoding( Qgis::RasterDirectionEncoding encoding ) { mDirectionEncoding = encoding; }

    int xBand() const { return mXBand; }

    bool setXBand( int band );

    int yBand() const { return mYBand; }

    bool setYBand( int band );

    QgsVectorFieldSettings settings() const { return mSettings; }

    void setSettings( const QgsVectorFieldSettings &settings ) { mSettings = settings; }

    double minimumMagnitude() const { return mMinimumMagnitude; }

    void setMinimumMagnitude( double magnitude ) { mMinimumMagnitude = magnitude; }

    double maximumMagnitude() const { return mMaximumMagnitude; }

    void setMaximumMagnitude( double magnitude ) { mMaximumMagnitude = magnitude; }
 
  private:
#ifdef SIP_RUN
    QgsRasterVectorFieldRenderer( const QgsRasterVectorFieldRenderer & );
    const QgsRasterVectorFieldRenderer &operator=( const QgsRasterVectorFieldRenderer & );
#endif
 
    bool shouldAcceptBand( int band ) const;
 
    Qgis::RasterVectorFieldSourceMode mSourceMode = Qgis::RasterVectorFieldSourceMode::CartesianComponents;
    int mXBand = 1;
    int mYBand = 2;
    int mDirectionBand = 1;
    Qgis::RasterDirectionEncoding mDirectionEncoding = Qgis::RasterDirectionEncoding::Esri;
    QgsVectorFieldSettings mSettings;
    double mMinimumMagnitude = std::numeric_limits<double>::quiet_NaN();
    double mMaximumMagnitude = std::numeric_limits<double>::quiet_NaN();
};
 
#endif // QGSRASTERVECTORFIELDRENDERER_H