Skip to content

Commit 3fc99c0

Browse files
PeterPetrikPeterPetrik
committedMay 16, 2018
code cleanup
·
ltr-3_40final-3_2_0
1 parent aea3dcc commit 3fc99c0

19 files changed

+401
-294
lines changed
 

‎python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in

Lines changed: 70 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,13 @@ typedef QgsPoint QgsMeshVertex;
1414

1515
typedef QVector<int> QgsMeshFace;
1616

17-
typedef QMap<QString, QString> QgsMeshDatasetMetadata;
18-
1917
class QgsMeshDatasetValue
2018
{
2119
%Docstring
2220

23-
QgsMeshDatasetValue is a vector or a scalar value on vertex or face of the mesh with
24-
support of nodata values
21+
QgsMeshDatasetValue represents single mesh dataset value
22+
23+
could be scalar or vector. Nodata values are represented by NaNs.
2524

2625
.. note::
2726

@@ -37,38 +36,21 @@ support of nodata values
3736
QgsMeshDatasetValue( double x,
3837
double y );
3938
%Docstring
40-
Ctor
39+
Constructor for vector value
4140
%End
4241

4342
QgsMeshDatasetValue( double scalar );
4443
%Docstring
45-
Ctor
44+
Constructor for scalar value
4645
%End
4746

48-
QgsMeshDatasetValue( );
47+
QgsMeshDatasetValue();
4948
%Docstring
50-
Ctor
49+
Default Ctor, initialize to NaN
5150
%End
5251

5352
~QgsMeshDatasetValue();
5453

55-
void setNodata( bool nodata = true );
56-
%Docstring
57-
Sets nodata value for this dataset value
58-
%End
59-
bool isNodata() const;
60-
%Docstring
61-
Returns whether it is nodata value
62-
%End
63-
bool isScalar() const;
64-
%Docstring
65-
Returns whether it is scalar value
66-
%End
67-
double scalar() const;
68-
%Docstring
69-
Returns scalar value. Length for vectors, value for scalars
70-
%End
71-
7254
void set( double scalar );
7355
%Docstring
7456
Sets scalar value
@@ -82,6 +64,11 @@ Sets X value
8264
void setY( double y );
8365
%Docstring
8466
Sets Y value
67+
%End
68+
69+
double scalar() const;
70+
%Docstring
71+
Returns magnitude of vector for vector data or scalar value for scalar data
8572
%End
8673

8774
double x() const;
@@ -98,6 +85,60 @@ Returns y value
9885

9986
};
10087

88+
89+
90+
class QgsMeshDatasetMetadata
91+
{
92+
%Docstring
93+
94+
QgsMeshDatasetMetadata is a collection of mesh dataset metadata such
95+
as if the data is vector or scalar, etc.
96+
97+
.. note::
98+
99+
The API is considered EXPERIMENTAL and can be changed without a notice
100+
101+
.. versionadded:: 3.2
102+
%End
103+
104+
%TypeHeaderCode
105+
#include "qgsmeshdataprovider.h"
106+
%End
107+
public:
108+
QgsMeshDatasetMetadata();
109+
QgsMeshDatasetMetadata( bool isScalar,
110+
bool isValid,
111+
bool isOnVertices,
112+
const QMap<QString, QString> &extraOptions );
113+
114+
QMap<QString, QString> extraOptions() const;
115+
%Docstring
116+
Returns extra metadata options
117+
Usually including name, description or time variable
118+
%End
119+
120+
bool isVector() const;
121+
%Docstring
122+
Returns whether dataset has vector data
123+
%End
124+
125+
bool isScalar() const;
126+
%Docstring
127+
Returns whether dataset has scalar data
128+
%End
129+
130+
bool isOnVertices() const;
131+
%Docstring
132+
Returns whether dataset data is defined on vertices
133+
%End
134+
135+
bool isValid() const;
136+
%Docstring
137+
Returns whether dataset is valid
138+
%End
139+
140+
};
141+
101142
class QgsMeshSource /Abstract/
102143
{
103144
%Docstring
@@ -155,7 +196,7 @@ class QgsMeshDatasetSource /Abstract/
155196
%Docstring
156197
Dataset is a collection of vector or scalar values on vertices or faces of the mesh
157198

158-
Base on the underlying data provider/format, whole dataset is either stored in memory or
199+
Based on the underlying data provider/format, whole dataset is either stored in memory or
159200
read on demand
160201

161202
.. note::
@@ -181,29 +222,16 @@ read on demand
181222
Returns number of datasets loaded
182223
%End
183224

184-
virtual bool datasetHasScalarData( int index ) const = 0;
185-
%Docstring
186-
Returns whether dataset has scalar data associated
187-
%End
188-
189-
virtual bool datasetIsOnVertices( int index ) const = 0;
190-
%Docstring
191-
Returns whether dataset is on vertices
192-
%End
193-
194-
virtual QgsMeshDatasetMetadata datasetMetadata( int index ) const = 0;
225+
virtual QgsMeshDatasetMetadata datasetMetadata( int datasetIndex ) const = 0;
195226
%Docstring
196227
Returns dataset metadata
197228
%End
198229

199230
virtual QgsMeshDatasetValue datasetValue( int datasetIndex, int valueIndex ) const = 0;
200231
%Docstring
201-
Returns value associated with the index from the dataset
202-
%End
232+
Returns vector/scalar value associated with the index from the dataset
203233

204-
virtual bool datasetIsValid( int index ) const = 0;
205-
%Docstring
206-
Returns whether dataset is valid
234+
See QgsMeshDatasetMetadata.isVector() to check if the returned value is vector or scalar
207235
%End
208236
};
209237

‎python/core/auto_generated/mesh/qgsmeshlayer.sip.in

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111

1212

13+
const int NO_ACTIVE_MESH_DATASET;
14+
1315

1416
class QgsMeshLayer : QgsMapLayer
1517
{
@@ -121,7 +123,7 @@ Returns the provider type for this layer
121123

122124

123125

124-
QgsMeshRendererMeshSettings rendererNativeMeshSettings() const /Factory/;
126+
QgsMeshRendererMeshSettings rendererNativeMeshSettings() const;
125127
%Docstring
126128
Returns rendrer settings
127129
%End
@@ -131,7 +133,7 @@ Returns rendrer settings
131133
Sets new rendering settings, triggers repaint
132134
%End
133135

134-
QgsMeshRendererMeshSettings rendererTriangularMeshSettings() const /Factory/;
136+
QgsMeshRendererMeshSettings rendererTriangularMeshSettings() const;
135137
%Docstring
136138
Returns rendrer settings
137139
%End
@@ -141,7 +143,7 @@ Returns rendrer settings
141143
Sets new rendering settings, triggers repaint
142144
%End
143145

144-
QgsMeshRendererScalarSettings rendererScalarSettings() const /Factory/;
146+
QgsMeshRendererScalarSettings rendererScalarSettings() const;
145147
%Docstring
146148
Returns rendrer settings
147149
%End
@@ -151,7 +153,7 @@ Returns rendrer settings
151153
Sets new rendering settings, triggers repaint
152154
%End
153155

154-
QgsMeshRendererVectorSettings rendererVectorSettings() const /Factory/;
156+
QgsMeshRendererVectorSettings rendererVectorSettings() const;
155157
%Docstring
156158
Returns rendrer settings
157159
%End
@@ -161,18 +163,22 @@ Returns rendrer settings
161163
Sets new rendering settings, triggers repaint
162164
%End
163165

164-
void setActiveScalarDataset( int index = -1 );
166+
void setActiveScalarDataset( int index = NO_ACTIVE_MESH_DATASET );
165167
%Docstring
166168
Sets active scalar dataset for rendering
169+
170+
Triggers repaint
167171
%End
168172
int activeScalarDataset() const;
169173
%Docstring
170174
Returns active scalar dataset
171175
%End
172176

173-
void setActiveVectorDataset( int index = -1 );
177+
void setActiveVectorDataset( int index = NO_ACTIVE_MESH_DATASET );
174178
%Docstring
175-
Sets active vector dataset for rendering. If dataset is not vector based, do nothing
179+
Sets active vector dataset for rendering.
180+
181+
If dataset is not vector based, do nothing. Triggers repaint
176182
%End
177183
int activeVectorDataset() const;
178184
%Docstring

‎python/core/auto_generated/mesh/qgsmeshrenderersettings.sip.in

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Represents a mesh renderer settings for vector datasets
140140
#include "qgsmeshrenderersettings.h"
141141
%End
142142
public:
143-
enum VectorRenderingType
143+
enum ArrowScalingMethod
144144
{
145145

146146
MinMax,
@@ -198,11 +198,11 @@ Sets filter value for vector magnitudes.
198198
.. seealso:: :py:func:`QgsMeshRendererVectorSettings.vectorFilterMax`
199199
%End
200200

201-
QgsMeshRendererVectorSettings::VectorRenderingType shaftLengthMethod() const;
201+
QgsMeshRendererVectorSettings::ArrowScalingMethod shaftLengthMethod() const;
202202
%Docstring
203203
Returns method used for drawing arrows
204204
%End
205-
void setShaftLengthMethod( const QgsMeshRendererVectorSettings::VectorRenderingType &shaftLengthMethod );
205+
void setShaftLengthMethod( const QgsMeshRendererVectorSettings::ArrowScalingMethod &shaftLengthMethod );
206206
%Docstring
207207
Sets method used for drawing arrows
208208
%End
@@ -211,46 +211,56 @@ Sets method used for drawing arrows
211211
%Docstring
212212
Returns mininimum shaft length (in millimeters)
213213

214-
Only for QgsMeshRendererVectorSettings.ArrowType.MinMax
214+
Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.MinMax
215215
%End
216216

217217
void setMinShaftLength( double minShaftLength );
218218
%Docstring
219219
Sets mininimum shaft length (in millimeters)
220220

221-
Only for QgsMeshRendererVectorSettings.ArrowType.MinMax
221+
Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.MinMax
222222
%End
223223

224224
double maxShaftLength() const;
225225
%Docstring
226226
Returns maximum shaft length (in millimeters)
227227

228-
Only for QgsMeshRendererVectorSettings.ArrowType.MinMax
228+
Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.MinMax
229229
%End
230230

231231
void setMaxShaftLength( double maxShaftLength );
232232
%Docstring
233233
Sets maximum shaft length (in millimeters)
234234

235-
Only for QgsMeshRendererVectorSettings.ArrowType.MinMax
235+
Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.MinMax
236236
%End
237237

238238
double scaleFactor() const;
239239
%Docstring
240-
Returns scale factor. Only for QgsMeshRendererVectorSettings.ArrowType.Scaled
240+
Returns scale factor
241+
242+
Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.Scaled
241243
%End
244+
242245
void setScaleFactor( double scaleFactor );
243246
%Docstring
244-
Sets scale factor. Only for QgsMeshRendererVectorSettings.ArrowType.Scaled
247+
Sets scale factor
248+
249+
Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.Scaled
245250
%End
246251

247252
double fixedShaftLength() const;
248253
%Docstring
249-
Returns fixed arrow length (in millimeters). Only for QgsMeshRendererVectorSettings.ArrowType.Fixed
254+
Returns fixed arrow length (in millimeters)
255+
256+
Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.Fixed
250257
%End
258+
251259
void setFixedShaftLength( double fixedShaftLength );
252260
%Docstring
253-
Sets fixed length (in millimeters). Only for QgsMeshRendererVectorSettings.ArrowType.Fixed
261+
Sets fixed length (in millimeters)
262+
263+
Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.Fixed
254264
%End
255265

256266
double arrowHeadWidthRatio() const;

‎python/core/core_auto.sip

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Include auto-generated SIP files
12
%Include auto_generated/expression/qgsexpression.sip
23
%Include auto_generated/expression/qgsexpressionnode.sip
34
%Include auto_generated/expression/qgsexpressionnodeimpl.sip

0 commit comments

Comments
 (0)
Please sign in to comment.