QGIS API Documentation  2.99.0-Master (9fdd060)
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...
 
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...
 
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...
 
void setBand (int bandNo)
 Sets the band used by 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...
 
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 (QgsRasterInterface *input=nullptr, const QString &type=QString())
 Constructor for QgsRasterRenderer. More...
 
 QgsRasterRenderer (const QgsRasterRenderer &)=delete
 QgsRasterRenderer cannot be copied. Use clone() instead. More...
 
virtual ~QgsRasterRenderer ()
 
int alphaBand () const
 
virtual int bandCount () const override
 Get number of bands. More...
 
void copyCommonProperties (const QgsRasterRenderer *other, bool copyMinMaxOrigin=true)
 Copies common properties like opacity / transparency data from other renderer. More...
 
virtual Qgis::DataType dataType (int bandNo) const override
 Returns data type for the band specified by number. More...
 
virtual void legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
 Get symbology items if provided by renderer. More...
 
const QgsRasterMinMaxOriginminMaxOrigin () const
 Returns const reference to origin of min/max values. 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)
 
virtual bool setInput (QgsRasterInterface *input) override
 Set input. More...
 
void setMinMaxOrigin (const QgsRasterMinMaxOrigin &origin)
 Sets origin of min/max values. 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 QString type () const
 
bool usesTransparency () const
 
- Public Member Functions inherited from QgsRasterInterface
 QgsRasterInterface (QgsRasterInterface *input=nullptr)
 
virtual ~QgsRasterInterface ()=default
 
virtual QgsRasterBandStats bandStatistics (int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
 Get band statistics. More...
 
virtual int capabilities () const
 Returns a bitmask containing the supported capabilities. More...
 
QString capabilitiesString () const
 Returns the above in friendly format. 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...
 
int dataTypeSize (int bandNo)
 
virtual QgsRectangle extent () const
 Get 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...
 
virtual bool hasStatistics (int bandNo, int stats=QgsRasterBandStats::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)
 Get histogram. More...
 
virtual QgsRasterInterfaceinput () const
 Current input. More...
 
virtual bool on () const
 Is on/off. More...
 
virtual void setOn (bool on)
 Set on/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 const QgsRasterInterfacesourceInput () const
 Get source / raw input, the first in pipe, usually provider. More...
 
virtual QgsRasterInterfacesourceInput ()
 Get source / raw input, the first in pipe, usually provider. More...
 
virtual int xBlockSize () const
 Get block size. More...
 
virtual int xSize () const
 Get 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
}
 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...
 
- 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...
 
void initStatistics (QgsRasterBandStats &statistics, int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0)
 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.

Since
QGIS 2.16

Definition at line 36 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 27 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 86 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 80 of file qgshillshaderenderer.h.

◆ band()

int QgsHillshadeRenderer::band ( ) const
inline

Returns the band used by the renderer.

Definition at line 68 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 cancelation/preview. Added in QGIS 3.0.

Implements QgsRasterRenderer.

Definition at line 86 of file qgshillshaderenderer.cpp.

◆ clone()

QgsHillshadeRenderer * QgsHillshadeRenderer::clone ( ) const
overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 38 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 48 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 98 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 112 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 105 of file qgshillshaderenderer.h.

◆ setBand()

void QgsHillshadeRenderer::setBand ( int  bandNo)

Sets the band used by the renderer.

See also
band

Definition at line 281 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 126 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 119 of file qgshillshaderenderer.h.

◆ usesBands()

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

Returns a list of band numbers used by the renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 270 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 68 of file qgshillshaderenderer.cpp.

◆ zFactor()

double QgsHillshadeRenderer::zFactor ( ) const
inline

Returns the Z scaling factor.

See also
setZFactor()

Definition at line 92 of file qgshillshaderenderer.h.


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