qgsannotationitem.cpp

Go to the documentation of this file.

/***************************************************************************
                             qgsannotationitem.cpp
                             -----------------
    begin                : August 2021
    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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsannotationitem.h"
 
#include "qgsannotationitemnode.h"
#include "qgsapplication.h"
#include "qgscalloutsregistry.h"
#include "qgspainting.h"
#include "qgsrendercontext.h"
#include "qgssymbollayerutils.h"
#include "qgsunittypes.h"
 
#include <QPainter>
#include <QString>
#include <QTransform>
 
using namespace Qt::StringLiterals;
 
QgsAnnotationItem::QgsAnnotationItem() = default;
 
QgsAnnotationItem::~QgsAnnotationItem() = default;
 
Qgis::AnnotationItemFlags QgsAnnotationItem::flags() const
{
  return Qgis::AnnotationItemFlags();
}
 
Qgis::AnnotationItemEditOperationResult QgsAnnotationItem::applyEdit( QgsAbstractAnnotationItemEditOperation * )
{
  return Qgis::AnnotationItemEditOperationResult::Invalid;
}
 
Qgis::AnnotationItemEditOperationResult QgsAnnotationItem::applyEditV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext & )
{
  Q_NOWARN_DEPRECATED_PUSH
  return applyEdit( operation );
  Q_NOWARN_DEPRECATED_POP
}
 
QgsAnnotationItemEditOperationTransientResults *QgsAnnotationItem::transientEditResults( QgsAbstractAnnotationItemEditOperation * )
{
  return nullptr;
}
 
QgsAnnotationItemEditOperationTransientResults *QgsAnnotationItem::transientEditResultsV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext & )
{
  Q_NOWARN_DEPRECATED_PUSH
  return transientEditResults( operation );
  Q_NOWARN_DEPRECATED_POP
}
 
QList<QgsAnnotationItemNode> QgsAnnotationItem::nodes() const
{
  return {};
}
 
QList<QgsAnnotationItemNode> QgsAnnotationItem::nodesV2( const QgsAnnotationItemEditContext & ) const
{
  Q_NOWARN_DEPRECATED_PUSH
  return nodes();
  Q_NOWARN_DEPRECATED_POP
}
 
QgsCallout *QgsAnnotationItem::callout() const
{
  return mCallout.get();
}
 
void QgsAnnotationItem::setCallout( QgsCallout *callout )
{
  mCallout.reset( callout );
}
 
QgsGeometry QgsAnnotationItem::calloutAnchor() const
{
  return mCalloutAnchor;
}
 
void QgsAnnotationItem::setCalloutAnchor( const QgsGeometry &anchor )
{
  mCalloutAnchor = anchor;
}
 
void QgsAnnotationItem::copyCommonProperties( const QgsAnnotationItem *other )
{
  setEnabled( other->enabled() );
  setZIndex( other->zIndex() );
  setUseSymbologyReferenceScale( other->useSymbologyReferenceScale() );
  setSymbologyReferenceScale( other->symbologyReferenceScale() );
  if ( QgsCallout *callout = other->callout() )
    setCallout( callout->clone() );
  else
    setCallout( nullptr );
  setCalloutAnchor( other->calloutAnchor() );
  setOffsetFromCallout( other->offsetFromCallout() );
  setOffsetFromCalloutUnit( other->offsetFromCalloutUnit() );
}
 
bool QgsAnnotationItem::writeCommonProperties( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context ) const
{
  element.setAttribute( u"enabled"_s, static_cast<int>( enabled() ) );
  element.setAttribute( u"zIndex"_s, zIndex() );
  element.setAttribute( u"useReferenceScale"_s, useSymbologyReferenceScale() ? u"1"_s : u"0"_s );
  element.setAttribute( u"referenceScale"_s, qgsDoubleToString( symbologyReferenceScale() ) );
 
  if ( mCallout )
  {
    element.setAttribute( u"calloutType"_s, mCallout->type() );
    mCallout->saveProperties( doc, element, context );
  }
  if ( !mCalloutAnchor.isEmpty() )
  {
    element.setAttribute( u"calloutAnchor"_s, mCalloutAnchor.asWkt() );
  }
  if ( mOffsetFromCallout.isValid() )
  {
    element.setAttribute( u"offsetFromCallout"_s, QgsSymbolLayerUtils::encodeSize( mOffsetFromCallout ) );
    element.setAttribute( u"offsetFromCalloutUnit"_s, QgsUnitTypes::encodeUnit( mOffsetFromCalloutUnit ) );
  }
  return true;
}
 
bool QgsAnnotationItem::readCommonProperties( const QDomElement &element, const QgsReadWriteContext &context )
{
  setEnabled( element.attribute( u"enabled"_s, u"1"_s ).toInt() );
  setZIndex( element.attribute( u"zIndex"_s ).toInt() );
  setUseSymbologyReferenceScale( element.attribute( u"useReferenceScale"_s, u"0"_s ).toInt() );
  setSymbologyReferenceScale( element.attribute( u"referenceScale"_s ).toDouble() );
 
  const QString calloutType = element.attribute( u"calloutType"_s );
  if ( calloutType.isEmpty() )
  {
    mCallout.reset();
  }
  else
  {
    mCallout = QgsApplication::calloutRegistry()->createCallout( calloutType, element.firstChildElement( u"callout"_s ), context );
    if ( !mCallout )
      mCallout = QgsCalloutRegistry::defaultCallout();
  }
 
  const QString calloutAnchorWkt = element.attribute( u"calloutAnchor"_s );
  setCalloutAnchor( calloutAnchorWkt.isEmpty() ? QgsGeometry() : QgsGeometry::fromWkt( calloutAnchorWkt ) );
 
  mOffsetFromCallout = element.attribute( u"offsetFromCallout"_s ).isEmpty() ? QSizeF() : QgsSymbolLayerUtils::decodeSize( element.attribute( u"offsetFromCallout"_s ) );
  bool ok = false;
  mOffsetFromCalloutUnit = QgsUnitTypes::decodeRenderUnit( element.attribute( u"offsetFromCalloutUnit"_s ), &ok );
  if ( !ok )
    mOffsetFromCalloutUnit = Qgis::RenderUnit::Millimeters;
 
  return true;
}
 
void QgsAnnotationItem::renderCallout( QgsRenderContext &context, const QRectF &rect, double angle, QgsCallout::QgsCalloutContext &calloutContext, QgsFeedback * )
{
  if ( !mCallout || mCalloutAnchor.isEmpty() )
    return;
 
  // anchor must be in painter coordinates
  QgsGeometry anchor = mCalloutAnchor;
  if ( context.coordinateTransform().isValid() )
  {
    try
    {
      anchor.transform( context.coordinateTransform() );
    }
    catch ( QgsCsException & )
    {
      return;
    }
  }
  anchor.transform( context.mapToPixel().transform() );
 
  // Rotate the painter with the item, but counter-rotate the anchor so the
  // callout still points to its anchor on screen.
  QPainter *painter = context.painter();
  const bool rotated = !qgsDoubleNear( angle, 0 );
 
  QgsScopedQPainterState painterState( painter, QgsScopedQPainterState::InitialState::NoSave );
  if ( rotated )
  {
    const QPointF center = rect.center();
    QTransform anchorTransform;
    anchorTransform.translate( center.x(), center.y() );
    anchorTransform.rotate( -angle );
    anchorTransform.translate( -center.x(), -center.y() );
    anchor.transform( anchorTransform );
 
    painterState.save();
    QgsPainting::rotatePainterAroundPoint( painter, center, angle );
  }
 
  mCallout->startRender( context );
  mCallout->render( context, rect, 0, anchor, calloutContext );
  mCallout->stopRender( context );
}
 
Qgis::RenderUnit QgsAnnotationItem::offsetFromCalloutUnit() const
{
  return mOffsetFromCalloutUnit;
}
 
void QgsAnnotationItem::setOffsetFromCalloutUnit( Qgis::RenderUnit unit )
{
  mOffsetFromCalloutUnit = unit;
}
 
QSizeF QgsAnnotationItem::offsetFromCallout() const
{
  return mOffsetFromCallout;
}
 
void QgsAnnotationItem::setOffsetFromCallout( const QSizeF &offset )
{
  mOffsetFromCallout = offset;
}