qgsvectorfieldsettings.h

Go to the documentation of this file.

/***************************************************************************
    qgsvectorfieldsettings.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 QGSVECTORFIELDSETTINGS_H
#define QGSVECTORFIELDSETTINGS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgscolorrampshader.h"
#include "qgsinterpolatedlinerenderer.h"
#include "qgsvectorfieldarrowsettings.h"
#include "qgsvectorfieldstreamlinesettings.h"
#include "qgsvectorfieldtracessettings.h"
#include "qgsvectorfieldwindbarbsettings.h"
 
#include <QColor>
#include <QDomElement>

class CORE_EXPORT QgsVectorFieldSettings
{
  public:
    double lineWidth() const;
    void setLineWidth( double lineWidth );

    QColor color() const;
    void setColor( const QColor &color );

    double filterMin() const;

    void setFilterMin( double filterMin );

    double filterMax() const;

    void setFilterMax( double filterMax );

    bool isOnUserDefinedGrid() const;
    void setOnUserDefinedGrid( bool enabled );
    int userGridCellWidth() const;
    void setUserGridCellWidth( int width );
    int userGridCellHeight() const;
    void setUserGridCellHeight( int height );

    Qgis::VectorFieldSymbology symbology() const;

    void setSymbology( const Qgis::VectorFieldSymbology &symbology );

    QgsInterpolatedLineColor::ColoringMethod coloringMethod() const;

    void setColoringMethod( const QgsInterpolatedLineColor::ColoringMethod &coloringMethod );

    QgsColorRampShader colorRampShader() const;

    void setColorRampShader( const QgsColorRampShader &colorRampShader );

    QgsInterpolatedLineColor vectorStrokeColoring() const;

    QgsVectorFieldArrowSettings arrowSettings() const;

    void setArrowsSettings( const QgsVectorFieldArrowSettings &arrowSettings );

    QgsVectorFieldStreamlineSettings streamLinesSettings() const;

    void setStreamLinesSettings( const QgsVectorFieldStreamlineSettings &streamLinesSettings );

    QgsVectorFieldTracesSettings tracesSettings() const;

    void setTracesSettings( const QgsVectorFieldTracesSettings &tracesSettings );

    QgsVectorFieldWindBarbSettings windBarbSettings() const;

    void setWindBarbSettings( const QgsVectorFieldWindBarbSettings &windBarbSettings );

    QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context = QgsReadWriteContext() );
 
  private:
    Qgis::VectorFieldSymbology mDisplayingMethod = Qgis::VectorFieldSymbology::Arrows;
 
    double mLineWidth = Qgis::DEFAULT_LINE_WIDTH; //in millimeters
    QgsColorRampShader mColorRampShader;
    QColor mColor = Qt::black;
    QgsInterpolatedLineColor::ColoringMethod mColoringMethod = QgsInterpolatedLineColor::SingleColor;
    double mFilterMin = -1;       //disabled
    double mFilterMax = -1;       //disabled
    int mUserGridCellWidth = 10;  // in pixels
    int mUserGridCellHeight = 10; // in pixels
    bool mOnUserDefinedGrid = false;
 
    QgsVectorFieldArrowSettings mArrowsSettings;
    QgsVectorFieldStreamlineSettings mStreamLinesSettings;
    QgsVectorFieldTracesSettings mTracesSettings;
    QgsVectorFieldWindBarbSettings mWindBarbSettings;
};
 
#endif // QGSVECTORFIELDSETTINGS_H