qgslayoutitemnodeitem.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutitemnodeitem.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 QGSLAYOUTITEMNODEITEM_H
#define QGSLAYOUTITEMNODEITEM_H

#include "qgis_core.h"
#include "qgslayoutitem.h"

class CORE_EXPORT QgsLayoutNodesItem: public QgsLayoutItem
{
    Q_OBJECT

  public:

    void setNodes( const QPolygonF &nodes );

    QPolygonF nodes() const { return mPolygon; }

    bool addNode( QPointF point, bool checkArea = true, double radius = 10 );

    void setDisplayNodes( bool display = true ) { mDrawNodes = display; }

    bool moveNode( int index, QPointF node );

    int nodeAtPosition( QPointF point, bool searchInRadius = true, double radius = 10 ) const;

    bool nodePosition( int index, QPointF &position ) const;

    bool removeNode( int index );

    int nodesSize() const { return mPolygon.size(); }

    bool setSelectedNode( int index );

    int selectedNode() const { return mSelectedNode; }

    void deselectNode() { mSelectedNode = -1; }

    // Depending on the symbol style, the bounding rectangle can be larger than the shape
    QRectF boundingRect() const override;

    // Reimplement estimatedFrameBleed, since frames on shapes are drawn using symbology
    // rather than the item's pen
    double estimatedFrameBleed() const override;

  protected:

    QgsLayoutNodesItem( QgsLayout *layout );

    QgsLayoutNodesItem( const QPolygonF &polygon, QgsLayout *layout );

    void draw( QgsLayoutItemRenderContext &context ) override;

    bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;

    QPolygonF mPolygon;

    double mMaxSymbolBleed = 0.0;

    virtual bool _addNode( int nodeIndex, QPointF newNode, double radius ) = 0;

    virtual bool _removeNode( int nodeIndex ) = 0;

    virtual void _draw( QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem *itemStyle = nullptr ) = 0;

    virtual void _readXmlStyle( const QDomElement &elmt, const QgsReadWriteContext &context ) = 0;

    virtual void _writeXmlStyle( QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context ) const = 0;

    void rescaleToFitBoundingBox();

    double computeDistance( QPointF pt1, QPointF pt2 ) const;

    void updateSceneRect();

    QRectF mCurrentRectangle;

  protected slots:

    virtual void updateBoundingRect();

  private:

    void init();

    int mSelectedNode = -1;

    bool mDrawNodes = false;

    void drawNodes( QgsLayoutItemRenderContext &context ) const;
    void drawSelectedNode( QgsLayoutItemRenderContext &context ) const;

};

#endif // QGSLAYOUTITEMNODEITEM_H