qgslayoutitempolyline.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutitempolyline.h
    begin                : March 2016
    copyright            : (C) 2016 Paul Blottiere, Oslandia
     email                : paul dot blottiere 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 QGSLAYOUTITEMPOLYLINE_H
#define QGSLAYOUTITEMPOLYLINE_H

#include "qgis_core.h"
#include "qgslayoutitemnodeitem.h"
#include "qgssymbol.h"

class CORE_EXPORT QgsLayoutItemPolyline: public QgsLayoutNodesItem
{
    Q_OBJECT

  public:

    enum MarkerMode
    {
      NoMarker, 
      ArrowHead, 
      SvgMarker, 
    };

    QgsLayoutItemPolyline( QgsLayout *layout );

    QgsLayoutItemPolyline( const QPolygonF &polyline, QgsLayout *layout );

    static QgsLayoutItemPolyline *create( QgsLayout *layout ) SIP_FACTORY;

    int type() const override;
    QIcon icon() const override;
    QString displayName() const override;

    QgsLineSymbol *symbol() { return mPolylineStyleSymbol.get(); }

    void setSymbol( QgsLineSymbol *symbol );

    MarkerMode startMarker() const { return mStartMarker; }

    void setStartMarker( MarkerMode mode );

    MarkerMode endMarker() const { return mEndMarker; }

    void setEndMarker( MarkerMode mode );

    void setArrowHeadWidth( double width );

    double arrowHeadWidth() const { return mArrowHeadWidth; }

    void setStartSvgMarkerPath( const QString &path );

    QString startSvgMarkerPath() const { return mStartMarkerFile; }

    void setEndSvgMarkerPath( const QString &path );

    QString endSvgMarkerPath() const { return mEndMarkerFile; }

    QColor arrowHeadStrokeColor() const { return mArrowHeadStrokeColor; }

    void setArrowHeadStrokeColor( const QColor &color );

    QColor arrowHeadFillColor() const { return mArrowHeadFillColor; }

    void setArrowHeadFillColor( const QColor &color );

    void setArrowHeadStrokeWidth( double width );

    double arrowHeadStrokeWidth() const { return mArrowHeadStrokeWidth; }

  protected:

    bool _addNode( const int indexPoint, QPointF newPoint, const double radius ) override;
    bool _removeNode( const int nodeIndex ) override;
    void _draw( QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem *itemStyle = nullptr ) override;
    void _readXmlStyle( const QDomElement &elmt, const QgsReadWriteContext &context ) override;
    void _writeXmlStyle( QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context ) const override;
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;

  protected slots:

    void updateBoundingRect() override;

  private:

    std::unique_ptr<QgsLineSymbol> mPolylineStyleSymbol;

    MarkerMode mStartMarker = NoMarker;
    MarkerMode mEndMarker = NoMarker;

    double mArrowHeadWidth = 4.0;

    double mStartArrowHeadHeight = 0.0;

    double mEndArrowHeadHeight = 0.0;

    QString mStartMarkerFile;

    QString mEndMarkerFile;

    double mArrowHeadStrokeWidth = 1.0;

    QColor mArrowHeadStrokeColor = Qt::black;
    QColor mArrowHeadFillColor = Qt::black;

    void createDefaultPolylineStyleSymbol();

    void refreshSymbol();

    void drawStartMarker( QPainter *painter );
    void drawEndMarker( QPainter *painter );

    void drawArrow( QPainter *painter, QPointF center, double angle );

    void updateMarkerSvgSizes();

    static void drawArrowHead( QPainter *p, const double x, const double y, const double angle, const double arrowHeadWidth );
    void drawSvgMarker( QPainter *p, QPointF point, double angle, const QString &markerPath, double height ) const;

    double computeMarkerMargin() const;

    friend class TestQgsLayoutPolyline;
    friend class QgsCompositionConverter;

};

#endif // QGSLAYOUTITEMPOLYLINE_H