qgsinterpolatedlinerenderer.h

Go to the documentation of this file.

/***************************************************************************
  qgsinterpolatedlinerenderer.h
  --------------------------------------
  Date                 : April 2020
  Copyright            : (C) 2020 by Vincent Cloarec
  Email                : vcloarec 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 QGSINTERPOLATEDLINERENDERER_H
#define QGSINTERPOLATEDLINERENDERER_H
 
#include "qgis.h"
#include "qgscolorrampshader.h"
#include "qgsreadwritecontext.h"
#include "qgssymbollayer.h"
 
#include <QDebug>
 
class QgsLayerTreeLayer;
class QgsRenderContext;

class CORE_EXPORT QgsInterpolatedLineColor
{
  public:

    enum ColoringMethod
    {
      SingleColor = 0,
      ColorRamp
    };

    QgsInterpolatedLineColor();
    QgsInterpolatedLineColor( const QgsColorRampShader &colorRampShader );
    QgsInterpolatedLineColor( const QColor &color );

    void setColor( const QgsColorRampShader &colorRampShader );

    void setColor( const QColor &color );

    QColor color( double magnitude ) const;

    void setColoringMethod( ColoringMethod coloringMethod );

    QgsInterpolatedLineColor::ColoringMethod coloringMethod() const;

    QgsColorRampShader colorRampShader() const;

    QColor singleColor() const;

    QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context );

    void graduatedColors( double value1, double value2, QList<double> &breakValues, QList<QColor> &breakColors, QList<QLinearGradient> &gradients ) const;
 
  private:
    QgsColorRampShader mColorRampShader;
    QColor mSingleColor = Qt::black;
 
    QgsInterpolatedLineColor::ColoringMethod mColoringMethod = SingleColor;
 
    QLinearGradient makeSimpleLinearGradient( const QColor &color1, const QColor &color2 ) const;

    int itemColorIndexInf( double value ) const;
 
    void graduatedColorsExact( double value1, double value2, QList<double> &breakValues, QList<QColor> &breakColors, const QList<QLinearGradient> &gradients ) const;
    void graduatedColorsInterpolated( double value1, double value2, QList<double> &breakValues, QList<QColor> &breakColors, QList<QLinearGradient> &gradients ) const;
    void graduatedColorsDiscrete( double value1, double value2, QList<double> &breakValues, QList<QColor> &breakColors, QList<QLinearGradient> &gradients ) const;
};

class CORE_EXPORT QgsInterpolatedLineWidth
{
  public:
    double minimumValue() const;
    void setMinimumValue( double minimumValue );

    double maximumValue() const;
    void setMaximumValue( double maximumValue );

    double minimumWidth() const;
    void setMinimumWidth( double minimumWidth );

    double maximumWidth() const;
    void setMaximumWidth( double maximumWidth );

    bool ignoreOutOfRange() const;
    void setIgnoreOutOfRange( bool ignoreOutOfRange );

    bool useAbsoluteValue() const;
    void setUseAbsoluteValue( bool useAbsoluteValue );

    bool isVariableWidth() const;
    void setIsVariableWidth( bool isVariableWidth );

    double fixedStrokeWidth() const;
    void setFixedStrokeWidth( double fixedWidth );

    double strokeWidth( double value ) const;

    QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context );
 
  private:
    bool mIsWidthVariable = false;
 
    double mFixedWidth = Qgis::DEFAULT_LINE_WIDTH;
 
    double mMinimumValue = 0;
    double mMaximumValue = 10;
    double mMinimumWidth = Qgis::DEFAULT_LINE_WIDTH;
    double mMaximumWidth = 3;
    bool mIgnoreOutOfRange = false;
    bool mUseAbsoluteValue = false;
 
    mutable double mLinearCoef = 1;
    mutable bool mNeedUpdateFormula = true;
    void updateLinearFormula() const;
};

class CORE_EXPORT QgsInterpolatedLineRenderer
{
  public:

    void setInterpolatedWidth( const QgsInterpolatedLineWidth &strokeWidth );

    QgsInterpolatedLineWidth interpolatedLineWidth() const;

    void setWidthUnit( Qgis::RenderUnit strokeWidthUnit );

    Qgis::RenderUnit widthUnit() const;

    void setInterpolatedColor( const QgsInterpolatedLineColor &strokeColoring );

    QgsInterpolatedLineColor interpolatedColor() const;

    void render( double value1, double value2, const QgsPointXY &point1, const QgsPointXY &point2, QgsRenderContext &context ) const;

    void render( double valueColor1, double valueColor2, double valueWidth1, double valueWidth2, const QgsPointXY &point1, const QgsPointXY &point2, QgsRenderContext &context ) const;

    void renderInDeviceCoordinates( double valueColor1, double valueColor2, double valueWidth1, double valueWidth2, QPointF point1, QPointF point2, QgsRenderContext &context ) const;

    void setSelected( bool selected );
 
  private:
 
    QgsInterpolatedLineWidth mStrokeWidth;
    QgsInterpolatedLineColor mStrokeColoring;
    Qgis::RenderUnit mStrokeWidthUnit = Qgis::RenderUnit::Millimeters;
    void adjustLine( double value, double value1, double value2, double &width, double &adjusting ) const;
    bool mSelected = false;
 
 
    friend class QgsInterpolatedLineSymbolLayer;
};

class CORE_EXPORT QgsInterpolatedLineSymbolLayer : public QgsLineSymbolLayer
{
  public:
 
    QgsInterpolatedLineSymbolLayer();

    static QgsSymbolLayer *create( const QVariantMap &properties ) SIP_FACTORY;
 
    Qgis::SymbolLayerFlags flags() const override;
    QString layerType() const override;
    void startRender( QgsSymbolRenderContext &context ) override;
    void stopRender( QgsSymbolRenderContext &context ) override;
    QgsInterpolatedLineSymbolLayer *clone() const override SIP_FACTORY;
    QVariantMap properties() const override;
    void drawPreviewIcon( QgsSymbolRenderContext &context, QSize size ) override;
    QColor color() const override;
 
    void startFeatureRender( const QgsFeature &feature, QgsRenderContext &context ) override;
    void stopFeatureRender( const QgsFeature &feature, QgsRenderContext &context ) override;
    void renderPolyline( const QPolygonF &points, QgsSymbolRenderContext &context ) override;
    bool canCauseArtifactsBetweenAdjacentTiles() const override;

    Q_DECL_DEPRECATED void setExpressionsStringForWidth( const QString &start, const QString &end ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QString startValueExpressionForWidth() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED QString endValueExpressionForWidth() const SIP_DEPRECATED;
 
    // TODO QGIS 4.0 -- rename to avoid collision with base class methods

    void setWidthUnit( Qgis::RenderUnit strokeWidthUnit ); // cppcheck-suppress duplInheritedMember

    Qgis::RenderUnit widthUnit() const; // cppcheck-suppress duplInheritedMember

    void setInterpolatedWidth( const QgsInterpolatedLineWidth &interpolatedLineWidth );

    QgsInterpolatedLineWidth interpolatedWidth() const;

    Q_DECL_DEPRECATED void setExpressionsStringForColor( const QString &start, const QString &end ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QString startValueExpressionForColor() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED QString endValueExpressionForColor() const SIP_DEPRECATED;

    void setInterpolatedColor( const QgsInterpolatedLineColor &interpolatedLineColor );

    QgsInterpolatedLineColor interpolatedColor() const;
 
  private:
#ifdef SIP_RUN
    QgsInterpolatedLineSymbolLayer( const QgsInterpolatedLineSymbolLayer &copy );
#endif
 
    QgsInterpolatedLineRenderer mLineRender;
 
    QVector< QPolygonF > mLineParts;
    bool mRenderingFeature = false;
 
    void render( const QVector< QPolygonF > &parts, QgsRenderContext &context );
 
    QVariant colorRampShaderProperties() const;
    static QgsColorRampShader createColorRampShaderFromProperties( const QVariant &properties );
};
 
 
#endif // QGSINTERPOLATEDLINERENDERER_H