QgsLayerTreeMapCanvasBridge Class Reference

The QgsLayerTreeMapCanvasBridge class takes care of updates of layer set for QgsMapCanvas from a layer tree. More...

#include <qgslayertreemapcanvasbridge.h>

Inheritance diagram for QgsLayerTreeMapCanvasBridge:

Signals
void	canvasLayersChanged (const QList< QgsMapLayer * > &layers)
	Emitted when the set of layers (or order of layers) visible in the canvas changes.

Public Member Functions
	QgsLayerTreeMapCanvasBridge (QgsLayerTree *root, QgsMapCanvas *canvas, QObject *parent SIP_TRANSFERTHIS=nullptr)
	Constructor: does not take ownership of the layer tree nor canvas.
bool	autoSetupOnFirstLayer () const
QgsMapCanvas *	mapCanvas () const
QgsMapOverviewCanvas *	overviewCanvas () const
	Returns associated overview canvas (may be nullptr)
QgsLayerTree *	rootGroup () const
void	setAutoSetupOnFirstLayer (bool enabled)
	if enabled, will automatically set full canvas extent and destination CRS + map units when first layer(s) are added
Q_INVOKABLE void	setCanvasLayers ()
	force update of canvas layers from the layer tree. Normally this should not be needed to be called.
void	setOverviewCanvas (QgsMapOverviewCanvas *overviewCanvas)
	Associates overview canvas with the bridge, so the overview will be updated whenever main canvas is updated.

Detailed Description

The QgsLayerTreeMapCanvasBridge class takes care of updates of layer set for QgsMapCanvas from a layer tree.

The class listens to the updates in the layer tree and updates the list of layers for rendering whenever some layers are added, removed, or their visibility changes.

The update of layers is not done immediately - it is postponed, so a series of updates to the layer tree will trigger just one update of canvas layers.

Also allows the client to override the default order of layers. This is useful in advanced cases where the grouping in layer tree should be independent from the actual order in the canvas.

Definition at line 47 of file qgslayertreemapcanvasbridge.h.

Constructor & Destructor Documentation

QgsLayerTreeMapCanvasBridge()

QgsLayerTreeMapCanvasBridge::QgsLayerTreeMapCanvasBridge	(	QgsLayerTree *	root,
		QgsMapCanvas *	canvas,
		QObject *parent	SIP_TRANSFERTHIS = nullptr
	)

Constructor: does not take ownership of the layer tree nor canvas.

Definition at line 29 of file qgslayertreemapcanvasbridge.cpp.

Member Function Documentation

autoSetupOnFirstLayer()

bool QgsLayerTreeMapCanvasBridge::autoSetupOnFirstLayer ( ) const

inline

Definition at line 85 of file qgslayertreemapcanvasbridge.h.

canvasLayersChanged

void QgsLayerTreeMapCanvasBridge::canvasLayersChanged ( const QList< QgsMapLayer * > &  layers )

signal

Emitted when the set of layers (or order of layers) visible in the canvas changes.

mapCanvas()

QgsMapCanvas * QgsLayerTreeMapCanvasBridge::mapCanvas ( ) const

inline

Definition at line 55 of file qgslayertreemapcanvasbridge.h.

overviewCanvas()

QgsMapOverviewCanvas * QgsLayerTreeMapCanvasBridge::overviewCanvas ( ) const

inline

Returns associated overview canvas (may be nullptr)

Definition at line 78 of file qgslayertreemapcanvasbridge.h.

rootGroup()

QgsLayerTree * QgsLayerTreeMapCanvasBridge::rootGroup ( ) const

inline

Definition at line 54 of file qgslayertreemapcanvasbridge.h.

setAutoSetupOnFirstLayer()

void QgsLayerTreeMapCanvasBridge::setAutoSetupOnFirstLayer ( bool  enabled )

inline

if enabled, will automatically set full canvas extent and destination CRS + map units when first layer(s) are added

Definition at line 84 of file qgslayertreemapcanvasbridge.h.

setCanvasLayers()

void QgsLayerTreeMapCanvasBridge::setCanvasLayers

(

)

force update of canvas layers from the layer tree. Normally this should not be needed to be called.

Definition at line 46 of file qgslayertreemapcanvasbridge.cpp.

setOverviewCanvas()

void QgsLayerTreeMapCanvasBridge::setOverviewCanvas ( QgsMapOverviewCanvas *  overviewCanvas )

inline

Associates overview canvas with the bridge, so the overview will be updated whenever main canvas is updated.

Since

QGIS 3.6

Definition at line 61 of file qgslayertreemapcanvasbridge.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/layertree/qgslayertreemapcanvasbridge.h
• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/layertree/qgslayertreemapcanvasbridge.cpp