Merge pull request #4043 from nyalldawson/layer_composer_bridge

Bridge map canvas layers to composer map layers

Author: nyalldawson

doc/api_break.dox

@@ -660,7 +660,10 @@ to use the QgsProperty framework objects.
 QgsComposition        {#qgis_api_break_3_0_QgsComposition}
 --------------
 
-- constructor requires QgsProject instance as the second argument
+- The constructor no longer takes a reference to a QgsMapSettings object. This is no longer
+used by compositions. To set the layers to show in composer maps, the QgsComposerMap::setLayers()
+method should be used instead.
+- constructor requires QgsProject instance
 - addItemsFromXML() has been renamed to addItemsFromXml()
 - Constructor with QgsMapRenderer parameter has been removed. Use the variant with QgsMapSettings parameter.
 - mapRenderer() has been removed. Use mapSettings() instead.
@@ -674,6 +677,7 @@ were removed. Use setSnapTolerance() and snapTolerance() instead.
 - worldFileMap() and setWorldFileMap() have been renamed to referenceMap() and setReferenceMap()
 - dataDefinedProperty() and setDataDefinedProperty() now use the QgsProperty framework instead
 of QgsDataDefined objects.
+- mapSettings() was removed. Use QgsComposerMap::mapSettings() instead.
 
 
 QgsCoordinateReferenceSystem        {#qgis_api_break_3_0_QgsCoordinateReferenceSystem}

python/core/composer/qgscomposition.sip

@@ -40,7 +40,7 @@ class QgsComposition : QGraphicsScene, QgsExpressionContextGenerator
       Landscape
     };
 
-    explicit QgsComposition( const QgsMapSettings& mapSettings, QgsProject* project );
+    explicit QgsComposition( QgsProject* project );
 
     /** Composition atlas modes*/
     enum AtlasMode
@@ -366,10 +366,6 @@ class QgsComposition : QGraphicsScene, QgsExpressionContextGenerator
     /** Used to enable or disable advanced effects such as blend modes in a composition */
     void setUseAdvancedEffects( const bool effectsEnabled );
 
-    //! Return setting of QGIS map canvas
-    //! @note added in 2.4
-    const QgsMapSettings& mapSettings() const;
-
     QgsComposition::PlotStyle plotStyle() const;
     void setPlotStyle( const QgsComposition::PlotStyle style );
 

python/gui/layertree/qgslayertreemapcanvasbridge.sip

@@ -63,6 +63,7 @@ class QgsLayerTreeMapCanvasBridge : QObject
   signals:
     void hasCustomLayerOrderChanged( bool );
     void customLayerOrderChanged( const QStringList& order );
+    void canvasLayersChanged( const QList< QgsMapLayer* >& layers );
 
   protected:
 

src/app/composer/qgscomposer.cpp

@@ -547,7 +547,7 @@ QgsComposer::QgsComposer( QgisApp *qgis, const QString& title )
   connect( mActionShowRulers, SIGNAL( triggered( bool ) ), this, SLOT( toggleRulers( bool ) ) );
 
   //init undo/redo buttons
-  mComposition = new QgsComposition( mQgis->mapCanvas()->mapSettings(), QgsProject::instance() );
+  mComposition = new QgsComposition( QgsProject::instance() );
 
   mActionUndo->setEnabled( false );
   mActionRedo->setEnabled( false );
@@ -934,6 +934,23 @@ bool QgsComposer::loadFromTemplate( const QDomDocument& templateDoc, bool clearE
   return result;
 }
 
+void QgsComposer::onCanvasLayersChanged( const QList<QgsMapLayer*>& layers )
+{
+  if ( !mComposition )
+    return;
+
+  QList< QgsComposerMap* > maps;
+  mComposition->composerItems( maps );
+
+  Q_FOREACH ( QgsComposerMap* map, maps )
+  {
+    if ( map->keepLayerSet() )
+      continue;
+
+    map->setLayers( layers );
+  }
+}
+
 void QgsComposer::updateStatusCursorPos( QPointF cursorPosition )
 {
   if ( !mComposition )
@@ -3543,7 +3560,7 @@ void QgsComposer::readXml( const QDomElement& composerElem, const QDomDocument&
   createComposerView();
 
   //read composition settings
-  mComposition = new QgsComposition( mQgis->mapCanvas()->mapSettings(), QgsProject::instance() );
+  mComposition = new QgsComposition( QgsProject::instance() );
   QDomNodeList compositionNodeList = composerElem.elementsByTagName( QStringLiteral( "Composition" ) );
   if ( compositionNodeList.size() > 0 )
   {

src/app/composer/qgscomposer.h

@@ -114,6 +114,16 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase
      */
     bool loadFromTemplate( const QDomDocument& templateDoc, bool clearExisting );
 
+  public slots:
+
+    /**
+     * Should be called whenever the app's canvas layers change (or layer order
+     * changes). Required to update composer maps which are synced to the canvas
+     * layer set with the new canvas layer set.
+     * @note added in QGIS 3.0
+     */
+    void onCanvasLayersChanged( const QList< QgsMapLayer* >& layers );
+
   protected:
     //! Move event
     virtual void moveEvent( QMoveEvent * ) override;

src/app/composer/qgscomposermapwidget.cpp

@@ -905,20 +905,20 @@ void QgsComposerMapWidget::on_mKeepLayerListCheckBox_stateChanged( int state )
     return;
   }
 
+  // update map
+  storeCurrentLayerSet();
+  mComposerMap->setKeepLayerSet( state == Qt::Checked );
+
+  // update gui
   if ( state == Qt::Checked )
   {
-    storeCurrentLayerSet();
-    mComposerMap->setKeepLayerSet( true );
-
     // mutually exclusive with following a preset
     mFollowVisibilityPresetCheckBox->setCheckState( Qt::Unchecked );
   }
   else
   {
-    mComposerMap->setLayers( QList<QgsMapLayer*>() );
-    mComposerMap->setKeepLayerSet( false );
-
     mKeepLayerStylesCheckBox->setChecked( Qt::Unchecked );
+    mComposerMap->updateCachedImage();
   }
 
   mKeepLayerStylesCheckBox->setEnabled( state == Qt::Checked );

src/app/qgisapp.cpp

@@ -6773,9 +6773,11 @@ QgsComposer* QgisApp::createNewComposer( QString title )
   mPrintComposersMenu->addAction( newComposerObject->windowAction() );
   newComposerObject->open();
   emit composerAdded( newComposerObject->view() );
-  connect( newComposerObject, SIGNAL( composerAdded( QgsComposerView* ) ), this, SIGNAL( composerAdded( QgsComposerView* ) ) );
-  connect( newComposerObject, SIGNAL( composerWillBeRemoved( QgsComposerView* ) ), this, SIGNAL( composerWillBeRemoved( QgsComposerView* ) ) );
-  connect( newComposerObject, SIGNAL( atlasPreviewFeatureChanged() ), this, SLOT( refreshMapCanvas() ) );
+  connect( newComposerObject, &QgsComposer::composerAdded, this, &QgisApp::composerAdded );
+  connect( newComposerObject, &QgsComposer::composerWillBeRemoved, this, &QgisApp::composerWillBeRemoved );
+  connect( newComposerObject, &QgsComposer::atlasPreviewFeatureChanged, this, &QgisApp::refreshMapCanvas );
+  connect( mLayerTreeCanvasBridge, &QgsLayerTreeMapCanvasBridge::canvasLayersChanged, newComposerObject, &QgsComposer::onCanvasLayersChanged );
+
   markDirty();
   return newComposerObject;
 }
@@ -6875,9 +6877,10 @@ bool QgisApp::loadComposersFromProject( const QDomDocument& doc )
       composerView->updateRulers();
     }
     emit composerAdded( composer->view() );
-    connect( composer, SIGNAL( composerAdded( QgsComposerView* ) ), this, SIGNAL( composerAdded( QgsComposerView* ) ) );
-    connect( composer, SIGNAL( composerWillBeRemoved( QgsComposerView* ) ), this, SIGNAL( composerWillBeRemoved( QgsComposerView* ) ) );
-    connect( composer, SIGNAL( atlasPreviewFeatureChanged() ), this, SLOT( refreshMapCanvas() ) );
+    connect( composer, &QgsComposer::composerAdded, this, &QgisApp::composerAdded );
+    connect( composer, &QgsComposer::composerWillBeRemoved, this, &QgisApp::composerWillBeRemoved );
+    connect( composer, &QgsComposer::atlasPreviewFeatureChanged, this, &QgisApp::refreshMapCanvas );
+    connect( mLayerTreeCanvasBridge, &QgsLayerTreeMapCanvasBridge::canvasLayersChanged, composer, &QgsComposer::onCanvasLayersChanged );
 
     QgsDebugMsg( QString( "Loaded composer %1: %2ms" ).arg( title ).arg( t.elapsed() ) );
   }

src/core/composer/qgscomposermap.cpp

@@ -523,15 +523,11 @@ QList<QgsMapLayer*> QgsComposerMap::layersToRender( const QgsExpressionContext*
     if ( mComposition->project()->mapThemeCollection()->hasMapTheme( presetName ) )
       renderLayers = mComposition->project()->mapThemeCollection()->mapThemeVisibleLayers( presetName );
     else  // fallback to using map canvas layers
-      renderLayers = mComposition->mapSettings().layers();
-  }
-  else if ( mKeepLayerSet )
-  {
-    renderLayers = layers();
+      renderLayers = layers();
   }
   else
   {
-    renderLayers = mComposition->mapSettings().layers();
+    renderLayers = layers();
   }
 
   bool ok = false;

src/core/composer/qgscomposermap.h

@@ -202,14 +202,36 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
     PreviewMode previewMode() const {return mPreviewMode;}
     void setPreviewMode( PreviewMode m );
 
-    //! Getter for flag that determines if the stored layer set should be used or the current layer set of the qgis mapcanvas
+    /**
+     * Getter for flag that determines if a stored layer set should be used
+     * or the current layer set of the QGIS map canvas.
+     * @see setKeepLayerSet()
+     * @see layers()
+     */
     bool keepLayerSet() const {return mKeepLayerSet;}
-    //! Setter for flag that determines if the stored layer set should be used or the current layer set of the qgis mapcanvas
+
+    /**
+     * Setter for flag that determines if the stored layer set should be used
+     * or the current layer set of the QGIS map canvas.
+     * @see keepLayerSet()
+     * @see layers()
+     */
     void setKeepLayerSet( bool enabled ) {mKeepLayerSet = enabled;}
 
-    //! Getter for stored layer set that is used if mKeepLayerSet is true
+    /**
+     * Getter for stored layer set. This will usually be synchronized with the main app canvas
+     * layer set (and layer order), unless the keepLayerSet() flag is true.
+     * @see setLayers()
+     * @see keepLayerSet()
+     */
     QList<QgsMapLayer*> layers() const;
-    //! Setter for stored layer set that is used if mKeepLayerSet is true
+
+    /**
+     * Setter for stored layer set.  This will usually be synchronized with the main app canvas
+     * layer set (and layer order), unless the keepLayerSet() flag is true.
+     * @see layers()
+     * @see keepLayerSet()
+     */
     void setLayers( const QList<QgsMapLayer*> layers );
 
     //! Getter for flag that determines if current styles of layers should be overridden by previously stored styles. @note added in 2.8

src/core/composer/qgscomposition.cpp

@@ -60,9 +60,8 @@
 #include "gdal.h"
 #include "cpl_conv.h"
 
-QgsComposition::QgsComposition( const QgsMapSettings& mapSettings, QgsProject* project )
+QgsComposition::QgsComposition( QgsProject* project )
     : QGraphicsScene( nullptr )
-    , mMapSettings( mapSettings )
     , mProject( project )
     , mAtlasComposition( this )
 {