qgsannotationitemeditoperation.h

Go to the documentation of this file.

/***************************************************************************
    qgsannotationitemeditoperation.h
    ----------------
    copyright            : (C) 2021 by Nyall Dawson
    email                : nyall dot dawson 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 QGSANNOTATIONITEMEDITOPERATION_H
#define QGSANNOTATIONITEMEDITOPERATION_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsgeometry.h"
#include "qgspointxy.h"
#include "qgsrendercontext.h"
#include "qgsvertexid.h"

class CORE_EXPORT QgsAnnotationItemEditContext
{
  public:
    QgsAnnotationItemEditContext() = default;

    QgsRectangle currentItemBounds() const;

    void setCurrentItemBounds( const QgsRectangle &bounds );

    QgsRenderContext renderContext() const;

    void setRenderContext( const QgsRenderContext &context );
 
  private:
    QgsRectangle mCurrentItemBounds;
    QgsRenderContext mRenderContext;
};

class CORE_EXPORT QgsAbstractAnnotationItemEditOperation
{
  public:
    enum class Type : int
    {
      MoveNode,      
      DeleteNode,    
      AddNode,       
      TranslateItem, 
      RotateItem,    
      SetItemBounds, 
    };

    QgsAbstractAnnotationItemEditOperation( const QString &itemId );
 
    virtual ~QgsAbstractAnnotationItemEditOperation();

    virtual Type type() const = 0;

    QString itemId() const { return mItemId; }
 
  protected:
    QString mItemId;
};

class CORE_EXPORT QgsAnnotationItemEditOperationMoveNode : public QgsAbstractAnnotationItemEditOperation
{
  public:
    QgsAnnotationItemEditOperationMoveNode( const QString &itemId, QgsVertexId nodeId, const QgsPoint &before, const QgsPoint &after, double translatePixelsX = 0, double translatePixelsY = 0 );
 
    Type type() const override;

    QgsVertexId nodeId() const { return mNodeId; }

    QgsPoint before() const { return mBefore; }

    QgsPoint after() const { return mAfter; }

    double translationXPixels() const { return mTranslatePixelsX; }

    double translationYPixels() const { return mTranslatePixelsY; }
 
  private:
    QgsVertexId mNodeId;
    QgsPoint mBefore;
    QgsPoint mAfter;
 
    double mTranslatePixelsX = 0;
    double mTranslatePixelsY = 0;
};
 

class CORE_EXPORT QgsAnnotationItemEditOperationDeleteNode : public QgsAbstractAnnotationItemEditOperation
{
  public:
    QgsAnnotationItemEditOperationDeleteNode( const QString &itemId, QgsVertexId nodeId, const QgsPoint &before );
 
    Type type() const override;

    QgsVertexId nodeId() const { return mNodeId; }

    QgsPoint before() const { return mBefore; }
 
  private:
    QgsVertexId mNodeId;
    QgsPoint mBefore;
};

class CORE_EXPORT QgsAnnotationItemEditOperationAddNode : public QgsAbstractAnnotationItemEditOperation
{
  public:
    QgsAnnotationItemEditOperationAddNode( const QString &itemId, const QgsPoint &point );
 
    Type type() const override;

    QgsPoint point() const { return mPoint; }
 
  private:
    QgsPoint mPoint;
};
 

class CORE_EXPORT QgsAnnotationItemEditOperationTranslateItem : public QgsAbstractAnnotationItemEditOperation
{
  public:
    QgsAnnotationItemEditOperationTranslateItem( const QString &itemId, double translateX, double translateY, double translatePixelsX = 0, double translatePixelsY = 0 );
 
    Type type() const override;

    QgsVertexId nodeId() const { return mNodeId; }

    double translationX() const { return mTranslateX; }

    double translationY() const { return mTranslateY; }

    double translationXPixels() const { return mTranslatePixelsX; }

    double translationYPixels() const { return mTranslatePixelsY; }
 
  private:
    QgsVertexId mNodeId;
    double mTranslateX = 0;
    double mTranslateY = 0;
    double mTranslatePixelsX = 0;
    double mTranslatePixelsY = 0;
};
 

class CORE_EXPORT QgsAnnotationItemEditOperationRotateItem : public QgsAbstractAnnotationItemEditOperation
{
  public:
    QgsAnnotationItemEditOperationRotateItem( const QString &itemId, double angle );
 
    Type type() const override;

    double angle() const { return mAngle; }
 
  private:
    double mAngle = 0;
};
 

class CORE_EXPORT QgsAnnotationItemEditOperationSetItemBounds : public QgsAbstractAnnotationItemEditOperation
{
  public:
    QgsAnnotationItemEditOperationSetItemBounds( const QString &itemId, const QgsRectangle &bounds );
 
    Type type() const override;

    QgsRectangle bounds() const { return mBounds; }
 
  private:
    QgsRectangle mBounds;
};
 

class CORE_EXPORT QgsAnnotationItemEditOperationTransientResults
{
  public:
    QgsAnnotationItemEditOperationTransientResults( const QgsGeometry &representativeGeometry )
      : mRepresentativeGeometry( representativeGeometry )
    {}

    QgsGeometry representativeGeometry() const { return mRepresentativeGeometry; }
 
  private:
    QgsGeometry mRepresentativeGeometry;
};
 
#endif // QGSANNOTATIONITEMEDITOPERATION_H