qgsarrowsymbollayer.h

Go to the documentation of this file.

/***************************************************************************
 qgsarrowsymbollayer.h
 ---------------------
 begin                : January 2016
 copyright            : (C) 2016 by Hugo Mercier
 email                : hugo dot mercier at oslandia 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 QGSARROWSYMBOLLAYERV2_H
#define QGSARROWSYMBOLLAYERV2_H

#include "qgssymbollayerv2.h"


class CORE_EXPORT QgsArrowSymbolLayer : public QgsLineSymbolLayerV2
{
  public:
    QgsArrowSymbolLayer();

    static QgsSymbolLayerV2* create( const QgsStringMap& properties = QgsStringMap() );

    virtual QgsArrowSymbolLayer* clone() const override;

    virtual QgsSymbolV2* subSymbol() override { return mSymbol.data(); }

    virtual bool setSubSymbol( QgsSymbolV2* symbol ) override;

    virtual QSet<QString> usedAttributes() const override;

    double arrowWidth() const { return mArrowWidth; }
    void setArrowWidth( double width ) { mArrowWidth = width; }
    QgsSymbolV2::OutputUnit arrowWidthUnit() const { return mArrowWidthUnit; }
    void setArrowWidthUnit( QgsSymbolV2::OutputUnit unit ) { mArrowWidthUnit = unit; }
    QgsMapUnitScale arrowWidthUnitScale() const { return mArrowWidthUnitScale; }
    void setArrowWidthUnitScale( const QgsMapUnitScale& scale ) { mArrowWidthUnitScale = scale; }

    double arrowStartWidth() const { return mArrowStartWidth; }
    void setArrowStartWidth( double width ) { mArrowStartWidth = width; }
    QgsSymbolV2::OutputUnit arrowStartWidthUnit() const { return mArrowStartWidthUnit; }
    void setArrowStartWidthUnit( QgsSymbolV2::OutputUnit unit ) { mArrowStartWidthUnit = unit; }
    QgsMapUnitScale arrowStartWidthUnitScale() const { return mArrowStartWidthUnitScale; }
    void setArrowStartWidthUnitScale( const QgsMapUnitScale& scale ) { mArrowStartWidthUnitScale = scale; }

    double headLength() const { return mHeadLength; }
    void setHeadLength( double length ) { mHeadLength = length; }
    QgsSymbolV2::OutputUnit headLengthUnit() const { return mHeadLengthUnit; }
    void setHeadLengthUnit( QgsSymbolV2::OutputUnit unit ) { mHeadLengthUnit = unit; }
    QgsMapUnitScale headLengthUnitScale() const { return mHeadLengthUnitScale; }
    void setHeadLengthUnitScale( const QgsMapUnitScale& scale ) { mHeadLengthUnitScale = scale; }

    double headThickness() const { return mHeadThickness; }
    void setHeadThickness( double thickness ) { mHeadThickness = thickness; }
    QgsSymbolV2::OutputUnit headThicknessUnit() const { return mHeadThicknessUnit; }
    void setHeadThicknessUnit( QgsSymbolV2::OutputUnit unit ) { mHeadThicknessUnit = unit; }
    QgsMapUnitScale headThicknessUnitScale() const { return mHeadThicknessUnitScale; }
    void setHeadThicknessUnitScale( const QgsMapUnitScale& scale ) { mHeadThicknessUnitScale = scale; }

    bool isCurved() const { return mIsCurved; }
    void setIsCurved( bool isCurved ) { mIsCurved = isCurved; }

    bool isRepeated() const { return mIsRepeated; }
    void setIsRepeated( bool isRepeated ) { mIsRepeated = isRepeated; }

    enum HeadType
    {
      HeadSingle,   //< One single head at the end
      HeadReversed, //< One single head at the beginning
      HeadDouble    //< Two heads
    };

    HeadType headType() const { return mHeadType; }
    void setHeadType( HeadType type ) { mHeadType = type; }

    enum ArrowType
    {
      ArrowPlain,     //< Regular arrow
      ArrowLeftHalf,  //< Halved arrow, only the left side of the arrow is rendered (for straight arrows) or the side toward the exterior (for curved arrows)
      ArrowRightHalf  //< Halved arrow, only the right side of the arrow is rendered (for straight arrows) or the side toward the interior (for curved arrows)
    };

    ArrowType arrowType() const { return mArrowType; }
    void setArrowType( ArrowType type ) { mArrowType = type; }

    QgsStringMap properties() const override;

    QString layerType() const override;

    void startRender( QgsSymbolV2RenderContext& context ) override;

    void stopRender( QgsSymbolV2RenderContext& context ) override;

    void renderPolyline( const QPolygonF& points, QgsSymbolV2RenderContext& context ) override;

    void setColor( const QColor& c ) override;
    virtual QColor color() const override;

  private:
    QScopedPointer<QgsFillSymbolV2> mSymbol;

    double mArrowWidth;
    QgsSymbolV2::OutputUnit mArrowWidthUnit;
    QgsMapUnitScale mArrowWidthUnitScale;

    double mArrowStartWidth;
    QgsSymbolV2::OutputUnit mArrowStartWidthUnit;
    QgsMapUnitScale mArrowStartWidthUnitScale;

    double mHeadLength;
    QgsSymbolV2::OutputUnit mHeadLengthUnit;
    QgsMapUnitScale mHeadLengthUnitScale;
    double mHeadThickness;
    QgsSymbolV2::OutputUnit mHeadThicknessUnit;
    QgsMapUnitScale mHeadThicknessUnitScale;

    HeadType mHeadType;
    ArrowType mArrowType;
    bool mIsCurved;
    bool mIsRepeated;

    double mScaledArrowWidth;
    double mScaledArrowStartWidth;
    double mScaledHeadLength;
    double mScaledHeadThickness;
    double mScaledOffset;
    HeadType mComputedHeadType;
    ArrowType mComputedArrowType;

    QScopedPointer<QgsExpressionContextScope> mExpressionScope;

    void _resolveDataDefined( QgsSymbolV2RenderContext& );
};

#endif