Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
30 changed files
with
1,135 additions
and
369 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,97 +1,133 @@ | ||
| /** | ||
| * @brief A renderer for generating live hillshade models. | ||
| * @note added in QGIS 2.16 | ||
| */ | ||
| /************************************************************************ | ||
| * This file has been generated automatically from * | ||
| * * | ||
| * src/core/raster/qgshillshaderenderer.h * | ||
| * * | ||
| * Do not edit manually ! Edit header and run scripts/sipify.pl again * | ||
| ************************************************************************/ | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| class QgsHillshadeRenderer : QgsRasterRenderer | ||
| { | ||
| %Docstring | ||
| A renderer for generating live hillshade models. | ||
| .. versionadded:: 2.16 | ||
| %End | ||
|
|
||
| %TypeHeaderCode | ||
| #include "qgshillshaderenderer.h" | ||
| #include "qgshillshaderenderer.h" | ||
| %End | ||
| public: | ||
|
|
||
| /** | ||
| * @brief A renderer for generating live hillshade models. | ||
| * @param input The input raster interface | ||
| * @param band The band in the raster to use | ||
| * @param lightAzimuth The azimuth of the light source | ||
| * @param lightAltitude The altitude of the light source | ||
| */ | ||
| QgsHillshadeRenderer( QgsRasterInterface *input, int band, double lightAzimuth, double lightAngle ); | ||
|
|
||
| ~QgsHillshadeRenderer(); | ||
| QgsHillshadeRenderer( QgsRasterInterface *input, int band, double lightAzimuth, double lightAltitude ); | ||
| %Docstring | ||
| A renderer for generating live hillshade models. | ||
| \param input The input raster interface | ||
| \param band The band in the raster to use | ||
| \param lightAzimuth The azimuth of the light source | ||
| \param lightAltitude The altitude of the light source | ||
| %End | ||
|
|
||
| virtual QgsHillshadeRenderer *clone() const /Factory/; | ||
|
|
||
| /** | ||
| * @brief Factory method to create a new renderer | ||
| * @param elem A DOM element to create the renderer from. | ||
| * @param input The raster input interface. | ||
| * @return A new QgsHillshadeRenderer. | ||
| */ | ||
|
|
||
| static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input ) /Factory/; | ||
| %Docstring | ||
| Factory method to create a new renderer | ||
| \param elem A DOM element to create the renderer from. | ||
| \param input The raster input interface. | ||
| :return: A new QgsHillshadeRenderer. | ||
| :rtype: QgsRasterRenderer | ||
| %End | ||
|
|
||
| virtual void writeXml( QDomDocument &doc, QDomElement &parentElem ) const; | ||
|
|
||
|
|
||
| virtual QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = 0 ); | ||
|
|
||
| QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = 0 ) /Factory/; | ||
|
|
||
| void writeXml( QDomDocument &doc, QDomElement &parentElem ) const; | ||
| virtual QList<int> usesBands() const; | ||
|
|
||
| QList<int> usesBands() const; | ||
|
|
||
| /** Returns the band used by the renderer | ||
| */ | ||
| int band() const; | ||
| %Docstring | ||
| Returns the band used by the renderer | ||
| :rtype: int | ||
| %End | ||
|
|
||
| /** Sets the band used by the renderer. | ||
| * @see band | ||
| */ | ||
| void setBand( int bandNo ); | ||
| %Docstring | ||
| Sets the band used by the renderer. | ||
| .. seealso:: band | ||
| %End | ||
|
|
||
| /** | ||
| * Returns the direction of the light over the raster between 0-360. | ||
| * @see setAzimuth() | ||
| */ | ||
| double azimuth() const; | ||
| %Docstring | ||
| Returns the direction of the light over the raster between 0-360. | ||
| .. seealso:: setAzimuth() | ||
| :rtype: float | ||
| %End | ||
|
|
||
| /** Returns the angle of the light source over the raster. | ||
| * @see setAltitude() | ||
| */ | ||
| double altitude() const; | ||
| %Docstring | ||
| Returns the angle of the light source over the raster. | ||
| .. seealso:: setAltitude() | ||
| :rtype: float | ||
| %End | ||
|
|
||
| /** Returns the Z scaling factor. | ||
| * @see setZFactor() | ||
| */ | ||
| double zFactor() const; | ||
| %Docstring | ||
| Returns the Z scaling factor. | ||
| .. seealso:: setZFactor() | ||
| :rtype: float | ||
| %End | ||
|
|
||
| /** Returns true if the renderer is using multi-directional hillshading. | ||
| * @see setMultiDirectional() | ||
| */ | ||
| bool multiDirectional() const; | ||
| %Docstring | ||
| Returns true if the renderer is using multi-directional hillshading. | ||
| .. seealso:: setMultiDirectional() | ||
| :rtype: bool | ||
| %End | ||
|
|
||
|
|
||
| /** | ||
| * @brief Set the azimuth of the light source. | ||
| * @param azimuth The azimuth of the light source, between 0 and 360.0 | ||
| * @see azimuth() | ||
| */ | ||
| void setAzimuth( double azimuth ); | ||
| %Docstring | ||
| Set the azimuth of the light source. | ||
| \param azimuth The azimuth of the light source, between 0 and 360.0 | ||
| .. seealso:: azimuth() | ||
| %End | ||
|
|
||
| void setAltitude( double altitude ); | ||
| %Docstring | ||
| Set the altitude of the light source | ||
| \param altitude the altitude | ||
| .. seealso:: altitude() | ||
| %End | ||
|
|
||
| /** | ||
| * @brief Set the altitude of the light source | ||
| * @param altitude the altitude | ||
| * @see altitude() | ||
| */ | ||
| void setAltitude( double angle ); | ||
|
|
||
| /** | ||
| * @brief Set the Z scaling factor of the result image. | ||
| * @param zfactor The z factor | ||
| * @see zFactor() | ||
| */ | ||
| void setZFactor( double zfactor ); | ||
| %Docstring | ||
| Set the Z scaling factor of the result image. | ||
| \param zfactor The z factor | ||
| .. seealso:: zFactor() | ||
| %End | ||
|
|
||
| /** Sets whether to render using a multi-directional hillshade algorithm. | ||
| * @param isMultiDirectional set to true to use multi directional rendering | ||
| * @see multiDirectional() | ||
| */ | ||
| void setMultiDirectional( bool isMultiDirectional ); | ||
| %Docstring | ||
| Sets whether to render using a multi-directional hillshade algorithm. | ||
| \param isMultiDirectional set to true to use multi directional rendering | ||
| .. seealso:: multiDirectional() | ||
| %End | ||
|
|
||
| }; | ||
|
|
||
| /************************************************************************ | ||
| * This file has been generated automatically from * | ||
| * * | ||
| * src/core/raster/qgshillshaderenderer.h * | ||
| * * | ||
| * Do not edit manually ! Edit header and run scripts/sipify.pl again * | ||
| ************************************************************************/ |
Oops, something went wrong.