QGIS API Documentation  3.11.0-Master (461d2edac3)
Public Member Functions | Public Attributes | List of all members
QgsRasterLayer::LayerOptions Struct Reference

Setting options for loading raster layers. More...

#include <qgsrasterlayer.h>

Public Member Functions

 LayerOptions (bool loadDefaultStyle=true, const QgsCoordinateTransformContext &transformContext=QgsCoordinateTransformContext())
 Constructor for LayerOptions. More...
 

Public Attributes

bool loadDefaultStyle = true
 Sets to true if the default layer style should be loaded. More...
 
bool skipCrsValidation = false
 Controls whether the layer is allowed to have an invalid/unknown CRS. More...
 
QgsCoordinateTransformContext transformContext = QgsCoordinateTransformContext()
 Coordinate transform context. More...
 

Detailed Description

Setting options for loading raster layers.

Since
QGIS 3.0

Definition at line 170 of file qgsrasterlayer.h.

Constructor & Destructor Documentation

◆ LayerOptions()

QgsRasterLayer::LayerOptions::LayerOptions ( bool  loadDefaultStyle = true,
const QgsCoordinateTransformContext transformContext = QgsCoordinateTransformContext() 
)
inlineexplicit

Constructor for LayerOptions.

Definition at line 176 of file qgsrasterlayer.h.

Member Data Documentation

◆ loadDefaultStyle

bool QgsRasterLayer::LayerOptions::loadDefaultStyle = true

Sets to true if the default layer style should be loaded.

Definition at line 183 of file qgsrasterlayer.h.

◆ skipCrsValidation

bool QgsRasterLayer::LayerOptions::skipCrsValidation = false

Controls whether the layer is allowed to have an invalid/unknown CRS.

If true, then no validation will be performed on the layer's CRS and the layer layer's crs() may be invalid() (i.e. the layer will have no georeferencing available and will be treated as having purely numerical coordinates).

If false (the default), the layer's CRS will be validated using QgsCoordinateReferenceSystem::validate(), which may cause a blocking, user-facing dialog asking users to manually select the correct CRS for the layer.

Since
QGIS 3.10

Definition at line 204 of file qgsrasterlayer.h.

◆ transformContext

QgsCoordinateTransformContext QgsRasterLayer::LayerOptions::transformContext = QgsCoordinateTransformContext()

Coordinate transform context.

Since
QGIS 3.8

Definition at line 189 of file qgsrasterlayer.h.


The documentation for this struct was generated from the following file: