This class implements a visual Qt Quick Item that does map rendering according to the current map settings. More...

#include <qgsquickmapcanvasmap.h>

Inheritance diagram for QgsQuickMapCanvasMap:

Public Slots
void	clearCache ()
	Clears rendering cache.

void	pan (QPointF oldPos, QPointF newPos)
	Set map setting's extent (pan the map) based on the difference of positions.

void	refresh ()
	Refresh the map canvas.

void	stopRendering ()
	Stop map rendering.

void	zoom (QPointF center, qreal scale)
	Set map setting's extent (zoom the map) on the center by given scale.

Signals
void	freezeChanged ()
	When freeze property is set to `true`, the map canvas does not refresh.

void	incrementalRenderingChanged ()
	When the incrementalRendering property is set to `true`, the automatic refresh of map canvas during rendering is allowed.

void	isRenderingChanged ()
	The isRendering property is set to `true` while a rendering job is pending for this map canvas map.

void	mapCanvasRefreshed ()
	Signal is emitted when a canvas is refreshed.

void	mapUpdateIntervalChanged ()
	Interval in milliseconds after which the map canvas will be updated while a rendering job is ongoing.

void	renderStarting ()
	Signal is emitted when a rendering is starting.

Public Member Functions
	QgsQuickMapCanvasMap (QQuickItem *parent=nullptr)
	Create map canvas map.

	~QgsQuickMapCanvasMap ()

bool	freeze () const
	When freeze property is set to `true`, the map canvas does not refresh.

bool	incrementalRendering () const
	When the incrementalRendering property is set to `true`, the automatic refresh of map canvas during rendering is allowed.

bool	isRendering () const
	The isRendering property is set to `true` while a rendering job is pending for this map canvas map.

QgsQuickMapSettings *	mapSettings () const
	The mapSettings property contains configuration for rendering of the map.

int	mapUpdateInterval () const
	Interval in milliseconds after which the map canvas will be updated while a rendering job is ongoing.

void	setFreeze (bool freeze)
	When freeze property is set to `true`, the map canvas does not refresh.

void	setIncrementalRendering (bool incrementalRendering)
	When the incrementalRendering property is set to `true`, the automatic refresh of map canvas during rendering is allowed.

void	setMapUpdateInterval (int mapUpdateInterval)
	Interval in milliseconds after which the map canvas will be updated while a rendering job is ongoing.

QSGNode *	updatePaintNode (QSGNode oldNode, QQuickItem::UpdatePaintNodeData ) override

Protected Member Functions
void	geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override

Properties
bool	freeze
	When freeze property is set to `true`, the map canvas does not refresh.

bool	incrementalRendering
	When the incrementalRendering property is set to `true`, the automatic refresh of map canvas during rendering is allowed.

bool	isRendering
	The isRendering property is set to `true` while a rendering job is pending for this map canvas map.

QgsQuickMapSettings *	mapSettings
	The mapSettings property contains configuration for rendering of the map.

int	mapUpdateInterval
	Interval in milliseconds after which the map canvas will be updated while a rendering job is ongoing.

Detailed Description

This class implements a visual Qt Quick Item that does map rendering according to the current map settings.

Client code is expected to use MapCanvas item rather than using this class directly.

QgsQuickMapCanvasMap instance internally creates QgsQuickMapSettings in constructor. The QgsProject should be attached to the QgsQuickMapSettings. The map settings for other QgsQuick components should be initialized from QgsQuickMapCanvasMap's mapSettings

Note: QML Type: MapCanvasMap

See also: QgsQuickMapCanvas

Since: QGIS 3.2

Definition at line 52 of file qgsquickmapcanvasmap.h.

Constructor & Destructor Documentation

◆ QgsQuickMapCanvasMap()

QgsQuickMapCanvasMap::QgsQuickMapCanvasMap ( QQuickItem * parent = nullptr )

explicit

Create map canvas map.

Definition at line 40 of file qgsquickmapcanvasmap.cpp.

◆ ~QgsQuickMapCanvasMap()

QgsQuickMapCanvasMap::~QgsQuickMapCanvasMap ( )

default

Member Function Documentation

◆ clearCache

void QgsQuickMapCanvasMap::clearCache ( )

slot

Clears rendering cache.

Definition at line 514 of file qgsquickmapcanvasmap.cpp.

◆ freeze()

bool QgsQuickMapCanvasMap::freeze ( ) const

When freeze property is set to true, the map canvas does not refresh.

The value temporary changes during the rendering process.

Definition at line 352 of file qgsquickmapcanvasmap.cpp.

◆ freezeChanged

void QgsQuickMapCanvasMap::freezeChanged ( )

signal

When freeze property is set to true, the map canvas does not refresh.

The value temporary changes during the rendering process.

◆ geometryChange()

void QgsQuickMapCanvasMap::geometryChange	(	const QRectF &	newGeometry,
		const QRectF &	oldGeometry
	)

overrideprotected

Definition at line 428 of file qgsquickmapcanvasmap.cpp.

◆ incrementalRendering()

bool QgsQuickMapCanvasMap::incrementalRendering ( ) const

When the incrementalRendering property is set to true, the automatic refresh of map canvas during rendering is allowed.

Definition at line 338 of file qgsquickmapcanvasmap.cpp.

◆ incrementalRenderingChanged

void QgsQuickMapCanvasMap::incrementalRenderingChanged ( )

signal

When the incrementalRendering property is set to true, the automatic refresh of map canvas during rendering is allowed.

◆ isRendering()

bool QgsQuickMapCanvasMap::isRendering ( ) const

The isRendering property is set to true while a rendering job is pending for this map canvas map.

It can be used to show a notification icon about an ongoing rendering job. This is a readonly property.

Definition at line 372 of file qgsquickmapcanvasmap.cpp.

◆ isRenderingChanged

void QgsQuickMapCanvasMap::isRenderingChanged ( )

signal

The isRendering property is set to true while a rendering job is pending for this map canvas map.

It can be used to show a notification icon about an ongoing rendering job. This is a readonly property.

◆ mapCanvasRefreshed

void QgsQuickMapCanvasMap::mapCanvasRefreshed ( )

signal

Signal is emitted when a canvas is refreshed.

◆ mapSettings()

QgsQuickMapSettings * QgsQuickMapCanvasMap::mapSettings ( ) const

The mapSettings property contains configuration for rendering of the map.

It should be used as a primary source of map settings (and project) for all other components in the application.

This is a readonly property.

Definition at line 66 of file qgsquickmapcanvasmap.cpp.

◆ mapUpdateInterval()

int QgsQuickMapCanvasMap::mapUpdateInterval ( ) const

Interval in milliseconds after which the map canvas will be updated while a rendering job is ongoing.

This only has an effect if incrementalRendering is activated. Default is 250 [ms].

Definition at line 323 of file qgsquickmapcanvasmap.cpp.

◆ mapUpdateIntervalChanged

void QgsQuickMapCanvasMap::mapUpdateIntervalChanged ( )

signal

Interval in milliseconds after which the map canvas will be updated while a rendering job is ongoing.

This only has an effect if incrementalRendering is activated. Default is 250 [ms].

◆ pan

void QgsQuickMapCanvasMap::pan	(	QPointF	oldPos,
		QPointF	newPos
	)

slot

Set map setting's extent (pan the map) based on the difference of positions.

Definition at line 84 of file qgsquickmapcanvasmap.cpp.

◆ refresh

void QgsQuickMapCanvasMap::refresh ( )

slot

Refresh the map canvas.

Does nothing when output size of map settings is not set

Definition at line 505 of file qgsquickmapcanvasmap.cpp.

◆ renderStarting

void QgsQuickMapCanvasMap::renderStarting ( )

signal

Signal is emitted when a rendering is starting.

◆ setFreeze()

void QgsQuickMapCanvasMap::setFreeze ( bool freeze )

When freeze property is set to true, the map canvas does not refresh.

The value temporary changes during the rendering process.

Definition at line 357 of file qgsquickmapcanvasmap.cpp.

◆ setIncrementalRendering()

void QgsQuickMapCanvasMap::setIncrementalRendering ( bool incrementalRendering )

When the incrementalRendering property is set to true, the automatic refresh of map canvas during rendering is allowed.

Definition at line 343 of file qgsquickmapcanvasmap.cpp.

◆ setMapUpdateInterval()

void QgsQuickMapCanvasMap::setMapUpdateInterval ( int mapUpdateInterval )

Interval in milliseconds after which the map canvas will be updated while a rendering job is ongoing.

This only has an effect if incrementalRendering is activated. Default is 250 [ms].

Definition at line 328 of file qgsquickmapcanvasmap.cpp.

◆ stopRendering

void QgsQuickMapCanvasMap::stopRendering ( )

slot

Stop map rendering.

Definition at line 465 of file qgsquickmapcanvasmap.cpp.

◆ updatePaintNode()

QSGNode * QgsQuickMapCanvasMap::updatePaintNode	(	QSGNode *	oldNode,
		QQuickItem::UpdatePaintNodeData *
	)

override

Definition at line 377 of file qgsquickmapcanvasmap.cpp.

◆ zoom

void QgsQuickMapCanvasMap::zoom	(	QPointF	center,
		qreal	scale
	)

slot

Set map setting's extent (zoom the map) on the center by given scale.

Definition at line 71 of file qgsquickmapcanvasmap.cpp.

Property Documentation

◆ freeze

bool QgsQuickMapCanvasMap::freeze

readwrite

When freeze property is set to true, the map canvas does not refresh.

The value temporary changes during the rendering process.

Definition at line 70 of file qgsquickmapcanvasmap.h.

◆ incrementalRendering

bool QgsQuickMapCanvasMap::incrementalRendering

readwrite

When the incrementalRendering property is set to true, the automatic refresh of map canvas during rendering is allowed.

Definition at line 89 of file qgsquickmapcanvasmap.h.

◆ isRendering

bool QgsQuickMapCanvasMap::isRendering

read

The isRendering property is set to true while a rendering job is pending for this map canvas map.

It can be used to show a notification icon about an ongoing rendering job. This is a readonly property.

Definition at line 77 of file qgsquickmapcanvasmap.h.

◆ mapSettings

QgsQuickMapSettings * QgsQuickMapCanvasMap::mapSettings

read

The mapSettings property contains configuration for rendering of the map.

It should be used as a primary source of map settings (and project) for all other components in the application.

This is a readonly property.

Definition at line 64 of file qgsquickmapcanvasmap.h.

◆ mapUpdateInterval

int QgsQuickMapCanvasMap::mapUpdateInterval

readwrite

Interval in milliseconds after which the map canvas will be updated while a rendering job is ongoing.

This only has an effect if incrementalRendering is activated. Default is 250 [ms].

Definition at line 84 of file qgsquickmapcanvasmap.h.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/quickgui/qgsquickmapcanvasmap.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/quickgui/qgsquickmapcanvasmap.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ QgsQuickMapCanvasMap()

◆ ~QgsQuickMapCanvasMap()

Member Function Documentation

◆ clearCache

◆ freeze()

◆ freezeChanged

◆ geometryChange()

◆ incrementalRendering()

◆ incrementalRenderingChanged

◆ isRendering()

◆ isRenderingChanged

◆ mapCanvasRefreshed

◆ mapSettings()

◆ mapUpdateInterval()

◆ mapUpdateIntervalChanged

◆ pan

◆ refresh

◆ renderStarting

◆ setFreeze()

◆ setIncrementalRendering()

◆ setMapUpdateInterval()

◆ stopRendering

◆ updatePaintNode()

◆ zoom

Property Documentation

◆ freeze

◆ incrementalRendering

◆ isRendering

◆ mapSettings

◆ mapUpdateInterval