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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshlayerelevationproperties.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsMeshLayerElevationProperties : QgsMapLayerElevationProperties
{
%Docstring(signature="appended")
Mesh layer specific subclass of
:py:class:`QgsMapLayerElevationProperties`.
.. versionadded:: 3.26
%End
%TypeHeaderCode
#include "qgsmeshlayerelevationproperties.h"
%End
public:
QgsMeshLayerElevationProperties( QObject *parent /TransferThis/ );
%Docstring
Constructor for QgsMeshLayerElevationProperties, with the specified
``parent`` object.
%End
~QgsMeshLayerElevationProperties();
virtual bool hasElevation() const;
virtual QDomElement writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context );
virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
virtual QString htmlSummary() const;
virtual QgsMeshLayerElevationProperties *clone() const /Factory/;
virtual bool isVisibleInZRange( const QgsDoubleRange &range, QgsMapLayer *layer = 0 ) const;
virtual QgsDoubleRange calculateZRange( QgsMapLayer *layer ) const;
virtual QList< double > significantZValues( QgsMapLayer *layer ) const;
virtual bool showByDefaultInElevationProfilePlots() const;
virtual QgsMapLayerElevationProperties::Flags flags() const;
Qgis::MeshElevationMode mode() const;
%Docstring
Returns the elevation mode.
.. seealso:: :py:func:`setMode`
.. versionadded:: 3.38
%End
void setMode( Qgis::MeshElevationMode mode );
%Docstring
Sets the elevation ``mode``.
.. seealso:: :py:func:`mode`
.. versionadded:: 3.38
%End
QgsDoubleRange fixedRange() const;
%Docstring
Returns the fixed elevation range for the mesh.
.. note::
This is only considered when :py:func:`~QgsMeshLayerElevationProperties.mode` is :py:class:`Qgis`.MeshElevationMode.FixedElevationRange.
.. note::
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`setFixedRange`
.. versionadded:: 3.38
%End
void setFixedRange( const QgsDoubleRange &range );
%Docstring
Sets the fixed elevation ``range`` for the mesh.
.. note::
This is only considered when :py:func:`~QgsMeshLayerElevationProperties.mode` is :py:class:`Qgis`.MeshElevationMode.FixedElevationRange.
.. note::
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`fixedRange`
.. versionadded:: 3.38
%End
QMap<int, QgsDoubleRange> fixedRangePerGroup() const;
%Docstring
Returns the fixed elevation range for each group.
.. note::
This is only considered when :py:func:`~QgsMeshLayerElevationProperties.mode` is :py:class:`Qgis`.MeshElevationMode.FixedRangePerGroup.
.. note::
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`setFixedRangePerGroup`
.. versionadded:: 3.38
%End
void setFixedRangePerGroup( const QMap<int, QgsDoubleRange> &ranges );
%Docstring
Sets the fixed elevation range for each group.
.. note::
This is only considered when :py:func:`~QgsMeshLayerElevationProperties.mode` is :py:class:`Qgis`.MeshElevationMode.FixedRangePerGroup.
.. note::
When a fixed range is set any :py:func:`~QgsMeshLayerElevationProperties.zOffset` and :py:func:`~QgsMeshLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`fixedRangePerGroup`
.. versionadded:: 3.38
%End
QgsLineSymbol *profileLineSymbol() const;
%Docstring
Returns the line symbol used to render the mesh profile in elevation
profile plots.
.. seealso:: :py:func:`setProfileLineSymbol`
%End
void setProfileLineSymbol( QgsLineSymbol *symbol /Transfer/ );
%Docstring
Sets the line ``symbol`` used to render the mesh profile in elevation
profile plots.
Ownership of ``symbol`` is transferred to the plot.
.. seealso:: :py:func:`profileLineSymbol`
%End
QgsFillSymbol *profileFillSymbol() const;
%Docstring
Returns the fill symbol used to render the mesh profile in elevation
profile plots.
.. seealso:: :py:func:`setProfileFillSymbol`
%End
void setProfileFillSymbol( QgsFillSymbol *symbol /Transfer/ );
%Docstring
Sets the fill ``symbol`` used to render the mesh profile in elevation
profile plots.
Ownership of ``symbol`` is transferred to the plot.
.. seealso:: :py:func:`profileFillSymbol`
%End
Qgis::ProfileSurfaceSymbology profileSymbology() const;
%Docstring
Returns the symbology option used to render the mesh profile in
elevation profile plots.
.. seealso:: :py:func:`setProfileSymbology`
%End
void setProfileSymbology( Qgis::ProfileSurfaceSymbology symbology );
%Docstring
Sets the ``symbology`` option used to render the mesh profile in
elevation profile plots.
.. seealso:: :py:func:`setProfileSymbology`
%End
double elevationLimit() const;
%Docstring
Returns the elevation limit, which is used when
:py:func:`~QgsMeshLayerElevationProperties.profileSymbology` is
:py:class:`Qgis`.ProfileSurfaceSymbology.FillBelow or
:py:class:`Qgis`.ProfileSurfaceSymbology.FillAbove to limit the fill to
a specific elevation range.
By default this is NaN, which indicates that there is no elevation
limit.
.. seealso:: :py:func:`setElevationLimit`
.. versionadded:: 3.32
%End
void setElevationLimit( double limit );
%Docstring
Sets the elevation ``limit``, which is used when
:py:func:`~QgsMeshLayerElevationProperties.profileSymbology` is
:py:class:`Qgis`.ProfileSurfaceSymbology.FillBelow or
:py:class:`Qgis`.ProfileSurfaceSymbology.FillAbove to limit the fill to
a specific elevation range.
Set to NaN to indicate that there is no elevation limit.
.. seealso:: :py:func:`elevationLimit`
.. versionadded:: 3.32
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshlayerelevationproperties.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
