35#include "moc_qgsannotationlayer.cpp"
38class QgsAnnotationLayerSpatialIndex :
public RTree<QString, float, 2, float>
42 void insert(
const QString &uuid,
const QgsRectangle &bounds )
44 std::array< float, 4 > scaledBounds = scaleBounds( bounds );
47 scaledBounds[0], scaledBounds[ 1]
51 scaledBounds[2], scaledBounds[ 3]
65 void remove(
const QString &uuid,
const QgsRectangle &bounds )
67 std::array< float, 4 > scaledBounds = scaleBounds( bounds );
70 scaledBounds[0], scaledBounds[ 1]
74 scaledBounds[2], scaledBounds[ 3]
87 bool intersects(
const QgsRectangle &bounds,
const std::function<
bool(
const QString &uuid )> &callback )
const
89 std::array< float, 4 > scaledBounds = scaleBounds( bounds );
92 scaledBounds[0], scaledBounds[ 1]
96 scaledBounds[2], scaledBounds[ 3]
105 std::array<float, 4> scaleBounds(
const QgsRectangle &bounds )
const
109 static_cast< float >( bounds.
xMinimum() ),
110 static_cast< float >( bounds.
yMinimum() ),
111 static_cast< float >( bounds.
xMaximum() ),
112 static_cast< float >( bounds.
yMaximum() )
121 , mSpatialIndex( std::make_unique< QgsAnnotationLayerSpatialIndex >() )
131 mPaintEffect->setEnabled(
false );
137 qDeleteAll( mItems );
158 const QString uuid = QUuid::createUuid().toString();
159 mItems.insert( uuid,
item );
161 mNonIndexedItems.insert( uuid );
163 mSpatialIndex->insert( uuid,
item->boundingBox() );
174 std::unique_ptr< QgsAnnotationItem> prevItem( mItems.take(
id ) );
178 auto it = mNonIndexedItems.find(
id );
179 if ( it == mNonIndexedItems.end() )
181 mSpatialIndex->remove(
id, prevItem->boundingBox() );
185 mNonIndexedItems.erase( it );
189 mItems.insert(
id,
item );
191 mNonIndexedItems.insert(
id );
193 mSpatialIndex->insert(
id,
item->boundingBox() );
202 if ( !mItems.contains(
id ) )
205 std::unique_ptr< QgsAnnotationItem>
item( mItems.take(
id ) );
207 auto it = mNonIndexedItems.find(
id );
208 if ( it == mNonIndexedItems.end() )
210 mSpatialIndex->remove(
id,
item->boundingBox() );
214 mNonIndexedItems.erase( it );
228 qDeleteAll( mItems );
230 mSpatialIndex = std::make_unique< QgsAnnotationLayerSpatialIndex >();
231 mNonIndexedItems.clear();
240 return mItems.empty();
247 return mItems.value(
id );
256 mSpatialIndex->intersects( bounds, [&res, feedback](
const QString & uuid )->
bool
268 QStringList res = queryIndex( bounds, feedback );
270 for (
const QString &uuid : mNonIndexedItems )
272 auto it = mItems.constFind( uuid );
273 if ( it != mItems.constEnd() && it.value()->boundingBox( context ).intersects( bounds ) )
295 auto it = mNonIndexedItems.find( operation->
itemId() );
296 if ( it == mNonIndexedItems.end() )
298 mSpatialIndex->remove( operation->
itemId(), targetItem->boundingBox() );
300 res = targetItem->applyEditV2( operation, context );
308 mSpatialIndex->insert( operation->
itemId(), targetItem->boundingBox() );
313 delete mItems.take( operation->
itemId() );
314 mNonIndexedItems.remove( operation->
itemId() );
338 auto layer = std::make_unique< QgsAnnotationLayer >(
name(), options );
341 for (
auto it = mItems.constBegin(); it != mItems.constEnd(); ++it )
343 layer->mItems.insert( it.key(), ( *it )->clone() );
345 layer->mNonIndexedItems.insert( it.key() );
347 layer->mSpatialIndex->insert( it.key(), ( *it )->boundingBox() );
351 layer->setPaintEffect( mPaintEffect->clone() );
353 layer->mLinkedLayer = mLinkedLayer;
355 return layer.release();
370 for (
auto it = mItems.constBegin(); it != mItems.constEnd(); ++it )
374 rect = it.value()->boundingBox();
378 rect.combineExtentWith( it.value()->boundingBox() );
389 mDataProvider->setTransformContext( context );
391 mTransformContext = context;
405 readItems( layerNode, errorMsg, context );
409 const QString layerId = layerNode.toElement().attribute( QStringLiteral(
"linkedLayer" ) );
410 const QString layerName = layerNode.toElement().attribute( QStringLiteral(
"linkedLayerName" ) );
411 const QString layerSource = layerNode.toElement().attribute( QStringLiteral(
"linkedLayerSource" ) );
412 const QString layerProvider = layerNode.toElement().attribute( QStringLiteral(
"linkedLayerProvider" ) );
413 mLinkedLayer =
QgsMapLayerRef( layerId, layerName, layerSource, layerProvider );
426 QDomElement mapLayerNode = layer_node.toElement();
428 if ( mapLayerNode.isNull() )
438 mapLayerNode.setAttribute( QStringLiteral(
"linkedLayer" ), mLinkedLayer.layerId );
439 mapLayerNode.setAttribute( QStringLiteral(
"linkedLayerName" ), mLinkedLayer.name );
440 mapLayerNode.setAttribute( QStringLiteral(
"linkedLayerSource" ), mLinkedLayer.source );
441 mapLayerNode.setAttribute( QStringLiteral(
"linkedLayerProvider" ), mLinkedLayer.provider );
445 writeItems( layer_node, doc, errorMsg, context );
455 QDomElement layerElement = node.toElement();
461 QDomElement layerOpacityElem = doc.createElement( QStringLiteral(
"layerOpacity" ) );
462 const QDomText layerOpacityText = doc.createTextNode( QString::number(
opacity() ) );
463 layerOpacityElem.appendChild( layerOpacityText );
464 node.appendChild( layerOpacityElem );
470 QDomElement blendModeElem = doc.createElement( QStringLiteral(
"blendMode" ) );
472 blendModeElem.appendChild( blendModeText );
473 node.appendChild( blendModeElem );
475 QDomElement paintEffectElem = doc.createElement( QStringLiteral(
"paintEffect" ) );
477 mPaintEffect->saveProperties( doc, paintEffectElem );
478 node.appendChild( paintEffectElem );
488 const QDomElement layerElement = node.toElement();
493 const QDomNode layerOpacityNode = node.namedItem( QStringLiteral(
"layerOpacity" ) );
494 if ( !layerOpacityNode.isNull() )
496 const QDomElement e = layerOpacityNode.toElement();
504 const QDomNode blendModeNode = node.namedItem( QStringLiteral(
"blendMode" ) );
505 if ( !blendModeNode.isNull() )
507 const QDomElement e = blendModeNode.toElement();
512 const QDomNode paintEffectNode = node.namedItem( QStringLiteral(
"paintEffect" ) );
513 if ( !paintEffectNode.isNull() )
515 const QDomElement effectElem = paintEffectNode.firstChildElement( QStringLiteral(
"effect" ) );
516 if ( !effectElem.isNull() )
530 QDomElement itemsElement = doc.createElement( QStringLiteral(
"items" ) );
532 for (
auto it = mItems.constBegin(); it != mItems.constEnd(); ++it )
534 QDomElement itemElement = doc.createElement( QStringLiteral(
"item" ) );
535 itemElement.setAttribute( QStringLiteral(
"type" ), ( *it )->type() );
536 itemElement.setAttribute( QStringLiteral(
"id" ), it.key() );
537 ( *it )->writeXml( itemElement, doc, context );
538 itemsElement.appendChild( itemElement );
540 node.appendChild( itemsElement );
549 qDeleteAll( mItems );
551 mSpatialIndex = std::make_unique< QgsAnnotationLayerSpatialIndex >();
552 mNonIndexedItems.clear();
554 const QDomNodeList itemsElements = node.toElement().elementsByTagName( QStringLiteral(
"items" ) );
555 if ( itemsElements.size() == 0 )
558 const QDomNodeList
items = itemsElements.at( 0 ).childNodes();
559 for (
int i = 0; i <
items.size(); ++i )
561 const QDomElement itemElement =
items.at( i ).toElement();
562 const QString
id = itemElement.attribute( QStringLiteral(
"id" ) );
563 const QString
type = itemElement.attribute( QStringLiteral(
"type" ) );
567 item->readXml( itemElement, context );
569 mNonIndexedItems.insert(
id );
571 mSpatialIndex->insert(
id,
item->boundingBox() );
572 mItems.insert(
id,
item.release() );
583 writeItems( node, doc, errorMessage, context, categories );
585 return writeSymbology( node, doc, errorMessage, context, categories );
592 readItems( node, errorMessage, context, categories );
594 return readSymbology( node, errorMessage, context, categories );
616 return mDataProvider.get();
623 return mDataProvider.get();
630 QString
metadata = QStringLiteral(
"<html>\n<body>\n<h1>" ) + tr(
"General" ) + QStringLiteral(
"</h1>\n<hr>\n" ) + QStringLiteral(
"<table class=\"list-view\">\n" );
632 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Name" ) + QStringLiteral(
"</td><td>" ) +
name() + QStringLiteral(
"</td></tr>\n" );
635 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" ) + tr(
"Extent" ) + QStringLiteral(
"</td><td>" ) +
extent().
toString() + QStringLiteral(
"</td></tr>\n" );
638 QLocale locale = QLocale();
639 locale.setNumberOptions( locale.numberOptions() &= ~QLocale::NumberOption::OmitGroupSeparator );
640 const int itemCount = mItems.size();
641 metadata += QStringLiteral(
"<tr><td class=\"highlight\">" )
642 + tr(
"Item count" ) + QStringLiteral(
"</td><td>" )
643 + locale.toString(
static_cast<qlonglong
>( itemCount ) )
644 + QStringLiteral(
"</td></tr>\n" );
645 metadata += QLatin1String(
"</table>\n<br><br>" );
651 metadata += QStringLiteral(
"<h1>" ) + tr(
"Items" ) + QStringLiteral(
"</h1>\n<hr>\n" );
653 metadata += QLatin1String(
"<table width=\"100%\" class=\"tabular-view\">\n" );
654 metadata += QLatin1String(
"<tr><th>" ) + tr(
"Type" ) + QLatin1String(
"</th><th>" ) + tr(
"Count" ) + QLatin1String(
"</th></tr>\n" );
656 QMap< QString, int > itemCounts;
657 for (
auto it = mItems.constBegin(); it != mItems.constEnd(); ++it )
659 itemCounts[ it.value()->type() ]++;
664 for (
auto it = itemTypes.begin(); it != itemTypes.end(); ++it )
668 rowClass = QStringLiteral(
"class=\"odd-row\"" );
669 metadata += QLatin1String(
"<tr " ) + rowClass + QLatin1String(
"><td>" ) + it.value() + QLatin1String(
"</td><td>" ) + locale.toString(
static_cast<qlonglong
>( itemCounts.value( it.key() ) ) ) + QLatin1String(
"</td></tr>\n" );
673 metadata += QLatin1String(
"</table>\n<br><br>" );
675 metadata += QLatin1String(
"\n</body>\n</html>\n" );
681 mLinkedLayer.resolve(
project );
688 return mPaintEffect.get();
695 mPaintEffect.reset( effect );
702 return mLinkedLayer.get();
709 mLinkedLayer.setLayer( layer );
718QgsAnnotationLayerDataProvider::QgsAnnotationLayerDataProvider(
719 const ProviderOptions &options,
731QString QgsAnnotationLayerDataProvider::name()
const
735 return QStringLiteral(
"annotation" );
738QString QgsAnnotationLayerDataProvider::description()
const
745QgsRectangle QgsAnnotationLayerDataProvider::extent()
const
752bool QgsAnnotationLayerDataProvider::isValid()
const
Provides global constants and enumerations for use throughout the application.
@ UsersCannotToggleEditing
Indicates that users are not allowed to toggle editing for this layer. Note that this does not imply ...
@ ScaleDependentBoundingBox
Item's bounding box will vary depending on map scale.
AnnotationItemEditOperationResult
Results from an edit operation on an annotation item.
@ Invalid
Operation has invalid parameters for the item, no change occurred.
@ Success
Item was modified successfully.
@ ItemCleared
The operation results in the item being cleared, and the item should be removed from the layer as a r...
BlendMode
Blending modes defining the available composition modes that can be used when painting.
QFlags< DataProviderReadFlag > DataProviderReadFlags
Flags which control data provider construction.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
QFlags< MapLayerProperty > MapLayerProperties
Map layer properties.
Abstract base class for annotation item edit operations.
QString itemId() const
Returns the associated item ID.
Encapsulates the context for an annotation item edit operation.
QMap< QString, QString > itemTypes() const
Returns a map of available item types to translated name.
Abstract base class for annotation items which are drawn with QgsAnnotationLayers.
QgsRectangle extent() const override
Returns the extent of the layer.
bool writeSymbology(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &, StyleCategories categories=AllStyleCategories) const override
Write the style for the layer into the document provided.
void resolveReferences(QgsProject *project) override
Resolve references to other layers (kept as layer IDs after reading XML) into layer objects.
bool readSymbology(const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) override
Read the symbology for the current layer from the DOM node supplied.
bool readStyle(const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories) override
Read the style for the current layer from the DOM node supplied.
void clear()
Removes all items from the layer.
QgsDataProvider * dataProvider() override
Returns the layer's data provider, it may be nullptr.
QgsMapLayerRenderer * createMapRenderer(QgsRenderContext &rendererContext) override
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.
bool isEditable() const override
Returns true if the layer can be edited.
bool removeItem(const QString &id)
Removes (and deletes) the item with matching id.
QStringList itemsInBounds(const QgsRectangle &bounds, QgsRenderContext &context, QgsFeedback *feedback=nullptr) const
Returns a list of the IDs of all annotation items within the specified bounds (in layer CRS),...
void setTransformContext(const QgsCoordinateTransformContext &context) override
Sets the coordinate transform context to transformContext.
Q_DECL_DEPRECATED Qgis::AnnotationItemEditOperationResult applyEdit(QgsAbstractAnnotationItemEditOperation *operation)
Applies an edit operation to the layer.
void setPaintEffect(QgsPaintEffect *effect)
Sets the current paint effect for the layer.
void setLinkedVisibilityLayer(QgsMapLayer *layer)
Sets a linked layer, where the items in this annotation layer will only be visible when the linked la...
QgsPaintEffect * paintEffect() const
Returns the current paint effect for the layer.
void replaceItem(const QString &id, QgsAnnotationItem *item)
Replaces the existing item with matching id with a new item.
Qgis::AnnotationItemEditOperationResult applyEditV2(QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context)
Applies an edit operation to the layer.
QgsAnnotationLayer * clone() const override
Returns a new instance equivalent to this one except for the id which is still unique.
friend class QgsAnnotationLayerRenderer
bool supportsEditing() const override
Returns whether the layer supports editing or not.
void reset()
Resets the annotation layer to a default state, and clears all items from it.
QString addItem(QgsAnnotationItem *item)
Adds an item to the layer.
QgsMapLayer * linkedVisibilityLayer()
Returns a linked layer, where the items in this annotation layer will only be visible when the linked...
QString htmlMetadata() const override
Obtain a formatted HTML string containing assorted metadata for this layer.
Qgis::MapLayerProperties properties() const override
Returns the map layer properties of this layer.
bool isEmpty() const
Returns true if the annotation layer is empty and contains no annotations.
QgsAnnotationItem * item(const QString &id) const
Returns the item with the specified id, or nullptr if no matching item was found.
~QgsAnnotationLayer() override
bool writeXml(QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context) const override
Called by writeLayerXML(), used by children to write state specific to them to project files.
bool readXml(const QDomNode &layerNode, QgsReadWriteContext &context) override
Called by readLayerXML(), used by children to read state specific to them from project files.
QgsAnnotationLayer(const QString &name, const QgsAnnotationLayer::LayerOptions &options)
Constructor for a new QgsAnnotationLayer with the specified layer name.
QMap< QString, QgsAnnotationItem * > items() const
Returns a map of items contained in the layer, by unique item ID.
bool writeStyle(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories) const override
Write just the symbology information for the layer into the document.
static QgsAnnotationItemRegistry * annotationItemRegistry()
Returns the application's annotation item registry, used for annotation item types.
static QgsPaintEffectRegistry * paintEffectRegistry()
Returns the application's paint effect registry, used for managing paint effects.
Represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
Abstract base class for spatial data provider implementations.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
bool isCanceled() const
Tells whether the operation has been canceled already.
static QString typeToString(Qgis::LayerType type)
Converts a map layer type to a string value.
Base class for utility classes that encapsulate information necessary for rendering of map layers.
void setBlendMode(QPainter::CompositionMode blendMode)
Set the blending mode used for rendering a layer.
void triggerRepaint(bool deferredUpdate=false)
Will advise the map canvas (and any other interested party) that this layer requires to be repainted.
QString crsHtmlMetadata() const
Returns a HTML fragment containing the layer's CRS metadata, for use in the htmlMetadata() method.
QgsLayerMetadata metadata
QgsMapLayer(Qgis::LayerType type=Qgis::LayerType::Vector, const QString &name=QString(), const QString &source=QString())
Constructor for QgsMapLayer.
QPainter::CompositionMode blendMode() const
Returns the current blending mode for a layer.
virtual void setOpacity(double opacity)
Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1....
QFlags< StyleCategory > StyleCategories
QgsCoordinateTransformContext transformContext() const
Returns the layer data provider coordinate transform context or a default transform context if the la...
QUndoStack * undoStackStyles()
Returns pointer to layer's style undo stack.
void willBeDeleted()
Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid...
virtual QgsMapLayer * clone() const =0
Returns a new instance equivalent to this one except for the id which is still unique.
@ FlagDontResolveLayers
Don't resolve layer paths or create data providers for layers.
void readCommonStyle(const QDomElement &layerElement, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories)
Read style data common to all layer types.
QgsMapLayer::ReadFlags mReadFlags
Read flags. It's up to the subclass to respect these when restoring state from XML.
QgsProject * project() const
Returns the parent project if this map layer is added to a project.
bool mValid
Indicates if the layer is valid and can be drawn.
@ Rendering
Rendering: scale visibility, simplify method, opacity.
void writeCommonStyle(QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const
Write style data common to all layer types.
void invalidateWgs84Extent()
Invalidates the WGS84 extent.
bool mShouldValidateCrs
true if the layer's CRS should be validated and invalid CRSes are not permitted.
void setCrs(const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
Sets layer's spatial reference system.
static QgsPaintEffect * defaultStack()
Returns a new effect stack consisting of a sensible selection of default effects.
static bool isDefaultStack(QgsPaintEffect *effect)
Tests whether a paint effect matches the default effects stack.
Base class for visual effects which can be applied to QPicture drawings.
static Qgis::BlendMode getBlendModeEnum(QPainter::CompositionMode blendMode)
Returns a Qgis::BlendMode corresponding to a QPainter::CompositionMode.
static QPainter::CompositionMode getCompositionMode(Qgis::BlendMode blendMode)
Returns a QPainter::CompositionMode corresponding to a Qgis::BlendMode.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
A container for the context for various read/write operations on objects.
A rectangle specified with double values.
Q_INVOKABLE QString toString(int precision=16) const
Returns a string representation of form xmin,ymin : xmax,ymax Coordinates will be truncated to the sp...
Contains information about the context of a rendering operation.
#define QgsDebugMsgLevel(str, level)
_LayerRef< QgsMapLayer > QgsMapLayerRef
#define QGIS_PROTECT_QOBJECT_THREAD_ACCESS
Setting options for loading annotation layers.
QgsCoordinateTransformContext transformContext
Coordinate transform context.
Setting options for creating vector data providers.
QgsCoordinateTransformContext transformContext
Coordinate transform context.