QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
qgsmaplayerelevationproperties.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsmaplayerelevationproperties.h
3 ---------------
4 begin : November 2020
5 copyright : (C) 2020 by Nyall Dawson
6 email : nyall dot dawson dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18
19#ifndef QGSMAPLAYERELEVATIONPROPERTIES_H
20#define QGSMAPLAYERELEVATIONPROPERTIES_H
21
22#include "qgis_core.h"
23#include "qgis_sip.h"
24#include "qgsreadwritecontext.h"
25#include "qgsrange.h"
27
28#include <QObject>
29#include <QDomElement>
30
31class QgsMapLayer;
32
33
44class CORE_EXPORT QgsMapLayerElevationProperties : public QObject
45{
46#ifdef SIP_RUN
52#endif
53
54 Q_OBJECT
55
56#ifdef SIP_RUN
58 if ( qobject_cast<QgsPointCloudLayerElevationProperties *>( sipCpp ) )
59 {
60 sipType = sipType_QgsPointCloudLayerElevationProperties;
61 }
62 else if ( qobject_cast<QgsVectorLayerElevationProperties *>( sipCpp ) )
63 {
64 sipType = sipType_QgsVectorLayerElevationProperties;
65 }
66 else if ( qobject_cast<QgsRasterLayerElevationProperties *>( sipCpp ) )
67 {
68 sipType = sipType_QgsRasterLayerElevationProperties;
69 }
70 else if ( qobject_cast<QgsMeshLayerElevationProperties *>( sipCpp ) )
71 {
72 sipType = sipType_QgsMeshLayerElevationProperties;
73 }
74 else if ( qobject_cast<QgsTiledSceneLayerElevationProperties *>( sipCpp ) )
75 {
76 sipType = sipType_QgsTiledSceneLayerElevationProperties;
77 }
78 else
79 {
80 sipType = 0;
81 }
83#endif
84
85 public:
86
87 // *INDENT-OFF*
88
94 {
95 ZOffset,
96 ExtrusionHeight,
97 RasterPerBandLowerElevation,
98 RasterPerBandUpperElevation,
99 };
100 // *INDENT-ON*
101
105 enum Flag SIP_ENUM_BASETYPE( IntFlag )
106 {
107 FlagDontInvalidateCachedRendersWhenRangeChanges = 1
108 };
109 Q_DECLARE_FLAGS( Flags, Flag )
110
111
115
119 virtual bool hasElevation() const;
120
126 virtual QDomElement writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context ) = 0;
127
133 virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) = 0;
134
140 virtual void setDefaultsFromLayer( QgsMapLayer *layer );
141
147 virtual QString htmlSummary() const;
148
155
161 virtual bool isVisibleInZRange( const QgsDoubleRange &range, QgsMapLayer *layer = nullptr ) const;
162
167
174 virtual QgsDoubleRange calculateZRange( QgsMapLayer *layer ) const;
175
184 virtual QList< double > significantZValues( QgsMapLayer *layer ) const;
185
195 virtual bool showByDefaultInElevationProfilePlots() const;
196
205 double zOffset() const { return mZOffset; }
206
215 void setZOffset( double offset );
216
228 double zScale() const { return mZScale; }
229
241 void setZScale( double scale );
242
248 QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
249
257 const QgsPropertyCollection &dataDefinedProperties() const SIP_SKIP { return mDataDefinedProperties; }
258
268 void setDataDefinedProperties( const QgsPropertyCollection &collection );
269
275 static QgsPropertiesDefinition propertyDefinitions();
276
277 signals:
278
284 void changed();
285
292
299
309
319
320 protected:
322 double mZScale = 1.0;
324 double mZOffset = 0.0;
325
328
331
338 void writeCommonProperties( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context );
339
346 void readCommonProperties( const QDomElement &element, const QgsReadWriteContext &context );
347
353 void copyCommonProperties( const QgsMapLayerElevationProperties *other );
354
355 private:
356
360 static void initPropertyDefinitions();
361
362};
363
364#endif // QGSMAPLAYERELEVATIONPROPERTIES_H
QgsRange which stores a range of double values.
Definition qgsrange.h:231
Base class for storage of map layer elevation properties.
void zScaleChanged()
Emitted when the z scale changes.
QgsPropertyCollection mDataDefinedProperties
Property collection for data defined elevation settings.
void profileGenerationPropertyChanged()
Emitted when any of the elevation properties which relate solely to generation of elevation profiles ...
virtual QgsMapLayerElevationProperties::Flags flags() const
Returns flags associated to the elevation properties.
virtual QgsMapLayerElevationProperties * clone() const =0
Creates a clone of the properties.
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the object's property collection, used for data defined overrides.
void changed()
Emitted when any of the elevation properties have changed.
void profileRenderingPropertyChanged()
Emitted when any of the elevation properties which relate solely to presentation of elevation results...
const QgsPropertyCollection & dataDefinedProperties() const
Returns a reference to the object's property collection, used for data defined overrides.
void zOffsetChanged()
Emitted when the z offset changes.
double zScale() const
Returns the z scale, which is a scaling factor which should be applied to z values from the layer.
virtual QDomElement writeXml(QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context)=0
Writes the properties to a DOM element, to be used later with readXml().
static QgsPropertiesDefinition sPropertyDefinitions
Property definitions.
virtual bool readXml(const QDomElement &element, const QgsReadWriteContext &context)=0
Reads the elevation properties from a DOM element previously written by writeXml().
Flag
Flags attached to the elevation property.
double zOffset() const
Returns the z offset, which is a fixed offset amount which should be added to z values from the layer...
Base class for all map layer types.
Definition qgsmaplayer.h:76
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
The class is used as a container of context for various read/write operations on other objects.
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition qgis_sip.h:191
#define SIP_TRANSFERTHIS
Definition qgis_sip.h:53
#define SIP_ENUM_BASETYPE(type)
Definition qgis_sip.h:278
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_MONKEYPATCH_SCOPEENUM_UNNEST(OUTSIDE_CLASS, FORMERNAME)
Definition qgis_sip.h:271
#define SIP_FACTORY
Definition qgis_sip.h:76
#define SIP_END
Definition qgis_sip.h:208
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.