38#include <QElapsedTimer>
46 , mMinimalPreviewInterval( 250 )
51void QgsRasterLayerRendererFeedback::onNewData()
53 if ( !renderPartialOutput() )
58 if ( mLastPreview.isValid() && mLastPreview.msecsTo( QTime::currentTime() ) < mMinimalPreviewInterval )
63 QgsDebugMsgLevel( QStringLiteral(
"new raster preview! %1" ).arg( mLastPreview.msecsTo( QTime::currentTime() ) ), 3 );
71 drawer.draw( *( mR->renderContext() ), mR->mRasterViewPort, &feedback );
72 mR->mReadyToCompose =
true;
73 QgsDebugMsgLevel( QStringLiteral(
"total raster preview time: %1 ms" ).arg( t.elapsed() ), 3 );
74 mLastPreview = QTime::currentTime();
81 , mLayerName( layer->name() )
82 , mLayerOpacity( layer->opacity() )
83 , mProviderCapabilities( layer->dataProvider()->providerCapabilities() )
84 , mFeedback( new QgsRasterLayerRendererFeedback( this ) )
85 , mEnableProfile( rendererContext.flags() &
Qgis::RenderContextFlag::RecordProfile )
100 static_cast<int>( mapToPixel.
mapWidth() / 2.0 ),
101 static_cast<int>( mapToPixel.
mapHeight() / 2.0 )
111 QgsDebugMsgLevel( QStringLiteral(
"coordinateTransform set -> project extents." ), 4 );
112 if ( rendererContext.
extent().
xMinimum() == std::numeric_limits<double>::lowest() &&
113 rendererContext.
extent().
yMinimum() == std::numeric_limits<double>::lowest() &&
114 rendererContext.
extent().
xMaximum() == std::numeric_limits<double>::max() &&
115 rendererContext.
extent().
yMaximum() == std::numeric_limits<double>::max() )
122 myProjectedViewExtent = rendererContext.
extent();
135 myProjectedViewExtent.
setNull();
148 myProjectedLayerExtent.
setNull();
154 myProjectedViewExtent = rendererContext.
extent();
155 myProjectedLayerExtent = layer->
extent();
160 if ( myRasterExtent.
isEmpty() )
162 QgsDebugMsgLevel( QStringLiteral(
"draw request outside view extent." ), 2 );
220 const double dpi = 25.4 * rendererContext.
scaleFactor();
224 const double dpiScaleFactor = rendererContext.
dpiTarget() / dpi;
225 mRasterViewPort->
mWidth *= dpiScaleFactor;
226 mRasterViewPort->
mHeight *= dpiScaleFactor;
277 switch ( temporalProperties->
mode() )
288 if ( matchingBand > 0 )
290 mPipe->renderer()->setInputBand( matchingBand );
300 temporalCapabilities->setRequestedTemporalRange( rendererContext.
temporalRange() );
317 mDrawElevationMap =
true;
318 mElevationScale = elevProp->
zScale();
319 mElevationOffset = elevProp->
zOffset();
324 switch ( elevProp->
mode() )
337 if ( matchingBand > 0 )
339 mPipe->renderer()->setInputBand( matchingBand );
346 if ( mPipe->renderer()->usesBands().contains( mElevationBand ) )
350 std::unique_ptr< QgsRasterTransparency > transparency;
352 transparency = std::make_unique< QgsRasterTransparency >( *rendererTransparency );
354 transparency = std::make_unique< QgsRasterTransparency >();
356 QVector<QgsRasterTransparency::TransparentSingleValuePixel> transparentPixels = transparency->transparentSingleValuePixelList();
360 const double adjustedLower = ( rendererContext.
zRange().
lower() - mElevationOffset ) / mElevationScale;
361 const double adjustedUpper = ( rendererContext.
zRange().
upper() - mElevationOffset ) / mElevationScale;
365 transparency->setTransparentSingleValuePixelList( transparentPixels );
366 mPipe->renderer()->setRasterTransparency( transparency.release() );
374 mFeedback->setRenderContext( rendererContext );
376 mPipe->moveToThread(
nullptr );
378 mPreparationTime = timer.elapsed();
385 delete mRasterViewPort;
390 std::unique_ptr< QgsScopedRuntimeProfile > profile;
391 if ( mEnableProfile )
393 profile = std::make_unique< QgsScopedRuntimeProfile >( mLayerName, QStringLiteral(
"rendering" ),
layerId() );
394 if ( mPreparationTime > 0 )
400 !( mProviderCapabilities &
401 QgsRasterInterface::Capability::Prefetch ) ) )
404 mPipe->moveToThread( QThread::currentThread() );
409 std::unique_ptr< QgsScopedRuntimeProfile > preparingProfile;
410 if ( mEnableProfile )
412 preparingProfile = std::make_unique< QgsScopedRuntimeProfile >( QObject::tr(
"Preparing render" ), QStringLiteral(
"rendering" ) );
423 if ( !mClippingRegions.empty() )
425 bool needsPainterClipPath =
false;
427 if ( needsPainterClipPath )
432 bool restoreOldResamplingStage =
false;
444 restoreOldResamplingStage =
true;
453 preparingProfile.reset();
454 std::unique_ptr< QgsScopedRuntimeProfile > renderingProfile;
455 if ( mEnableProfile )
457 renderingProfile = std::make_unique< QgsScopedRuntimeProfile >( QObject::tr(
"Rendering" ), QStringLiteral(
"rendering" ) );
465 if ( mDrawElevationMap )
468 if ( restoreOldResamplingStage )
470 mPipe->setResamplingStage( oldResamplingState );
473 const QStringList
errors = mFeedback->errors();
474 for (
const QString &error :
errors )
479 QgsDebugMsgLevel( QStringLiteral(
"total raster draw time (ms): %1" ).arg( time.elapsed(), 5 ), 4 );
482 mPipe->moveToThread(
nullptr );
484 return !mFeedback->isCanceled();
494 if ( !mRasterViewPort || !mPipe )
511void QgsRasterLayerRenderer::drawElevationMap()
516 double dpiScalefactor;
521 dpiScalefactor = 1.0;
527 int viewWidth =
static_cast<int>( viewSize.width() / dpiScalefactor );
528 int viewHeight =
static_cast<int>( viewSize.height() / dpiScalefactor );
530 bool canRenderElevation =
false;
531 std::unique_ptr<QgsRasterBlock> elevationBlock;
534 elevationBlock.reset(
541 canRenderElevation =
true;
551 if ( viewExtentInLayerCoordinate.
xMinimum() == std::numeric_limits<double>::lowest() &&
552 viewExtentInLayerCoordinate.
yMinimum() == std::numeric_limits<double>::lowest() &&
553 viewExtentInLayerCoordinate.
xMaximum() == std::numeric_limits<double>::max() &&
554 viewExtentInLayerCoordinate.
yMaximum() == std::numeric_limits<double>::max() )
556 viewExtentInLayerCoordinate = dataProvider->
extent();
559 double xLayerResol = viewExtentInLayerCoordinate.
width() /
static_cast<double>( viewWidth );
560 double yLayerResol = viewExtentInLayerCoordinate.
height() /
static_cast<double>( viewHeight );
562 double overSampling = 1;
563 if ( mPipe->resampleFilter() )
564 overSampling = mPipe->resampleFilter()->maxOversampling();
569 double providerXResol = dataProvider->
extent().
width() / dataProvider->
xSize();
571 overSampling = ( xLayerResol / providerXResol + yLayerResol / providerYResol ) / 2;
575 if ( overSampling > 1 )
585 int sourceWidth = viewWidth + 4;
586 int sourceHeight = viewHeight + 4;
588 viewExtentInLayerCoordinate.
xMinimum() - xLayerResol * 2,
589 viewExtentInLayerCoordinate.
yMinimum() - yLayerResol * 2,
590 viewExtentInLayerCoordinate.
xMaximum() + xLayerResol * 2,
591 viewExtentInLayerCoordinate.
yMaximum() + yLayerResol * 2 );
594 std::unique_ptr<QgsRasterBlock> sourcedata( dataProvider->
block( mElevationBand, viewExtentInLayerCoordinate, sourceWidth, sourceHeight, mFeedback ) );
603 elevationBlock->setNoDataValue( dataProvider->
sourceNoDataValue( mElevationBand ) );
610 QString coordinateOperation;
617 if ( coordinateOperation.isEmpty() )
622 coordinateOperation.toUtf8().constData() );
626 if ( canRenderElevation )
640 int top = elevMapHeight;
641 int left = elevMapWidth;
644 QList<QgsPointXY> corners;
650 for (
const QgsPointXY &corner : std::as_const( corners ) )
653 int x =
static_cast<int>( std::round( dpt.
x() ) );
654 int y =
static_cast<int>( std::round( dpt.
y() ) );
674 std::unique_ptr<QgsRasterBlock> rotatedElevationBlock =
675 std::make_unique<QgsRasterBlock>( elevationBlock->dataType(),
677 ( bottom - top ) *
renderContext()->devicePixelRatio() + 1 );
679 rotatedElevationBlock->setNoDataValue( elevationBlock->noDataValue() );
689 elevationBlock.reset( rotatedElevationBlock.release() );
692 topLeft = QPoint( left, top );
700 elevationBlock.get(),
The Qgis class provides global constants for use throughout the application.
RasterResamplingStage
Stage at which raster resampling occurs.
@ Provider
Resampling occurs in Provider.
@ InternalLayerOpacityHandling
The renderer internally handles the raster layer's opacity, so the default layer level opacity handli...
@ FixedRangePerBand
Layer has a fixed (manually specified) elevation range per band.
@ FixedElevationRange
Layer has a fixed elevation range.
@ RepresentsElevationSurface
Pixel values represent an elevation surface.
@ DynamicRangePerBand
Layer has a elevation range per band, calculated dynamically from an expression.
@ RedrawLayerOnly
Redraw the layer when temporal range changes, but don't apply any filtering. Useful when raster symbo...
@ FixedRangePerBand
Layer has a fixed temporal range per band (since QGIS 3.38)
@ TemporalRangeFromDataProvider
Mode when raster layer delegates temporal range handling to the dataprovider.
@ FixedTemporalRange
Mode when temporal properties have fixed start and end datetimes.
DataType
Raster data types.
@ UnknownDataType
Unknown or unspecified type.
@ RenderPreviewJob
Render is a 'canvas preview' render, and shortcuts should be taken to ensure fast rendering.
@ RenderPartialOutput
Whether to make extra effort to update map image with partially rendered layers (better for interacti...
@ Render3DMap
Render is for a 3D map.
@ UseAdvancedEffects
Enable layer opacity and blending effects.
static QgsRuntimeProfiler * profiler()
Returns the application runtime profiler.
This class represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
QString calculateCoordinateOperation(const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination) const
Returns the Proj coordinate operation string to use when transforming from the specified source CRS t...
bool mustReverseCoordinateOperation(const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination) const
Returns true if the coordinate operation returned by calculateCoordinateOperation() for the source to...
Custom exception class for Coordinate Reference System related exceptions.
bool isInfinite() const
Returns true if the range consists of all possible values.
Stores digital elevation model in a raster image which may get updated as a part of map layer renderi...
QImage rawElevationImage() const
Returns raw elevation image with elevations encoded as color values.
void fillWithRasterBlock(QgsRasterBlock *block, int top, int left, double zScale=1.0, double offset=0.0)
Fills the elevation map with values contains in a raster block starting from position defined by top ...
Base class for feedback objects to be used for cancellation of something running in a worker thread.
static GDALResampleAlg gdalResamplingAlgorithm(QgsRasterDataProvider::ResamplingMethod method)
Returns the GDAL resampling method corresponding to the QGIS resampling method.
static bool resampleSingleBandRaster(GDALDatasetH hSrcDS, GDALDatasetH hDstDS, GDALResampleAlg resampleAlg, const char *pszCoordinateOperation)
Resamples a single band raster to the destination dataset with different resolution (and possibly wit...
static gdal::dataset_unique_ptr blockToSingleBandMemoryDataset(int pixelWidth, int pixelHeight, const QgsRectangle &extent, void *block, GDALDataType dataType)
Converts a data block to a single band GDAL memory dataset.
static QPainterPath calculatePainterClipRegion(const QList< QgsMapClippingRegion > ®ions, const QgsRenderContext &context, Qgis::LayerType layerType, bool &shouldClip)
Returns a QPainterPath representing the intersection of clipping regions from context which should be...
static QList< QgsMapClippingRegion > collectClippingRegionsForLayer(const QgsRenderContext &context, const QgsMapLayer *layer)
Collects the list of map clipping regions from a context which apply to a map layer.
double zScale() const
Returns the z scale, which is a scaling factor which should be applied to z values from the layer.
virtual bool hasElevation() const
Returns true if the layer has an elevation or z component.
double zOffset() const
Returns the z offset, which is a fixed offset amount which should be added to z values from the layer...
Base class for utility classes that encapsulate information necessary for rendering of map layers.
bool mReadyToCompose
The flag must be set to false in renderer's constructor if wants to use the smarter map redraws funct...
QString layerId() const
Gets access to the ID of the layer rendered by this class.
QgsRenderContext * renderContext()
Returns the render context associated with the renderer.
QStringList errors() const
Returns list of errors (problems) that happened during the rendering.
virtual QgsRectangle extent() const
Returns the extent of the layer.
QgsCoordinateReferenceSystem crs
void statusChanged(const QString &status)
Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar)
Perform transforms between map coordinates and device coordinates.
int mapHeight() const
Returns current map height in pixels.
void setMapRotation(double degrees, double cx, double cy)
Sets map rotation in degrees (clockwise).
double mapUnitsPerPixel() const
Returns the current map units per pixel.
QgsPointXY toMapCoordinates(int x, int y) const
Transforms device coordinates to map (world) coordinates.
int mapWidth() const
Returns the current map width in pixels.
QgsPointXY transform(const QgsPointXY &p) const
Transforms a point p from map (world) coordinates to device coordinates.
double mapRotation() const
Returns the current map rotation in degrees (clockwise).
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
A class to represent a 2D point.
double distance(double x, double y) const
Returns the distance between this point and a specified x, y coordinate.
void setY(double y)
Sets the y value of the point.
void setX(double x)
Sets the x value of the point.
QPointF toQPointF() const
Converts a point to a QPointF.
bool includeUpper() const
Returns true if the upper bound is inclusive, or false if the upper bound is exclusive.
T lower() const
Returns the lower bound of the range.
bool includeLower() const
Returns true if the lower bound is inclusive, or false if the lower bound is exclusive.
T upper() const
Returns the upper bound of the range.
Feedback object tailored for raster block reading.
void setPreviewOnly(bool preview)
set flag whether the block request is for preview purposes only
void setRenderPartialOutput(bool enable)
Set whether our painter is drawing to a temporary image used just by this layer.
Implementation of data provider temporal properties for QgsRasterDataProviders.
Base class for raster data providers.
virtual double sourceNoDataValue(int bandNo) const
Value representing no data value.
ResamplingMethod zoomedOutResamplingMethod() const
Returns resampling method for zoomed-out operations.
void setDpi(int dpi)
Sets the output device resolution.
QgsRectangle extent() const override=0
Returns the extent of the layer.
Qgis::DataType dataType(int bandNo) const override=0
Returns data type for the band specified by number.
@ ProviderHintCanPerformProviderResampling
Provider can perform resampling (to be opposed to post rendering resampling) (since QGIS 3....
QgsRasterBlock * block(int bandNo, const QgsRectangle &boundingBox, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
Read block of data using given extent and size.
void statusChanged(const QString &) const
Emit a message to be displayed on status bar, usually used by network providers (WMS,...
ResamplingMethod zoomedInResamplingMethod() const
Returns resampling method for zoomed-in operations.
The drawing pipe for raster layers.
void draw(QPainter *p, QgsRasterViewPort *viewPort, const QgsMapToPixel *qgsMapToPixel, QgsRasterBlockFeedback *feedback=nullptr)
Draws raster data.
@ Size
Original data source size (and thus resolution) is known, it is not always available,...
virtual int xSize() const
Gets raster size.
virtual int capabilities() const
Returns a bitmask containing the supported capabilities.
virtual int ySize() const
Iterator for sequentially processing raster cells.
Raster layer specific subclass of QgsMapLayerElevationProperties.
Qgis::RasterElevationMode mode() const
Returns the elevation mode.
int bandNumber() const
Returns the band number from which the elevation should be taken.
int bandForElevationRange(QgsRasterLayer *layer, const QgsDoubleRange &range) const
Returns the band corresponding to the specified range.
Implementation of threaded rendering for raster layers.
bool render() override
Do the rendering (based on data stored in the class).
QgsRasterLayerRenderer(QgsRasterLayer *layer, QgsRenderContext &rendererContext)
bool forceRasterRender() const override
Returns true if the renderer must be rendered to a raster paint device (e.g.
~QgsRasterLayerRenderer() override
QgsFeedback * feedback() const override
Access to feedback object of the layer renderer (may be nullptr)
Implementation of map layer temporal properties for raster layers.
Qgis::TemporalIntervalMatchMethod intervalHandlingMethod() const
Returns the desired method to use when resolving a temporal interval to matching layers or bands in t...
Qgis::RasterTemporalMode mode() const
Returns the temporal properties mode.
int bandForTemporalRange(QgsRasterLayer *layer, const QgsDateTimeRange &range) const
Returns the band corresponding to the specified range.
Represents a raster layer.
int height() const
Returns the height of the (unclipped) raster.
void refreshRendererIfNeeded(QgsRasterRenderer *rasterRenderer, const QgsRectangle &extent)
Refresh renderer with new extent, if needed.
QgsMapLayerTemporalProperties * temporalProperties() override
Returns the layer's temporal properties.
QgsRasterPipe * pipe()
Returns the raster pipe.
bool ignoreExtents() const
If the ignoreExtent flag is set, the layer will also render outside the bounding box reported by the ...
QgsRasterDataProvider * dataProvider() override
Returns the source data provider.
int width() const
Returns the width of the (unclipped) raster.
QgsMapLayerElevationProperties * elevationProperties() override
Returns the layer's elevation properties.
Contains a pipeline of raster interfaces for sequential raster processing.
QgsRasterProjector implements approximate projection support for it calculates grid of points in sour...
Q_DECL_DEPRECATED void setCrs(const QgsCoordinateReferenceSystem &srcCRS, const QgsCoordinateReferenceSystem &destCRS, int srcDatumTransform=-1, int destDatumTransform=-1)
Sets the source and destination CRS.
Raster renderer pipe that applies colors to a raster.
Defines the list of pixel values to be considered as transparent or semi transparent when rendering r...
A rectangle specified with double values.
QString toString(int precision=16) const
Returns a string representation of form xmin,ymin : xmax,ymax Coordinates will be truncated to the sp...
double xMinimum() const
Returns the x minimum value (left side of rectangle).
double yMinimum() const
Returns the y minimum value (bottom side of rectangle).
double width() const
Returns the width of the rectangle.
double xMaximum() const
Returns the x maximum value (right side of rectangle).
double yMaximum() const
Returns the y maximum value (top side of rectangle).
void set(const QgsPointXY &p1, const QgsPointXY &p2, bool normalize=true)
Sets the rectangle from two QgsPoints.
bool isEmpty() const
Returns true if the rectangle has no area.
double height() const
Returns the height of the rectangle.
void setNull()
Mark a rectangle as being null (holding no spatial information).
QgsRectangle intersect(const QgsRectangle &rect) const
Returns the intersection with the given rectangle.
Contains information about the context of a rendering operation.
double scaleFactor() const
Returns the scaling factor for the render to convert painter units to physical sizes.
QPainter * painter()
Returns the destination QPainter for the render operation.
QgsExpressionContext & expressionContext()
Gets the expression context.
QgsCoordinateTransformContext transformContext() const
Returns the context's coordinate transform context, which stores various information regarding which ...
QgsElevationMap * elevationMap() const
Returns the destination elevation map for the render operation.
const QgsRectangle & extent() const
When rendering a map layer, calling this method returns the "clipping" extent for the layer (in the l...
bool testFlag(Qgis::RenderContextFlag flag) const
Check whether a particular flag is enabled.
void setDpiTarget(double dpi)
Sets the targeted dpi for rendering.
float devicePixelRatio() const
Returns the device pixel ratio.
double dpiTarget() const
Returns the targeted DPI for rendering.
const QgsMapToPixel & mapToPixel() const
Returns the context's map to pixel transform, which transforms between map coordinates and device coo...
QgsDoubleRange zRange() const
Returns the range of z-values which should be rendered.
QSize deviceOutputSize() const
Returns the device output size of the render.
QgsCoordinateTransform coordinateTransform() const
Returns the current coordinate transform for the context.
Qgis::RenderContextFlags flags() const
Returns combination of flags used for rendering.
void record(const QString &name, double time, const QString &group="startup", const QString &id=QString())
Manually adds a profile event with the given name and total time (in seconds).
Scoped object for saving and restoring a QPainter object's state.
bool isActive() const
Returns true if the temporal property is active.
const QgsDateTimeRange & temporalRange() const
Returns the datetime range for the object.
std::unique_ptr< std::remove_pointer< GDALDatasetH >::type, GDALDatasetCloser > dataset_unique_ptr
Scoped GDAL dataset.
unsigned long long qgssize
Qgssize is used instead of size_t, because size_t is stdlib type, unknown by SIP, and it would be har...
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
#define QgsDebugMsgLevel(str, level)
QgsTemporalRange< QDateTime > QgsDateTimeRange
QgsRange which stores a range of date times.
Defines the transparency for a range of single-band pixel values.
This class provides details of the viewable area that a raster will be rendered into.
qgssize mHeight
Height, number of rows to be rendered.
QgsCoordinateReferenceSystem mDestCRS
Target coordinate system.
QgsPointXY mBottomRightPoint
Coordinate (in output device coordinate system) of bottom right corner of the part of the raster that...
QgsPointXY mTopLeftPoint
Coordinate (in output device coordinate system) of top left corner of the part of the raster that is ...
QgsCoordinateReferenceSystem mSrcCRS
Source coordinate system.
QgsRectangle mDrawnExtent
Intersection of current map extent and layer extent.
QgsCoordinateTransformContext mTransformContext
Coordinate transform context.
qgssize mWidth
Width, number of columns to be rendered.