Skip to content

Commit 176b7ca

Browse files
3nids3nids
committed
sipify core raster part 3
1 parent dff3011 commit 176b7ca

30 files changed

+1135
-369
lines changed

‎python/auto_sip.blacklist

-15
Original file line numberDiff line numberDiff line change
@@ -48,21 +48,6 @@ core/gps/qgsgpsdconnection.sip
4848
core/gps/qgsgpsdetector.sip
4949
core/gps/qgsnmeaconnection.sip
5050
core/gps/qgsqtlocationconnection.sip
51-
core/raster/qgsrasterpipe.sip
52-
core/raster/qgsrasterprojector.sip
53-
core/raster/qgsrasterpyramid.sip
54-
core/raster/qgsrasterrange.sip
55-
core/raster/qgsrasterrenderer.sip
56-
core/raster/qgsrasterresamplefilter.sip
57-
core/raster/qgsrasterresampler.sip
58-
core/raster/qgsrastershader.sip
59-
core/raster/qgsrastershaderfunction.sip
60-
core/raster/qgsrastertransparency.sip
61-
core/raster/qgsrasterviewport.sip
62-
core/raster/qgssinglebandcolordatarenderer.sip
63-
core/raster/qgssinglebandgrayrenderer.sip
64-
core/raster/qgssinglebandpseudocolorrenderer.sip
65-
core/raster/qgshillshaderenderer.sip
6651
core/symbology-ng/qgscolorbrewerpalette.sip
6752
core/symbology-ng/qgscptcityarchive.sip
6853
core/symbology-ng/qgsstyle.sip

‎python/core/raster/qgshillshaderenderer.sip

+100-64
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,133 @@
1-
/**
2-
* @brief A renderer for generating live hillshade models.
3-
* @note added in QGIS 2.16
4-
*/
1+
/************************************************************************
2+
* This file has been generated automatically from *
3+
* *
4+
* src/core/raster/qgshillshaderenderer.h *
5+
* *
6+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
7+
************************************************************************/
8+
9+
10+
11+
12+
13+
514

615
class QgsHillshadeRenderer : QgsRasterRenderer
716
{
17+
%Docstring
18+
A renderer for generating live hillshade models.
19+
.. versionadded:: 2.16
20+
%End
21+
822
%TypeHeaderCode
9-
#include "qgshillshaderenderer.h"
23+
#include "qgshillshaderenderer.h"
1024
%End
1125
public:
1226

13-
/**
14-
* @brief A renderer for generating live hillshade models.
15-
* @param input The input raster interface
16-
* @param band The band in the raster to use
17-
* @param lightAzimuth The azimuth of the light source
18-
* @param lightAltitude The altitude of the light source
19-
*/
20-
QgsHillshadeRenderer( QgsRasterInterface *input, int band, double lightAzimuth, double lightAngle );
21-
22-
~QgsHillshadeRenderer();
27+
QgsHillshadeRenderer( QgsRasterInterface *input, int band, double lightAzimuth, double lightAltitude );
28+
%Docstring
29+
A renderer for generating live hillshade models.
30+
\param input The input raster interface
31+
\param band The band in the raster to use
32+
\param lightAzimuth The azimuth of the light source
33+
\param lightAltitude The altitude of the light source
34+
%End
2335

2436
virtual QgsHillshadeRenderer *clone() const /Factory/;
2537

26-
/**
27-
* @brief Factory method to create a new renderer
28-
* @param elem A DOM element to create the renderer from.
29-
* @param input The raster input interface.
30-
* @return A new QgsHillshadeRenderer.
31-
*/
38+
3239
static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input ) /Factory/;
40+
%Docstring
41+
Factory method to create a new renderer
42+
\param elem A DOM element to create the renderer from.
43+
\param input The raster input interface.
44+
:return: A new QgsHillshadeRenderer.
45+
:rtype: QgsRasterRenderer
46+
%End
47+
48+
virtual void writeXml( QDomDocument &doc, QDomElement &parentElem ) const;
49+
50+
51+
virtual QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = 0 );
3352

34-
QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = 0 ) /Factory/;
3553

36-
void writeXml( QDomDocument &doc, QDomElement &parentElem ) const;
54+
virtual QList<int> usesBands() const;
3755

38-
QList<int> usesBands() const;
3956

40-
/** Returns the band used by the renderer
41-
*/
4257
int band() const;
58+
%Docstring
59+
Returns the band used by the renderer
60+
:rtype: int
61+
%End
4362

44-
/** Sets the band used by the renderer.
45-
* @see band
46-
*/
4763
void setBand( int bandNo );
64+
%Docstring
65+
Sets the band used by the renderer.
66+
.. seealso:: band
67+
%End
4868

49-
/**
50-
* Returns the direction of the light over the raster between 0-360.
51-
* @see setAzimuth()
52-
*/
5369
double azimuth() const;
70+
%Docstring
71+
Returns the direction of the light over the raster between 0-360.
72+
.. seealso:: setAzimuth()
73+
:rtype: float
74+
%End
5475

55-
/** Returns the angle of the light source over the raster.
56-
* @see setAltitude()
57-
*/
5876
double altitude() const;
77+
%Docstring
78+
Returns the angle of the light source over the raster.
79+
.. seealso:: setAltitude()
80+
:rtype: float
81+
%End
5982

60-
/** Returns the Z scaling factor.
61-
* @see setZFactor()
62-
*/
6383
double zFactor() const;
84+
%Docstring
85+
Returns the Z scaling factor.
86+
.. seealso:: setZFactor()
87+
:rtype: float
88+
%End
6489

65-
/** Returns true if the renderer is using multi-directional hillshading.
66-
* @see setMultiDirectional()
67-
*/
6890
bool multiDirectional() const;
91+
%Docstring
92+
Returns true if the renderer is using multi-directional hillshading.
93+
.. seealso:: setMultiDirectional()
94+
:rtype: bool
95+
%End
6996

70-
71-
/**
72-
* @brief Set the azimuth of the light source.
73-
* @param azimuth The azimuth of the light source, between 0 and 360.0
74-
* @see azimuth()
75-
*/
7697
void setAzimuth( double azimuth );
98+
%Docstring
99+
Set the azimuth of the light source.
100+
\param azimuth The azimuth of the light source, between 0 and 360.0
101+
.. seealso:: azimuth()
102+
%End
103+
104+
void setAltitude( double altitude );
105+
%Docstring
106+
Set the altitude of the light source
107+
\param altitude the altitude
108+
.. seealso:: altitude()
109+
%End
77110

78-
/**
79-
* @brief Set the altitude of the light source
80-
* @param altitude the altitude
81-
* @see altitude()
82-
*/
83-
void setAltitude( double angle );
84-
85-
/**
86-
* @brief Set the Z scaling factor of the result image.
87-
* @param zfactor The z factor
88-
* @see zFactor()
89-
*/
90111
void setZFactor( double zfactor );
112+
%Docstring
113+
Set the Z scaling factor of the result image.
114+
\param zfactor The z factor
115+
.. seealso:: zFactor()
116+
%End
91117

92-
/** Sets whether to render using a multi-directional hillshade algorithm.
93-
* @param isMultiDirectional set to true to use multi directional rendering
94-
* @see multiDirectional()
95-
*/
96118
void setMultiDirectional( bool isMultiDirectional );
119+
%Docstring
120+
Sets whether to render using a multi-directional hillshade algorithm.
121+
\param isMultiDirectional set to true to use multi directional rendering
122+
.. seealso:: multiDirectional()
123+
%End
124+
97125
};
126+
127+
/************************************************************************
128+
* This file has been generated automatically from *
129+
* *
130+
* src/core/raster/qgshillshaderenderer.h *
131+
* *
132+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
133+
************************************************************************/

0 commit comments

Comments
 (0)