1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgselevationshadingrenderer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsElevationShadingRenderer
{
%Docstring(signature="appended")
This class can render elevation shading on an image with different
methods (eye dome lighting, hillshading, ...).
An instance of this class supports the following settings:
- activate/deactivate elevation shading
- activate/deactivate a particular shading method
- parameters of each shading method
To render shading on image the caller call :py:func:`~renderShading`
with the image and an elevation map (see QgsElevationMap()) as
parameters. The shading is applied on the image in place. Elevation map
and image must have same sizes.
.. versionadded:: 3.30
%End
%TypeHeaderCode
#include "qgselevationshadingrenderer.h"
%End
public:
QgsElevationShadingRenderer();
void renderShading( const QgsElevationMap &elevation, QImage &image, const QgsRenderContext &context ) const;
%Docstring
Render shading on ``image`` condidering the elevation map ``elevation``
and the renderer context ``context`` If elevation map and the image
don't have same sizes, nothing happens.
%End
void setActive( bool active );
%Docstring
Sets whether this shading renderer is active.
%End
bool isActive() const;
%Docstring
Returns whether this shading renderer is active.
%End
void setActiveEyeDomeLighting( bool active );
%Docstring
Sets active the eye-dome lighting shading method.
%End
bool isActiveEyeDomeLighting() const;
%Docstring
Returns whether eye-dome lighting shading method is active
%End
double eyeDomeLightingStrength() const;
%Docstring
Returns the strength of the eye dome lighting method.
.. seealso:: :py:func:`setEyeDomeLightingStrength`
%End
void setEyeDomeLightingStrength( double strength );
%Docstring
Sets the ``strength`` of the eye dome lighting method.
.. seealso:: :py:func:`eyeDomeLightingStrength`
%End
double eyeDomeLightingDistance() const;
%Docstring
Returns the distance of the eye dome lighting method, that is the
distance where the effect is apply from the source elevation.
.. seealso:: :py:func:`setEyeDomeLightingDistance`
%End
void setEyeDomeLightingDistance( double distance );
%Docstring
Sets the distance of the eye dome lighting method, that is the distance
where the effect is apply from the source elevation.
.. seealso:: :py:func:`eyeDomeLightingDistance`
%End
Qgis::RenderUnit eyeDomeLightingDistanceUnit() const;
%Docstring
Returns the unit of the distance of the eye dome lighting method
returned by
:py:func:`~QgsElevationShadingRenderer.eyeDomeLightingDistance`.
.. seealso:: :py:func:`setEyeDomeLightingDistanceUnit`
%End
void setEyeDomeLightingDistanceUnit( Qgis::RenderUnit unit );
%Docstring
Sets the ``unit`` of the distance of the eye dome lighting method set by
:py:func:`~QgsElevationShadingRenderer.setEyeDomeLightingDistance`.
.. seealso:: :py:func:`eyeDomeLightingDistanceUnit`
%End
void setActiveHillshading( bool active );
%Docstring
Sets active the hillshading
%End
bool isActiveHillshading() const;
%Docstring
Returns whether the hillshading is active
%End
double hillshadingZFactor() const;
%Docstring
Returns the z factor used by the hill shading method.
.. seealso:: :py:func:`setHillshadingZFactor`
%End
void setHillshadingZFactor( double zFactor );
%Docstring
Sets the z factor used by the hill shading method.
.. seealso:: :py:func:`hillshadingZFactor`
%End
bool isHillshadingMultidirectional() const;
%Docstring
Returns whether the hill shading method is multidirectional.
.. seealso:: :py:func:`setHillshadingMultidirectional`
%End
void setHillshadingMultidirectional( bool multiDirectional );
%Docstring
Sets whether the hill shading method is multidirectional.
.. seealso:: :py:func:`isHillshadingMultidirectional`
%End
double lightAltitude() const;
%Docstring
Returns the altitude of the light (degree) that can be used by some
methods (e.g. hill shading).
.. seealso:: :py:func:`setLightAltitude`
%End
void setLightAltitude( double lightAltitude );
%Docstring
Sets the altitude of the light (degree) that can be used by some methods
(e.g. hill shading).
.. seealso:: :py:func:`setLightAltitude`
%End
double lightAzimuth() const;
%Docstring
Returns the azimuth of the light (degree) that can be used by some
methods (e.g. hill shading).
.. seealso:: :py:func:`setLightAltitude`
%End
void setLightAzimuth( double lightAzimuth );
%Docstring
Sets the azimuth of the light (degree) that can be used by some methods
(e.g. hill shading).
.. seealso:: :py:func:`lightAzimuth`
%End
void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const;
%Docstring
Writes configuration on a DOM element
%End
void readXml( const QDomElement &element, const QgsReadWriteContext &context );
%Docstring
Reads configuration from a DOM element
%End
Qgis::ElevationMapCombineMethod combinedElevationMethod() const;
%Docstring
Returns the method used when conbining different elevation sources.
.. seealso:: :py:func:`setCombinedElevationMethod`
%End
void setCombinedElevationMethod( Qgis::ElevationMapCombineMethod method );
%Docstring
Sets the ``method`` used when conbining different elevation sources.
.. seealso:: :py:func:`combinedElevationMethod`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgselevationshadingrenderer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
