QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | Static Public Member Functions | List of all members
QgsHillshadeRenderer Class Reference

A renderer for generating live hillshade models. More...

#include <qgshillshaderenderer.h>

Inheritance diagram for QgsHillshadeRenderer:
Inheritance graph
[legend]

Public Member Functions

 QgsHillshadeRenderer (QgsRasterInterface *input, int band, double lightAzimuth, double lightAltitude)
 A renderer for generating live hillshade models. More...
 
double altitude () const
 Returns the angle of the light source over the raster. More...
 
double azimuth () const
 Returns the direction of the light over the raster between 0-360. More...
 
Q_DECL_DEPRECATED int band () const
 Returns the band used by the renderer. More...
 
QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
 Read block of data using given extent and size. More...
 
QgsHillshadeRendererclone () const override
 Clone itself, create deep copy. More...
 
Qgis::RasterRendererFlags flags () const override
 Returns flags which dictate renderer behavior. More...
 
int inputBand () const override
 Returns the input band for the renderer, or -1 if no input band is available. More...
 
bool multiDirectional () const
 Returns true if the renderer is using multi-directional hillshading. More...
 
void setAltitude (double altitude)
 Set the altitude of the light source. More...
 
void setAzimuth (double azimuth)
 Set the azimuth of the light source. More...
 
Q_DECL_DEPRECATED void setBand (int bandNo)
 Sets the band used by the renderer. More...
 
bool setInputBand (int band) override
 Attempts to set the input band for the renderer. More...
 
void setMultiDirectional (bool isMultiDirectional)
 Sets whether to render using a multi-directional hillshade algorithm. More...
 
void setZFactor (double zfactor)
 Set the Z scaling factor of the result image. More...
 
void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const override
 Used from subclasses to create SLD Rule elements following SLD v1.0 specs. More...
 
QList< int > usesBands () const override
 Returns a list of band numbers used by the renderer. More...
 
void writeXml (QDomDocument &doc, QDomElement &parentElem) const override
 Write base class members to xml. More...
 
double zFactor () const
 Returns the Z scaling factor. More...
 
- Public Member Functions inherited from QgsRasterRenderer
 QgsRasterRenderer (const QgsRasterRenderer &)=delete
 QgsRasterRenderer cannot be copied. Use clone() instead. More...
 
 QgsRasterRenderer (QgsRasterInterface *input=nullptr, const QString &type=QString())
 Constructor for QgsRasterRenderer. More...
 
 ~QgsRasterRenderer () override
 
virtual bool accept (QgsStyleEntityVisitorInterface *visitor) const
 Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. More...
 
int alphaBand () const
 
int bandCount () const override
 Gets number of bands. More...
 
QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override=0
 Read block of data using given extent and size. More...
 
virtual bool canCreateRasterAttributeTable () const
 Returns true if the renderer is suitable for attribute table creation. More...
 
QgsRasterRendererclone () const override=0
 Clone itself, create deep copy. More...
 
void copyCommonProperties (const QgsRasterRenderer *other, bool copyMinMaxOrigin=true)
 Copies common properties like opacity / transparency data from other renderer. More...
 
virtual QList< QgsLayerTreeModelLegendNode * > createLegendNodes (QgsLayerTreeLayer *nodeLayer)
 Creates a set of legend nodes representing the renderer. More...
 
Qgis::DataType dataType (int bandNo) const override
 Returns data type for the band specified by number. More...
 
virtual Qgis::RasterRendererFlags flags () const
 Returns flags which dictate renderer behavior. More...
 
virtual int inputBand () const
 Returns the input band for the renderer, or -1 if no input band is available. More...
 
virtual QList< QPair< QString, QColor > > legendSymbologyItems () const
 Returns symbology items if provided by renderer. More...
 
const QgsRasterMinMaxOriginminMaxOrigin () const
 Returns const reference to origin of min/max values. More...
 
QColor nodataColor () const
 Returns the color to use for shading nodata pixels. More...
 
double opacity () const
 Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More...
 
const QgsRasterRendereroperator= (const QgsRasterRenderer &)=delete
 QgsRasterRenderer cannot be copied. Use clone() instead. More...
 
const QgsRasterTransparencyrasterTransparency () const
 
void readXml (const QDomElement &rendererElem) override
 Sets base class members from xml. Usually called from create() methods of subclasses. More...
 
void setAlphaBand (int band)
 
bool setInput (QgsRasterInterface *input) override
 Set input. More...
 
virtual bool setInputBand (int band)
 Attempts to set the input band for the renderer. More...
 
void setMinMaxOrigin (const QgsRasterMinMaxOrigin &origin)
 Sets origin of min/max values. More...
 
void setNodataColor (const QColor &color)
 Sets the color to use for shading nodata pixels. More...
 
void setOpacity (double opacity)
 Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More...
 
void setRasterTransparency (QgsRasterTransparency *t)
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const
 Used from subclasses to create SLD Rule elements following SLD v1.0 specs. More...
 
virtual QString type () const
 Returns a unique string representation of the renderer type. More...
 
virtual QList< int > usesBands () const
 Returns a list of band numbers used by the renderer. More...
 
bool usesTransparency () const
 
- Public Member Functions inherited from QgsRasterInterface
 QgsRasterInterface (QgsRasterInterface *input=nullptr)
 
virtual ~QgsRasterInterface ()=default
 
virtual int bandCount () const =0
 Gets number of bands. More...
 
Q_DECL_DEPRECATED QgsRasterBandStats bandStatistics (int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
 Returns the band statistics. More...
 
virtual QgsRasterBandStats bandStatistics (int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
 Returns the band statistics. More...
 
virtual QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr)=0
 Read block of data using given extent and size. More...
 
virtual int capabilities () const
 Returns a bitmask containing the supported capabilities. More...
 
QString capabilitiesString () const
 Returns the raster interface capabilities in friendly format. More...
 
virtual QgsRasterInterfaceclone () const =0
 Clone itself, create deep copy. More...
 
virtual QString colorInterpretationName (int bandNumber) const
 Returns the name of the color interpretation for the specified bandNumber. More...
 
virtual void cumulativeCut (int bandNo, double lowerCount, double upperCount, double &lowerValue, double &upperValue, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
 Find values for cumulative pixel count cut. More...
 
virtual Qgis::DataType dataType (int bandNo) const =0
 Returns data type for the band specified by number. More...
 
int dataTypeSize (int bandNo) const
 Returns the size (in bytes) for the data type for the specified band. More...
 
QString displayBandName (int bandNumber) const
 Generates a friendly, descriptive name for the specified bandNumber. More...
 
virtual QgsRectangle extent () const
 Gets the extent of the interface. More...
 
virtual QString generateBandName (int bandNumber) const
 helper function to create zero padded band names More...
 
virtual bool hasHistogram (int bandNo, int binCount, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false)
 Returns true if histogram is available (cached, already calculated) More...
 
Q_DECL_DEPRECATED bool hasStatistics (int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
 Returns true if histogram is available (cached, already calculated). More...
 
virtual bool hasStatistics (int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
 Returns true if histogram is available (cached, already calculated). More...
 
virtual QgsRasterHistogram histogram (int bandNo, int binCount=0, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false, QgsRasterBlockFeedback *feedback=nullptr)
 Returns a band histogram. More...
 
virtual QgsRasterInterfaceinput () const
 Current input. More...
 
virtual bool on () const
 Returns whether the interface is on or off. More...
 
virtual void readXml (const QDomElement &filterElem)
 Sets base class members from xml. Usually called from create() methods of subclasses. More...
 
virtual bool setInput (QgsRasterInterface *input)
 Set input. More...
 
virtual void setOn (bool on)
 Sets whether the interface is on or off. More...
 
virtual Qgis::DataType sourceDataType (int bandNo) const
 Returns source data type for the band specified by number, source data type may be shorter than dataType. More...
 
virtual QgsRasterInterfacesourceInput ()
 Gets source / raw input, the first in pipe, usually provider. More...
 
virtual const QgsRasterInterfacesourceInput () const
 Gets source / raw input, the first in pipe, usually provider. More...
 
virtual void writeXml (QDomDocument &doc, QDomElement &parentElem) const
 Write base class members to xml. More...
 
virtual int xBlockSize () const
 Gets block size. More...
 
virtual int xSize () const
 Gets raster size. More...
 
virtual int yBlockSize () const
 
virtual int ySize () const
 

Static Public Member Functions

static QgsRasterRenderercreate (const QDomElement &elem, QgsRasterInterface *input)
 Factory method to create a new renderer. More...
 

Additional Inherited Members

- Public Types inherited from QgsRasterInterface
enum  Capability {
  NoCapabilities = 0 , Size = 1 << 1 , Create = 1 << 2 , Remove = 1 << 3 ,
  BuildPyramids = 1 << 4 , Identify = 1 << 5 , IdentifyValue = 1 << 6 , IdentifyText = 1 << 7 ,
  IdentifyHtml = 1 << 8 , IdentifyFeature = 1 << 9 , Prefetch = 1 << 10
}
 If you add to this, please also add to capabilitiesString() More...
 
- Static Public Attributes inherited from QgsRasterRenderer
static const QRgb NODATA_COLOR = qRgba( 0, 0, 0, 0 )
 
- Protected Member Functions inherited from QgsRasterRenderer
void _writeXml (QDomDocument &doc, QDomElement &rasterRendererElem) const
 Write upper class info into rasterrenderer element (called by writeXml method of subclasses) More...
 
QRgb renderColorForNodataPixel () const
 Returns the color for the renderer to use to represent nodata pixels. More...
 
- Protected Member Functions inherited from QgsRasterInterface
void initHistogram (QgsRasterHistogram &histogram, int bandNo, int binCount, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &boundingBox=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false)
 Fill in histogram defaults if not specified. More...
 
Q_DECL_DEPRECATED void initStatistics (QgsRasterBandStats &statistics, int bandNo, int stats, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0) const
 Fill in statistics defaults if not specified. More...
 
void initStatistics (QgsRasterBandStats &statistics, int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0) const
 Fill in statistics defaults if not specified. More...
 
- Protected Attributes inherited from QgsRasterRenderer
int mAlphaBand = -1
 Read alpha value from band. More...
 
QgsRasterMinMaxOrigin mMinMaxOrigin
 Origin of min/max values. More...
 
double mOpacity = 1.0
 Global alpha value (0-1) More...
 
QgsRasterTransparencymRasterTransparency = nullptr
 Raster transparency per color or value. Overwrites global alpha value. More...
 
QString mType
 
- Protected Attributes inherited from QgsRasterInterface
QList< QgsRasterHistogrammHistograms
 List of cached histograms, all bands mixed. More...
 
QgsRasterInterfacemInput = nullptr
 
bool mOn = true
 
QList< QgsRasterBandStatsmStatistics
 List of cached statistics, all bands mixed. More...
 

Detailed Description

A renderer for generating live hillshade models.

Definition at line 35 of file qgshillshaderenderer.h.

Constructor & Destructor Documentation

◆ QgsHillshadeRenderer()

QgsHillshadeRenderer::QgsHillshadeRenderer ( QgsRasterInterface input,
int  band,
double  lightAzimuth,
double  lightAltitude 
)

A renderer for generating live hillshade models.

Parameters
inputThe input raster interface
bandThe band in the raster to use
lightAzimuthThe azimuth of the light source
lightAltitudeThe altitude of the light source

Definition at line 37 of file qgshillshaderenderer.cpp.

Member Function Documentation

◆ altitude()

double QgsHillshadeRenderer::altitude ( ) const
inline

Returns the angle of the light source over the raster.

See also
setAltitude()

Definition at line 94 of file qgshillshaderenderer.h.

◆ azimuth()

double QgsHillshadeRenderer::azimuth ( ) const
inline

Returns the direction of the light over the raster between 0-360.

See also
setAzimuth()

Definition at line 88 of file qgshillshaderenderer.h.

◆ band()

Q_DECL_DEPRECATED int QgsHillshadeRenderer::band ( ) const
inline

Returns the band used by the renderer.

Deprecated:
since QGIS 3.38 use inputBand() instead

Definition at line 73 of file qgshillshaderenderer.h.

◆ block()

QgsRasterBlock * QgsHillshadeRenderer::block ( int  bandNo,
const QgsRectangle extent,
int  width,
int  height,
QgsRasterBlockFeedback feedback = nullptr 
)
overridevirtual

Read block of data using given extent and size.

Returns pointer to data. Caller is responsible to free the memory returned.

Parameters
bandNoband number
extentextent of block
widthpixel width of block
heightpixel height of block
feedbackoptional raster feedback object for cancellation/preview. Added in QGIS 3.0.

Implements QgsRasterRenderer.

Definition at line 99 of file qgshillshaderenderer.cpp.

◆ clone()

QgsHillshadeRenderer * QgsHillshadeRenderer::clone ( ) const
overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 46 of file qgshillshaderenderer.cpp.

◆ create()

QgsRasterRenderer * QgsHillshadeRenderer::create ( const QDomElement &  elem,
QgsRasterInterface input 
)
static

Factory method to create a new renderer.

Parameters
elemA DOM element to create the renderer from.
inputThe raster input interface.
Returns
A new QgsHillshadeRenderer.

Definition at line 61 of file qgshillshaderenderer.cpp.

◆ flags()

Qgis::RasterRendererFlags QgsHillshadeRenderer::flags ( ) const
overridevirtual

Returns flags which dictate renderer behavior.

Since
QGIS 3.28

Reimplemented from QgsRasterRenderer.

Definition at line 56 of file qgshillshaderenderer.cpp.

◆ inputBand()

int QgsHillshadeRenderer::inputBand ( ) const
overridevirtual

Returns the input band for the renderer, or -1 if no input band is available.

For renderers which utilize multiple input bands -1 will be returned. In these cases usesBands() will return a list of all utilized bands (including alpha bands).

See also
setInputBand()
usesBands()
Since
QGIS 3.38

Reimplemented from QgsRasterRenderer.

Definition at line 572 of file qgshillshaderenderer.cpp.

◆ multiDirectional()

bool QgsHillshadeRenderer::multiDirectional ( ) const
inline

Returns true if the renderer is using multi-directional hillshading.

See also
setMultiDirectional()

Definition at line 106 of file qgshillshaderenderer.h.

◆ setAltitude()

void QgsHillshadeRenderer::setAltitude ( double  altitude)
inline

Set the altitude of the light source.

Parameters
altitudethe altitude
See also
altitude()

Definition at line 120 of file qgshillshaderenderer.h.

◆ setAzimuth()

void QgsHillshadeRenderer::setAzimuth ( double  azimuth)
inline

Set the azimuth of the light source.

Parameters
azimuthThe azimuth of the light source, between 0 and 360.0
See also
azimuth()

Definition at line 113 of file qgshillshaderenderer.h.

◆ setBand()

void QgsHillshadeRenderer::setBand ( int  bandNo)

Sets the band used by the renderer.

See also
band
Deprecated:
since QGIS 3.38 use setInputBand() instead

Definition at line 577 of file qgshillshaderenderer.cpp.

◆ setInputBand()

bool QgsHillshadeRenderer::setInputBand ( int  band)
overridevirtual

Attempts to set the input band for the renderer.

Returns true if the band was successfully set, or false if the band could not be set.

Note
Not all renderers support setting the input band.
See also
inputBand()
usesBands()
Since
QGIS 3.38

Reimplemented from QgsRasterRenderer.

Definition at line 582 of file qgshillshaderenderer.cpp.

◆ setMultiDirectional()

void QgsHillshadeRenderer::setMultiDirectional ( bool  isMultiDirectional)
inline

Sets whether to render using a multi-directional hillshade algorithm.

Parameters
isMultiDirectionalset to true to use multi directional rendering
See also
multiDirectional()

Definition at line 134 of file qgshillshaderenderer.h.

◆ setZFactor()

void QgsHillshadeRenderer::setZFactor ( double  zfactor)
inline

Set the Z scaling factor of the result image.

Parameters
zfactorThe z factor
See also
zFactor()

Definition at line 127 of file qgshillshaderenderer.h.

◆ toSld()

void QgsHillshadeRenderer::toSld ( QDomDocument &  doc,
QDomElement &  element,
const QVariantMap &  props = QVariantMap() 
) const
overridevirtual

Used from subclasses to create SLD Rule elements following SLD v1.0 specs.

Since
QGIS 3.6

Reimplemented from QgsRasterRenderer.

Definition at line 597 of file qgshillshaderenderer.cpp.

◆ usesBands()

QList< int > QgsHillshadeRenderer::usesBands ( ) const
overridevirtual

Returns a list of band numbers used by the renderer.

See also
setInputBand()

Reimplemented from QgsRasterRenderer.

Definition at line 561 of file qgshillshaderenderer.cpp.

◆ writeXml()

void QgsHillshadeRenderer::writeXml ( QDomDocument &  doc,
QDomElement &  parentElem 
) const
overridevirtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 81 of file qgshillshaderenderer.cpp.

◆ zFactor()

double QgsHillshadeRenderer::zFactor ( ) const
inline

Returns the Z scaling factor.

See also
setZFactor()

Definition at line 100 of file qgshillshaderenderer.h.


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