qgsannotation.h

Go to the documentation of this file.

/***************************************************************************
                             qgsannotation.h
                             ---------------
    begin                : January 2017
    copyright            : (C) 2017 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 QGSANNOTATION_H
#define QGSANNOTATION_H
 
#include "qgis_core.h"
#include "qgis.h"
#include "qgspointxy.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsmargins.h"
#include "qgsmaplayer.h"
 
#include <QPointer>
 
class QgsRenderContext;
class QgsMarkerSymbol;
class QgsFillSymbol;
 
class CORE_EXPORT QgsAnnotation : public QObject
{
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast< QgsTextAnnotation * >( sipCpp ) )
      sipType = sipType_QgsTextAnnotation;
    else if ( dynamic_cast< QgsSvgAnnotation * >( sipCpp ) )
      sipType = sipType_QgsSvgAnnotation;
    else if ( dynamic_cast< QgsHtmlAnnotation * >( sipCpp ) )
      sipType = sipType_QgsHtmlAnnotation;
    else
      sipType = NULL;
    SIP_END
#endif
 
 
    Q_OBJECT
    Q_PROPERTY( bool visible READ isVisible WRITE setVisible )
    Q_PROPERTY( bool hasFixedMapPosition READ hasFixedMapPosition WRITE setHasFixedMapPosition )
    Q_PROPERTY( QgsPointXY mapPosition READ mapPosition WRITE setMapPosition )
    Q_PROPERTY( QSizeF frameSize READ frameSize WRITE setFrameSize )
 
  public:
 
    QgsAnnotation( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    ~QgsAnnotation() override;
 
    virtual QgsAnnotation *clone() const = 0 SIP_FACTORY;
 
    bool isVisible() const { return mVisible; }
 
    void setVisible( bool visible );
 
    bool hasFixedMapPosition() const { return mHasFixedMapPosition; }
 
    void setHasFixedMapPosition( bool fixed );
 
    QgsPointXY mapPosition() const { return mMapPosition; }
 
    void setMapPosition( const QgsPointXY &position );
 
    QgsCoordinateReferenceSystem mapPositionCrs() const { return mMapPositionCrs; }
 
    void setMapPositionCrs( const QgsCoordinateReferenceSystem &crs );
 
    QPointF relativePosition() const { return mRelativePosition; }
 
    void setRelativePosition( QPointF position );
 
    Q_DECL_DEPRECATED void setFrameOffsetFromReferencePoint( QPointF offset ) SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED QPointF frameOffsetFromReferencePoint() const SIP_DEPRECATED;
 
    void setFrameOffsetFromReferencePointMm( QPointF offset );
 
    QPointF frameOffsetFromReferencePointMm() const { return mOffsetFromReferencePoint; }
 
    Q_DECL_DEPRECATED void setFrameSize( QSizeF size ) SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED QSizeF frameSize() const SIP_DEPRECATED;
 
    void setFrameSizeMm( QSizeF size );
 
    QSizeF frameSizeMm() const { return mFrameSize; }
 
    void setContentsMargin( const QgsMargins &margins );
 
    QgsMargins contentsMargin() const { return mContentsMargins; }
 
    void setFillSymbol( QgsFillSymbol *symbol SIP_TRANSFER );
 
    QgsFillSymbol *fillSymbol() const;
 
    void render( QgsRenderContext &context ) const;
 
    virtual void writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const = 0;
 
    virtual void readXml( const QDomElement &itemElem, const QgsReadWriteContext &context ) = 0;
 
    void setMarkerSymbol( QgsMarkerSymbol *symbol SIP_TRANSFER );
 
    QgsMarkerSymbol *markerSymbol() const { return mMarkerSymbol.get(); }
 
    QgsMapLayer *mapLayer() const { return mMapLayer.data(); }
 
    void setMapLayer( QgsMapLayer *layer );
 
    QgsFeature associatedFeature() const { return mFeature; }
 
    virtual void setAssociatedFeature( const QgsFeature &feature );
 
    virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
 
  signals:
 
    void appearanceChanged();
 
    void moved();
 
    void mapLayerChanged();
 
  protected:
 
    virtual void renderAnnotation( QgsRenderContext &context, QSizeF size ) const = 0;
 
    virtual QSizeF minimumFrameSize() const;
 
    void _writeXml( QDomElement &itemElem, QDomDocument &doc, const QgsReadWriteContext &context ) const;
 
    void _readXml( const QDomElement &annotationElem, const QgsReadWriteContext &context );
 
    void copyCommonProperties( QgsAnnotation *target ) const;
 
  private:
 
    void drawFrame( QgsRenderContext &context ) const;
 
    void drawMarkerSymbol( QgsRenderContext &context ) const;
 
    bool mVisible = true;
 
    bool mHasFixedMapPosition = true;
 
    QgsPointXY mMapPosition;
 
    QgsCoordinateReferenceSystem mMapPositionCrs;
 
    QPointF mRelativePosition;
 
    QPointF mOffsetFromReferencePoint = QPointF( 13, -13 );
 
    QSizeF mFrameSize;
 
    std::unique_ptr<QgsMarkerSymbol> mMarkerSymbol;
 
    QgsMargins mContentsMargins;
 
    std::unique_ptr<QgsFillSymbol> mFillSymbol;
 
    QgsWeakMapLayerPointer mMapLayer;
 
    QgsFeature mFeature;
 
    double mSegmentPointWidthMm = 2.64;
 
};
 
#endif // QGSANNOTATION_H