Stores collated details of rendered items during a map rendering operation. More...

#include <qgsrendereditemresults.h>

Public Member Functions
	QgsRenderedItemResults (const QgsRectangle &extent=QgsRectangle())
	Constructor for QgsRenderedItemResults.

	QgsRenderedItemResults (const QgsRenderedItemResults &)=delete

	~QgsRenderedItemResults ()

void	appendResults (const QList< QgsRenderedItemDetails * > &results, const QgsRenderContext &context)
	Appends rendered item details to the results object.

void	eraseResultsFromLayers (const QStringList &layerIds)
	Erases results from layers matching those in the specified list of layers IDs.

QgsRenderedItemResults &	operator= (const QgsRenderedItemResults &rh)=delete

QList< const QgsRenderedAnnotationItemDetails * >	renderedAnnotationItemsInBounds (const QgsRectangle &bounds) const
	Returns a list with details of the rendered annotation items within the specified bounds.

QList< QgsRenderedItemDetails * >	renderedItems () const
	Returns a list of all rendered items.

void	transferResults (QgsRenderedItemResults *other)
	Transfers all results from an other QgsRenderedItemResults object to this one.

void	transferResults (QgsRenderedItemResults *other, const QStringList &layerIds)
	Transfers all results from an other QgsRenderedItemResults object where the items have layer IDs matching the specified list.

Detailed Description

Stores collated details of rendered items during a map rendering operation.

Since: QGIS 3.22

Definition at line 42 of file qgsrendereditemresults.h.

Constructor & Destructor Documentation

◆ QgsRenderedItemResults() [1/2]

QgsRenderedItemResults::QgsRenderedItemResults ( const QgsRectangle & extent = QgsRectangle() )

Constructor for QgsRenderedItemResults.

The extent argument can be used to specify an expected maximal extent for items which will be stored in the results. This helps to optimise the spatial indices used by the object.

Definition at line 100 of file qgsrendereditemresults.cpp.

◆ ~QgsRenderedItemResults()

QgsRenderedItemResults::~QgsRenderedItemResults ( )

default

◆ QgsRenderedItemResults() [2/2]

QgsRenderedItemResults::QgsRenderedItemResults ( const QgsRenderedItemResults & )

delete

Member Function Documentation

◆ appendResults()

void QgsRenderedItemResults::appendResults	(	const QList< QgsRenderedItemDetails * > &	results,
		const QgsRenderContext &	context
	)

Appends rendered item details to the results object.

Ownership of results is transferred to the this object.

The render context argument is used to specify the render context used to render the items. It will be used to transform the details to the destination map CRS.

Definition at line 134 of file qgsrendereditemresults.cpp.

◆ eraseResultsFromLayers()

void QgsRenderedItemResults::eraseResultsFromLayers ( const QStringList & layerIds )

Erases results from layers matching those in the specified list of layers IDs.

Definition at line 197 of file qgsrendereditemresults.cpp.

◆ operator=()

QgsRenderedItemResults & QgsRenderedItemResults::operator= ( const QgsRenderedItemResults & rh )

delete

◆ renderedAnnotationItemsInBounds()

QList< const QgsRenderedAnnotationItemDetails * > QgsRenderedItemResults::renderedAnnotationItemsInBounds ( const QgsRectangle & bounds ) const

Returns a list with details of the rendered annotation items within the specified bounds.

Since: QGIS 3.22

Definition at line 122 of file qgsrendereditemresults.cpp.

◆ renderedItems()

QList< QgsRenderedItemDetails * > QgsRenderedItemResults::renderedItems ( ) const

Returns a list of all rendered items.

Definition at line 109 of file qgsrendereditemresults.cpp.

◆ transferResults() [1/2]

void QgsRenderedItemResults::transferResults ( QgsRenderedItemResults * other )

Transfers all results from an other QgsRenderedItemResults object to this one.

Items are removed from other and transferred to this object.

Warning: After calling this method the other results will be left in an undefined state.

Definition at line 180 of file qgsrendereditemresults.cpp.

◆ transferResults() [2/2]

void QgsRenderedItemResults::transferResults	(	QgsRenderedItemResults *	other,
		const QStringList &	layerIds
	)

Transfers all results from an other QgsRenderedItemResults object where the items have layer IDs matching the specified list.