QGIS API Documentation 4.1.0-Master (376402f9aeb)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
QgsRasterRendererRegistry Class Reference
core library

Registry for raster renderers. More...

#include <qgsrasterrendererregistry.h>

Public Member Functions

 QgsRasterRendererRegistry ()
 Constructor for QgsRasterRendererRegistry.
QgsRasterRenderer * defaultRendererForDrawingStyle (Qgis::RasterDrawingStyle drawingStyle, QgsRasterDataProvider *provider) const
 Creates a default renderer for a raster drawing style (considering user options such as default contrast enhancement).
QList< QgsRasterRendererRegistryEntry > entries () const
 Returns the list of registered renderers.
void insert (const QgsRasterRendererRegistryEntry &entry)
 Inserts a new entry into the registry.
void insertWidgetFunction (const QString &rendererName, QgsRasterRendererWidgetCreateFunc func)
 Sets the widget creation function for a renderer.
Qgis::RasterRendererCapabilities rendererCapabilities (const QString &rendererName) const
 Returns the capabilities for the renderer with the specified name.
bool rendererData (const QString &rendererName, QgsRasterRendererRegistryEntry &data) const
 Retrieves renderer data from the registry.
QStringList renderersList () const
 Returns a list of the names of registered renderers.

Static Public Attributes

static const QgsSettingsEntryInteger * settingsDefaultBlueBand = new QgsSettingsEntryInteger( u"default-blue-band"_s, QgsSettingsTree::sTreeRaster, 3, u"Default band number assigned to the blue channel when creating an RGB renderer for a multi-band raster."_s )
static const QgsSettingsEntryInteger * settingsDefaultGreenBand = new QgsSettingsEntryInteger( u"default-green-band"_s, QgsSettingsTree::sTreeRaster, 2, u"Default band number assigned to the green channel when creating an RGB renderer for a multi-band raster."_s )
static const QgsSettingsEntryInteger * settingsDefaultRedBand = new QgsSettingsEntryInteger( u"default-red-band"_s, QgsSettingsTree::sTreeRaster, 1, u"Default band number assigned to the red channel when creating an RGB renderer for a multi-band raster."_s )
static const QgsSettingsEntryDouble * settingsDefaultStandardDeviation = new QgsSettingsEntryDouble( u"default-standard-deviation"_s, QgsSettingsTree::sTreeRaster, 2.0, u"Default standard deviation multiplier used to compute min/max values for raster contrast enhancement when \"use-standard-deviation\" is enabled."_s )
static const QgsSettingsEntryBool * settingsUseStandardDeviation = new QgsSettingsEntryBool( u"use-standard-deviation"_s, QgsSettingsTree::sTreeRaster, false, u"If true, newly created raster renderers use a standard-deviation based contrast enhancement by default."_s )

Detailed Description

Registry for raster renderers.

QgsRasterRendererRegistry is not usually directly created, but rather accessed through QgsApplication::rasterRendererRegistry().

Note
Exposed to Python bindings in QGIS 3.38

Definition at line 90 of file qgsrasterrendererregistry.h.

Constructor & Destructor Documentation

◆ QgsRasterRendererRegistry()

QgsRasterRendererRegistry::QgsRasterRendererRegistry ( )

Constructor for QgsRasterRendererRegistry.

QgsRasterRendererRegistry is not usually directly created, but rather accessed through QgsApplication::rasterRendererRegistry().

The registry is pre-populated with standard raster renderers.

Definition at line 68 of file qgsrasterrendererregistry.cpp.

Member Function Documentation

◆ defaultRendererForDrawingStyle()

QgsRasterRenderer * QgsRasterRendererRegistry::defaultRendererForDrawingStyle ( Qgis::RasterDrawingStyle drawingStyle,
QgsRasterDataProvider * provider ) const

Creates a default renderer for a raster drawing style (considering user options such as default contrast enhancement).

Caller takes ownership.

Definition at line 134 of file qgsrasterrendererregistry.cpp.

◆ entries()

QList< QgsRasterRendererRegistryEntry > QgsRasterRendererRegistry::entries ( ) const

Returns the list of registered renderers.

Note
Not available in Python bindings

Definition at line 112 of file qgsrasterrendererregistry.cpp.

◆ insert()

void QgsRasterRendererRegistry::insert ( const QgsRasterRendererRegistryEntry & entry)

Inserts a new entry into the registry.

Note
Not available in Python bindings

Definition at line 81 of file qgsrasterrendererregistry.cpp.

◆ insertWidgetFunction()

void QgsRasterRendererRegistry::insertWidgetFunction ( const QString & rendererName,
QgsRasterRendererWidgetCreateFunc func )

Sets the widget creation function for a renderer.

Note
Not available in Python bindings

Definition at line 87 of file qgsrasterrendererregistry.cpp.

◆ rendererCapabilities()

Qgis::RasterRendererCapabilities QgsRasterRendererRegistry::rendererCapabilities ( const QString & rendererName) const

Returns the capabilities for the renderer with the specified name.

Since
QGIS 3.38

Definition at line 124 of file qgsrasterrendererregistry.cpp.

◆ rendererData()

bool QgsRasterRendererRegistry::rendererData ( const QString & rendererName,
QgsRasterRendererRegistryEntry & data ) const

Retrieves renderer data from the registry.

Note
Not available in Python bindings

Definition at line 96 of file qgsrasterrendererregistry.cpp.

◆ renderersList()

QStringList QgsRasterRendererRegistry::renderersList ( ) const

Returns a list of the names of registered renderers.

Definition at line 107 of file qgsrasterrendererregistry.cpp.

Member Data Documentation

◆ settingsDefaultBlueBand

const QgsSettingsEntryInteger * QgsRasterRendererRegistry::settingsDefaultBlueBand = new QgsSettingsEntryInteger( u"default-blue-band"_s, QgsSettingsTree::sTreeRaster, 3, u"Default band number assigned to the blue channel when creating an RGB renderer for a multi-band raster."_s )
static

Definition at line 160 of file qgsrasterrendererregistry.h.

◆ settingsDefaultGreenBand

const QgsSettingsEntryInteger * QgsRasterRendererRegistry::settingsDefaultGreenBand = new QgsSettingsEntryInteger( u"default-green-band"_s, QgsSettingsTree::sTreeRaster, 2, u"Default band number assigned to the green channel when creating an RGB renderer for a multi-band raster."_s )
static

Definition at line 159 of file qgsrasterrendererregistry.h.

◆ settingsDefaultRedBand

const QgsSettingsEntryInteger * QgsRasterRendererRegistry::settingsDefaultRedBand = new QgsSettingsEntryInteger( u"default-red-band"_s, QgsSettingsTree::sTreeRaster, 1, u"Default band number assigned to the red channel when creating an RGB renderer for a multi-band raster."_s )
static

Definition at line 158 of file qgsrasterrendererregistry.h.

◆ settingsDefaultStandardDeviation

const QgsSettingsEntryDouble * QgsRasterRendererRegistry::settingsDefaultStandardDeviation = new QgsSettingsEntryDouble( u"default-standard-deviation"_s, QgsSettingsTree::sTreeRaster, 2.0, u"Default standard deviation multiplier used to compute min/max values for raster contrast enhancement when \"use-standard-deviation\" is enabled."_s )
static

Definition at line 162 of file qgsrasterrendererregistry.h.

◆ settingsUseStandardDeviation

const QgsSettingsEntryBool * QgsRasterRendererRegistry::settingsUseStandardDeviation = new QgsSettingsEntryBool( u"use-standard-deviation"_s, QgsSettingsTree::sTreeRaster, false, u"If true, newly created raster renderers use a standard-deviation based contrast enhancement by default."_s )
static

Definition at line 161 of file qgsrasterrendererregistry.h.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.15.0