qgsvectorfieldarrowsettings.h

Go to the documentation of this file.

/***************************************************************************
    qgsvectorfieldarrowsettings.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 QGSVECTORFIELDARROWSETTINGS_H
#define QGSVECTORFIELDARROWSETTINGS_H
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QDomElement>

class CORE_EXPORT QgsVectorFieldArrowSettings
{
  public:
    Qgis::VectorFieldArrowScalingMethod shaftLengthMethod() const;
    void setShaftLengthMethod( Qgis::VectorFieldArrowScalingMethod shaftLengthMethod );

    double minShaftLength() const;

    void setMinShaftLength( double minShaftLength );

    double maxShaftLength() const;

    void setMaxShaftLength( double maxShaftLength );

    double scaleFactor() const;

    void setScaleFactor( double scaleFactor );

    double fixedShaftLength() const;

    void setFixedShaftLength( double fixedShaftLength );

    double arrowHeadWidthRatio() const;
    void setArrowHeadWidthRatio( double arrowHeadWidthRatio );

    double arrowHeadLengthRatio() const;
    void setArrowHeadLengthRatio( double arrowHeadLengthRatio );

    QDomElement writeXml( QDomDocument &doc ) const;
    void readXml( const QDomElement &elem );
 
  private:
    Qgis::VectorFieldArrowScalingMethod mShaftLengthMethod = Qgis::VectorFieldArrowScalingMethod::MinMax;
    double mMinShaftLength = 0.8; //in millimeters
    double mMaxShaftLength = 10;  //in millimeters
    double mScaleFactor = 10;
    double mFixedShaftLength = 20; //in millimeters
    double mArrowHeadWidthRatio = 0.15;
    double mArrowHeadLengthRatio = 0.40;
};
 
#endif // QGSVECTORFIELDARROWSETTINGS_H