qgsmeshrenderersettings.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmeshrenderersettings.h
                         -------------------------
    begin                : May 2018
    copyright            : (C) 2018 by Peter Petrik
    email                : zilolv 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 QGSMESHRENDERERSETTINGS_H
#define QGSMESHRENDERERSETTINGS_H

#include <QColor>
#include <limits>

#include "qgis_core.h"
#include "qgis.h"

class CORE_EXPORT QgsMeshRendererMeshSettings
{
  public:
    bool isEnabled() const;
    void setEnabled( bool enabled );

    double lineWidth() const;
    void setLineWidth( double lineWidth );

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

  private:
    bool mEnabled = false;
    double mLineWidth = DEFAULT_LINE_WIDTH;
    QColor mColor = Qt::black;
};

class CORE_EXPORT QgsMeshRendererScalarSettings
{
  public:
    QColor maxColor() const;
    void setMaxColor( const QColor &maxColor );

    QColor minColor() const;
    void setMinColor( const QColor &minColor );

    double minValue() const;

    void setMinValue( double minValue );

    double maxValue() const;

    void setMaxValue( double maxValue );

  private:
    QColor mMaxColor = QColor::fromRgb( 255, 0, 0 );
    QColor mMinColor = QColor::fromRgb( 0, 0, 255 );
    double mMaxValue = std::numeric_limits<double>::quiet_NaN(); //disabled
    double mMinValue = std::numeric_limits<double>::quiet_NaN(); //disabled
};

class CORE_EXPORT QgsMeshRendererVectorSettings
{
  public:
    enum ArrowScalingMethod
    {

      MinMax = 0,

      Scaled,

      Fixed
    };

    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 );

    QgsMeshRendererVectorSettings::ArrowScalingMethod shaftLengthMethod() const;
    void setShaftLengthMethod( ArrowScalingMethod 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 );

  private:
    double mLineWidth = DEFAULT_LINE_WIDTH; //in milimeters
    QColor mColor = Qt::black;
    double mFilterMin = -1; //disabled
    double mFilterMax = -1; //disabled
    QgsMeshRendererVectorSettings::ArrowScalingMethod mShaftLengthMethod = QgsMeshRendererVectorSettings::ArrowScalingMethod::MinMax;
    double mMinShaftLength = 0.8; //in milimeters
    double mMaxShaftLength = 10; //in milimeters
    double mScaleFactor = 10;
    double mFixedShaftLength = 20; //in milimeters
    double mArrowHeadWidthRatio = 0.15;
    double mArrowHeadLengthRatio = 0.40;
};

#endif //QGSMESHRENDERERSETTINGS_H