add template method to return specific type of layers in map canvas (#…

…58878) * add template method to return specific type of layers in map canvas * Apply suggestions from code review Co-authored-by: Matthias Kuhn <matthias@opengis.ch> --------- Co-authored-by: Matthias Kuhn <matthias@opengis.ch>
qgis · Sep 26, 2024 · 590232d · 590232d
1 parent da1f55b
commit 590232d
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 0 deletions.
diff --git a/python/PyQt6/core/auto_generated/qgsmapsettings.sip.in b/python/PyQt6/core/auto_generated/qgsmapsettings.sip.in
@@ -253,6 +253,8 @@ all their child layers.
 .. seealso:: :py:func:`layerIds`
 %End
 
+
+
     void setLayers( const QList<QgsMapLayer *> &layers );
 %Docstring
 Sets the list of ``layers`` to render in the map.

diff --git a/python/PyQt6/gui/auto_generated/qgsmapcanvas.sip.in b/python/PyQt6/gui/auto_generated/qgsmapcanvas.sip.in
@@ -464,6 +464,7 @@ all their child layers.
 .. seealso:: :py:func:`setLayers`
 %End
 
+
     void freeze( bool frozen = true );
 %Docstring
 Freeze/thaw the map canvas. This is used to prevent the canvas from

diff --git a/python/core/auto_generated/qgsmapsettings.sip.in b/python/core/auto_generated/qgsmapsettings.sip.in
@@ -253,6 +253,8 @@ all their child layers.
 .. seealso:: :py:func:`layerIds`
 %End
 
+
+
     void setLayers( const QList<QgsMapLayer *> &layers );
 %Docstring
 Sets the list of ``layers`` to render in the map.

diff --git a/python/gui/auto_generated/qgsmapcanvas.sip.in b/python/gui/auto_generated/qgsmapcanvas.sip.in
@@ -464,6 +464,7 @@ all their child layers.
 .. seealso:: :py:func:`setLayers`
 %End
 
+
     void freeze( bool frozen = true );
 %Docstring
 Freeze/thaw the map canvas. This is used to prevent the canvas from

diff --git a/src/core/qgsmapsettings.cpp b/src/core/qgsmapsettings.cpp
@@ -323,6 +323,23 @@ QList<QgsMapLayer *> QgsMapSettings::layers( bool expandGroupLayers ) const
   return result;
 }
 
+template<typename T>
+QVector<T> QgsMapSettings::layers() const
+{
+  const QList<QgsMapLayer *> actualLayers = _qgis_listQPointerToRaw( mLayers );
+
+  QVector<T> layers;
+  for ( QgsMapLayer *layer : actualLayers )
+  {
+    T tLayer = qobject_cast<T>( layer );
+    if ( tLayer )
+    {
+      layers << tLayer;
+    }
+  }
+  return layers;
+}
+
 void QgsMapSettings::setLayers( const QList<QgsMapLayer *> &layers )
 {
   // filter list, removing null layers and non-spatial layers
@@ -898,3 +915,4 @@ void QgsMapSettings::setElevationShadingRenderer( const QgsElevationShadingRende
 {
   mShadingRenderer = elevationShadingRenderer;
 }
+
diff --git a/src/core/qgsmapsettings.h b/src/core/qgsmapsettings.h
@@ -263,6 +263,18 @@ class CORE_EXPORT QgsMapSettings : public QgsTemporalRangeObject
      */
     QList<QgsMapLayer *> layers( bool expandGroupLayers = false ) const;
 
+
+#ifndef SIP_RUN
+    /**
+     * Returns a list of registered map layers with a specified layer type.
+     *
+     * \note not available in Python bindings
+     * \since QGIS 3.40
+     */
+    template <typename T>
+    QVector<T> layers() const;
+#endif
+
     /**
      * Sets the list of \a layers to render in the map.
      *

diff --git a/src/gui/qgsmapcanvas.h b/src/gui/qgsmapcanvas.h
@@ -507,6 +507,17 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView, public QgsExpressionContex
      */
     QList<QgsMapLayer *> layers( bool expandGroupLayers = false ) const;
 
+#ifndef SIP_RUN
+    /**
+     * Returns a list of registered map layers with a specified layer type.
+     *
+     * \note not available in Python bindings
+     * \since QGIS 3.40
+     */
+    template <typename T>
+    QVector<T> layers() const {return mapSettings().layers<T>();}
+#endif
+
     /**
      * Freeze/thaw the map canvas. This is used to prevent the canvas from
      * responding to events while layers are being added/removed etc.