QGIS API Documentation  3.6.0-Noosa (5873452)
qgslayertreemapcanvasbridge.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayertreemapcanvasbridge.cpp
3  --------------------------------------
4  Date : May 2014
5  Copyright : (C) 2014 by Martin Dobias
6  Email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
17 
18 #include "qgslayertree.h"
19 #include "qgslayertreeutils.h"
20 #include "qgsmaplayer.h"
21 #include "qgsvectorlayer.h"
22 #include "qgsmapcanvas.h"
23 #include "qgsmapoverviewcanvas.h"
24 #include "qgsproject.h"
25 
27  : QObject( parent )
28  , mRoot( root )
29  , mCanvas( canvas )
30  , mPendingCanvasUpdate( false )
31  , mAutoSetupOnFirstLayer( true )
32  , mHasLayersLoaded( !root->findLayers().isEmpty() )
33 {
34  connect( root, &QgsLayerTreeGroup::customPropertyChanged, this, &QgsLayerTreeMapCanvasBridge::nodeCustomPropertyChanged );
35  connect( root, &QgsLayerTreeNode::visibilityChanged, this, &QgsLayerTreeMapCanvasBridge::nodeVisibilityChanged );
36  connect( root, &QgsLayerTree::layerOrderChanged, this, &QgsLayerTreeMapCanvasBridge::deferredSetCanvasLayers );
37 
39 }
40 
42 {
43  QList<QgsMapLayer *> canvasLayers, overviewLayers, allLayerOrder;
44 
45  if ( mRoot->hasCustomLayerOrder() )
46  {
47  const QList<QgsMapLayer *> customOrderLayers = mRoot->customLayerOrder();
48  for ( const QgsMapLayer *layer : customOrderLayers )
49  {
50  QgsLayerTreeLayer *nodeLayer = mRoot->findLayer( layer->id() );
51  if ( nodeLayer )
52  {
53  if ( !nodeLayer->layer()->isSpatial() )
54  continue;
55 
56  allLayerOrder << nodeLayer->layer();
57  if ( nodeLayer->isVisible() )
58  canvasLayers << nodeLayer->layer();
59  if ( nodeLayer->customProperty( QStringLiteral( "overview" ), 0 ).toInt() )
60  overviewLayers << nodeLayer->layer();
61  }
62  }
63  }
64  else
65  {
66  setCanvasLayers( mRoot, canvasLayers, overviewLayers, allLayerOrder );
67  }
68 
69  const QList<QgsLayerTreeLayer *> layerNodes = mRoot->findLayers();
70  int currentSpatialLayerCount = 0;
71  for ( QgsLayerTreeLayer *layerNode : layerNodes )
72  {
73  if ( layerNode->layer() && layerNode->layer()->isSpatial() )
74  currentSpatialLayerCount++;
75  }
76 
77  bool firstLayers = mAutoSetupOnFirstLayer && !mHasLayersLoaded && currentSpatialLayerCount != 0;
78 
79  mCanvas->setLayers( canvasLayers );
80  if ( mOverviewCanvas )
81  mOverviewCanvas->setLayers( overviewLayers );
82 
83  if ( firstLayers )
84  {
85  // if we are moving from zero to non-zero layers, let's zoom to those data
86  mCanvas->zoomToFullExtent();
87  }
88 
89  if ( !mFirstCRS.isValid() )
90  {
91  // find out what is the first used CRS in case we may need to turn on OTF projections later
92  for ( const QgsLayerTreeLayer *layerNode : layerNodes )
93  {
94  if ( layerNode->layer() && layerNode->layer()->crs().isValid() )
95  {
96  mFirstCRS = layerNode->layer()->crs();
97  break;
98  }
99  }
100  }
101 
102  if ( mFirstCRS.isValid() && firstLayers )
103  {
104  QgsProject::instance()->setCrs( mFirstCRS );
105  }
106 
107  mHasLayersLoaded = currentSpatialLayerCount;
108  if ( currentSpatialLayerCount == 0 )
109  mFirstCRS = QgsCoordinateReferenceSystem();
110 
111  mPendingCanvasUpdate = false;
112 
113  emit canvasLayersChanged( canvasLayers );
114 }
115 
116 void QgsLayerTreeMapCanvasBridge::setCanvasLayers( QgsLayerTreeNode *node, QList<QgsMapLayer *> &canvasLayers, QList<QgsMapLayer *> &overviewLayers, QList<QgsMapLayer *> &allLayers )
117 {
118  if ( QgsLayerTree::isLayer( node ) )
119  {
120  QgsLayerTreeLayer *nodeLayer = QgsLayerTree::toLayer( node );
121  if ( nodeLayer->layer() && nodeLayer->layer()->isSpatial() )
122  {
123  allLayers << nodeLayer->layer();
124  if ( nodeLayer->isVisible() )
125  canvasLayers << nodeLayer->layer();
126  if ( nodeLayer->customProperty( QStringLiteral( "overview" ), 0 ).toInt() )
127  overviewLayers << nodeLayer->layer();
128  }
129  }
130 
131  const QList<QgsLayerTreeNode *> children = node->children();
132  for ( QgsLayerTreeNode *child : children )
133  setCanvasLayers( child, canvasLayers, overviewLayers, allLayers );
134 }
135 
136 void QgsLayerTreeMapCanvasBridge::deferredSetCanvasLayers()
137 {
138  if ( mPendingCanvasUpdate )
139  return;
140 
141  mPendingCanvasUpdate = true;
142  QMetaObject::invokeMethod( this, "setCanvasLayers", Qt::QueuedConnection );
143 }
144 
145 void QgsLayerTreeMapCanvasBridge::nodeVisibilityChanged()
146 {
147  deferredSetCanvasLayers();
148 }
149 
150 void QgsLayerTreeMapCanvasBridge::nodeCustomPropertyChanged( QgsLayerTreeNode *node, const QString &key )
151 {
152  Q_UNUSED( node );
153  if ( key == QLatin1String( "overview" ) )
154  deferredSetCanvasLayers();
155 }
static QgsLayerTreeLayer * toLayer(QgsLayerTreeNode *node)
Cast node to a layer.
Definition: qgslayertree.h:75
Base class for all map layer types.
Definition: qgsmaplayer.h:64
void layerOrderChanged()
Emitted when the layer order has changed.
bool isVisible() const
Returns whether a node is really visible (ie checked and all its ancestors checked as well) ...
Q_INVOKABLE void setCanvasLayers()
force update of canvas layers from the layer tree. Normally this should not be needed to be called...
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:73
QList< QgsMapLayer * > customLayerOrder() const
The order in which layers will be rendered on the canvas.
QList< QgsLayerTreeNode * > children()
Gets list of children of the node. Children are owned by the parent.
Namespace with helper functions for layer tree operations.
Definition: qgslayertree.h:32
void setLayers(const QList< QgsMapLayer *> &layers)
updates layer set for overview
QVariant customProperty(const QString &key, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer. Properties are stored in a map and saved in project file...
void setCrs(const QgsCoordinateReferenceSystem &crs)
Sets the project&#39;s native coordinate reference system.
Definition: qgsproject.cpp:641
static bool isLayer(const QgsLayerTreeNode *node)
Check whether the node is a valid layer node.
Definition: qgslayertree.h:53
This class is a base class for nodes in a layer tree.
bool hasCustomLayerOrder() const
Determines if the layer order should be derived from the layer tree or if a custom override order sha...
void canvasLayersChanged(const QList< QgsMapLayer * > &layers)
Emitted when the set of layers (or order of layers) visible in the canvas changes.
QgsMapLayer * layer() const
Returns the map layer associated with this node.
QgsLayerTreeMapCanvasBridge(QgsLayerTree *root, QgsMapCanvas *canvas, QObject *parent=nullptr)
Constructor: does not take ownership of the layer tree nor canvas.
void visibilityChanged(QgsLayerTreeNode *node)
Emitted when check state of a node within the tree has been changed.
void setLayers(const QList< QgsMapLayer *> &layers)
Sets the list of layers that should be shown in the canvas.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:430
void zoomToFullExtent()
Zoom to the full extent of all layers.
This class represents a coordinate reference system (CRS).
virtual bool isSpatial() const
Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated w...
QList< QgsLayerTreeLayer * > findLayers() const
Find all layer nodes.
QgsLayerTreeLayer * findLayer(QgsMapLayer *layer) const
Find layer node representing the map layer.
void customPropertyChanged(QgsLayerTreeNode *node, const QString &key)
Emitted when a custom property of a node within the tree has been changed or removed.
Layer tree node points to a map layer.
bool isValid() const
Returns whether this CRS is correctly initialized and usable.