QGIS API Documentation 3.37.0-Master (4ace69f83af)
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 };
98 // *INDENT-ON*
99
103 enum Flag SIP_ENUM_BASETYPE( IntFlag )
104 {
105 FlagDontInvalidateCachedRendersWhenRangeChanges = 1
106 };
107 Q_DECLARE_FLAGS( Flags, Flag )
108
109
113
117 virtual bool hasElevation() const;
118
124 virtual QDomElement writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context ) = 0;
125
131 virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) = 0;
132
138 virtual void setDefaultsFromLayer( QgsMapLayer *layer );
139
145 virtual QString htmlSummary() const;
146
153
157 virtual bool isVisibleInZRange( const QgsDoubleRange &range ) const;
158
162 virtual QgsMapLayerElevationProperties::Flags flags() const { return QgsMapLayerElevationProperties::Flags(); }
163
170 virtual QgsDoubleRange calculateZRange( QgsMapLayer *layer ) const;
171
181 virtual bool showByDefaultInElevationProfilePlots() const;
182
191 double zOffset() const { return mZOffset; }
192
201 void setZOffset( double offset );
202
214 double zScale() const { return mZScale; }
215
227 void setZScale( double scale );
228
234 QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
235
243 const QgsPropertyCollection &dataDefinedProperties() const SIP_SKIP { return mDataDefinedProperties; }
244
254 void setDataDefinedProperties( const QgsPropertyCollection &collection );
255
261 static QgsPropertiesDefinition propertyDefinitions();
262
263 signals:
264
270 void changed();
271
278
285
295
305
306 protected:
308 double mZScale = 1.0;
310 double mZOffset = 0.0;
311
314
317
324 void writeCommonProperties( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context );
325
332 void readCommonProperties( const QDomElement &element, const QgsReadWriteContext &context );
333
339 void copyCommonProperties( const QgsMapLayerElevationProperties *other );
340
341 private:
342
346 static void initPropertyDefinitions();
347
348};
349
350#endif // QGSMAPLAYERELEVATIONPROPERTIES_H
QgsRange which stores a range of double values.
Definition qgsrange.h:201
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:75
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.