36#include "moc_qgsannotationlayer.cpp"
38using namespace Qt::StringLiterals;
41class QgsAnnotationLayerSpatialIndex :
public RTree<QString, float, 2, float>
45 void insert(
const QString &uuid,
const QgsRectangle &bounds )
47 std::array< float, 4 > scaledBounds = scaleBounds( bounds );
50 scaledBounds[0], scaledBounds[ 1]
54 scaledBounds[2], scaledBounds[ 3]
68 void remove(
const QString &uuid,
const QgsRectangle &bounds )
70 std::array< float, 4 > scaledBounds = scaleBounds( bounds );
73 scaledBounds[0], scaledBounds[ 1]
77 scaledBounds[2], scaledBounds[ 3]
90 bool intersects(
const QgsRectangle &bounds,
const std::function<
bool(
const QString &uuid )> &callback )
const
92 std::array< float, 4 > scaledBounds = scaleBounds( bounds );
95 scaledBounds[0], scaledBounds[ 1]
99 scaledBounds[2], scaledBounds[ 3]
108 std::array<float, 4> scaleBounds(
const QgsRectangle &bounds )
const
112 static_cast< float >( bounds.
xMinimum() ),
113 static_cast< float >( bounds.
yMinimum() ),
114 static_cast< float >( bounds.
xMaximum() ),
115 static_cast< float >( bounds.
yMaximum() )
124 , mSpatialIndex( std::make_unique< QgsAnnotationLayerSpatialIndex >() )
134 mPaintEffect->setEnabled(
false );
140 qDeleteAll( mItems );
161 const QString uuid = QUuid::createUuid().toString();
162 mItems.insert( uuid,
item );
164 mNonIndexedItems.insert( uuid );
166 mSpatialIndex->insert( uuid,
item->boundingBox() );
177 std::unique_ptr< QgsAnnotationItem> prevItem( mItems.take(
id ) );
181 auto it = mNonIndexedItems.find(
id );
182 if ( it == mNonIndexedItems.end() )
184 mSpatialIndex->remove(
id, prevItem->boundingBox() );
188 mNonIndexedItems.erase( it );
192 mItems.insert(
id,
item );
194 mNonIndexedItems.insert(
id );
196 mSpatialIndex->insert(
id,
item->boundingBox() );
205 if ( !mItems.contains(
id ) )
208 std::unique_ptr< QgsAnnotationItem>
item( mItems.take(
id ) );
210 auto it = mNonIndexedItems.find(
id );
211 if ( it == mNonIndexedItems.end() )
213 mSpatialIndex->remove(
id,
item->boundingBox() );
217 mNonIndexedItems.erase( it );
231 qDeleteAll( mItems );
233 mSpatialIndex = std::make_unique< QgsAnnotationLayerSpatialIndex >();
234 mNonIndexedItems.clear();
243 return mItems.empty();
250 return mItems.value(
id );
259 mSpatialIndex->intersects( bounds, [&res, feedback](
const QString & uuid )->
bool
271 QStringList res = queryIndex( bounds, feedback );
273 for (
const QString &uuid : mNonIndexedItems )
275 auto it = mItems.constFind( uuid );
276 if ( it != mItems.constEnd() && it.value()->boundingBox( context ).intersects( bounds ) )
298 auto it = mNonIndexedItems.find( operation->
itemId() );
299 if ( it == mNonIndexedItems.end() )
301 mSpatialIndex->remove( operation->
itemId(), targetItem->boundingBox() );
303 res = targetItem->applyEditV2( operation, context );
311 mSpatialIndex->insert( operation->
itemId(), targetItem->boundingBox() );
316 delete mItems.take( operation->
itemId() );
317 mNonIndexedItems.remove( operation->
itemId() );
341 auto layer = std::make_unique< QgsAnnotationLayer >(
name(), options );
344 for (
auto it = mItems.constBegin(); it != mItems.constEnd(); ++it )
346 layer->mItems.insert( it.key(), ( *it )->clone() );
348 layer->mNonIndexedItems.insert( it.key() );
350 layer->mSpatialIndex->insert( it.key(), ( *it )->boundingBox() );
354 layer->setPaintEffect( mPaintEffect->clone() );
356 layer->mLinkedLayer = mLinkedLayer;
358 return layer.release();
373 for (
auto it = mItems.constBegin(); it != mItems.constEnd(); ++it )
377 rect = it.value()->boundingBox();
381 rect.combineExtentWith( it.value()->boundingBox() );
392 mDataProvider->setTransformContext( context );
394 mTransformContext = context;
408 readItems( layerNode, errorMsg, context );
412 const QString layerId = layerNode.toElement().attribute( u
"linkedLayer"_s );
413 const QString layerName = layerNode.toElement().attribute( u
"linkedLayerName"_s );
414 const QString layerSource = layerNode.toElement().attribute( u
"linkedLayerSource"_s );
415 const QString layerProvider = layerNode.toElement().attribute( u
"linkedLayerProvider"_s );
416 mLinkedLayer =
QgsMapLayerRef( layerId, layerName, layerSource, layerProvider );
429 QDomElement mapLayerNode = layer_node.toElement();
431 if ( mapLayerNode.isNull() )
441 mapLayerNode.setAttribute( u
"linkedLayer"_s, mLinkedLayer.layerId );
442 mapLayerNode.setAttribute( u
"linkedLayerName"_s, mLinkedLayer.name );
443 mapLayerNode.setAttribute( u
"linkedLayerSource"_s, mLinkedLayer.source );
444 mapLayerNode.setAttribute( u
"linkedLayerProvider"_s, mLinkedLayer.provider );
448 writeItems( layer_node, doc, errorMsg, context );
458 QDomElement layerElement = node.toElement();
464 QDomElement layerOpacityElem = doc.createElement( u
"layerOpacity"_s );
465 const QDomText layerOpacityText = doc.createTextNode( QString::number(
opacity() ) );
466 layerOpacityElem.appendChild( layerOpacityText );
467 node.appendChild( layerOpacityElem );
473 QDomElement blendModeElem = doc.createElement( u
"blendMode"_s );
475 blendModeElem.appendChild( blendModeText );
476 node.appendChild( blendModeElem );
478 QDomElement paintEffectElem = doc.createElement( u
"paintEffect"_s );
480 mPaintEffect->saveProperties( doc, paintEffectElem );
481 node.appendChild( paintEffectElem );
491 const QDomElement layerElement = node.toElement();
496 const QDomNode layerOpacityNode = node.namedItem( u
"layerOpacity"_s );
497 if ( !layerOpacityNode.isNull() )
499 const QDomElement e = layerOpacityNode.toElement();
507 const QDomNode blendModeNode = node.namedItem( u
"blendMode"_s );
508 if ( !blendModeNode.isNull() )
510 const QDomElement e = blendModeNode.toElement();
515 const QDomNode paintEffectNode = node.namedItem( u
"paintEffect"_s );
516 if ( !paintEffectNode.isNull() )
518 const QDomElement effectElem = paintEffectNode.firstChildElement( u
"effect"_s );
519 if ( !effectElem.isNull() )
533 QDomElement itemsElement = doc.createElement( u
"items"_s );
535 for (
auto it = mItems.constBegin(); it != mItems.constEnd(); ++it )
537 QDomElement itemElement = doc.createElement( u
"item"_s );
538 itemElement.setAttribute( u
"type"_s, ( *it )->type() );
539 itemElement.setAttribute( u
"id"_s, it.key() );
540 ( *it )->writeXml( itemElement, doc, context );
541 itemsElement.appendChild( itemElement );
543 node.appendChild( itemsElement );
552 qDeleteAll( mItems );
554 mSpatialIndex = std::make_unique< QgsAnnotationLayerSpatialIndex >();
555 mNonIndexedItems.clear();
557 const QDomNodeList itemsElements = node.toElement().elementsByTagName( u
"items"_s );
558 if ( itemsElements.size() == 0 )
561 const QDomNodeList
items = itemsElements.at( 0 ).childNodes();
562 for (
int i = 0; i <
items.size(); ++i )
564 const QDomElement itemElement =
items.at( i ).toElement();
565 const QString
id = itemElement.attribute( u
"id"_s );
566 const QString
type = itemElement.attribute( u
"type"_s );
570 item->readXml( itemElement, context );
572 mNonIndexedItems.insert(
id );
574 mSpatialIndex->insert(
id,
item->boundingBox() );
575 mItems.insert(
id,
item.release() );
586 writeItems( node, doc, errorMessage, context, categories );
588 return writeSymbology( node, doc, errorMessage, context, categories );
595 readItems( node, errorMessage, context, categories );
597 return readSymbology( node, errorMessage, context, categories );
619 return mDataProvider.get();
626 return mDataProvider.get();
633 QString
metadata = u
"<html>\n<body>\n<h1>"_s + tr(
"General" ) + u
"</h1>\n<hr>\n"_s + u
"<table class=\"list-view\">\n"_s;
635 metadata += u
"<tr><td class=\"highlight\">"_s + tr(
"Name" ) + u
"</td><td>"_s +
name() + u
"</td></tr>\n"_s;
638 metadata += u
"<tr><td class=\"highlight\">"_s + tr(
"Extent" ) + u
"</td><td>"_s +
extent().
toString() + u
"</td></tr>\n"_s;
641 QLocale locale = QLocale();
642 locale.setNumberOptions( locale.numberOptions() &= ~QLocale::NumberOption::OmitGroupSeparator );
643 const int itemCount = mItems.size();
644 metadata += u
"<tr><td class=\"highlight\">"_s
645 + tr(
"Item count" ) + u
"</td><td>"_s
646 + locale.toString(
static_cast<qlonglong
>( itemCount ) )
648 metadata +=
"</table>\n<br><br>"_L1;
654 metadata += u
"<h1>"_s + tr(
"Items" ) + u
"</h1>\n<hr>\n"_s;
656 metadata +=
"<table width=\"100%\" class=\"tabular-view\">\n"_L1;
657 metadata +=
"<tr><th>"_L1 + tr(
"Type" ) +
"</th><th>"_L1 + tr(
"Count" ) +
"</th></tr>\n"_L1;
659 QMap< QString, int > itemCounts;
660 for (
auto it = mItems.constBegin(); it != mItems.constEnd(); ++it )
662 itemCounts[ it.value()->type() ]++;
667 for (
auto it = itemTypes.begin(); it != itemTypes.end(); ++it )
671 rowClass = u
"class=\"odd-row\""_s;
672 metadata +=
"<tr "_L1 + rowClass +
"><td>"_L1 + it.value() +
"</td><td>"_L1 + locale.toString(
static_cast<qlonglong
>( itemCounts.value( it.key() ) ) ) +
"</td></tr>\n"_L1;
676 metadata +=
"</table>\n<br><br>"_L1;
678 metadata +=
"\n</body>\n</html>\n"_L1;
684 mLinkedLayer.resolve(
project );
691 return mPaintEffect.get();
698 mPaintEffect.reset( effect );
705 return mLinkedLayer.get();
712 mLinkedLayer.setLayer( layer );
721QgsAnnotationLayerDataProvider::QgsAnnotationLayerDataProvider(
722 const ProviderOptions &options,
734QString QgsAnnotationLayerDataProvider::name()
const
738 return u
"annotation"_s;
741QString QgsAnnotationLayerDataProvider::description()
const
748QgsRectangle QgsAnnotationLayerDataProvider::extent()
const
755bool 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.