QGIS API Documentation 3.41.0-Master (fda2aa46e9a)
Loading...
Searching...
No Matches
qgspointcloudlayerelevationproperties.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgspointcloudlayerelevationproperties.cpp
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
19#include "moc_qgspointcloudlayerelevationproperties.cpp"
20#include "qgspointcloudlayer.h"
21#include "qgsapplication.h"
23#include "qgscolorutils.h"
24
27{
29
30 if ( QgsPointCloudLayer *pcLayer = qobject_cast< QgsPointCloudLayer * >( parent ) )
31 {
32 connect( pcLayer, &QgsPointCloudLayer::rendererChanged, this, [this]
33 {
34 if ( mRespectLayerColors )
36 } );
37 }
38}
39
41{
42 return true;
43}
44
45QDomElement QgsPointCloudLayerElevationProperties::writeXml( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context )
46{
47 QDomElement element = document.createElement( QStringLiteral( "elevation" ) );
48 writeCommonProperties( element, document, context );
49
50 element.setAttribute( QStringLiteral( "max_screen_error" ), qgsDoubleToString( mMaximumScreenError ) );
51 element.setAttribute( QStringLiteral( "max_screen_error_unit" ), QgsUnitTypes::encodeUnit( mMaximumScreenErrorUnit ) );
52 element.setAttribute( QStringLiteral( "point_size" ), qgsDoubleToString( mPointSize ) );
53 element.setAttribute( QStringLiteral( "point_size_unit" ), QgsUnitTypes::encodeUnit( mPointSizeUnit ) );
54 element.setAttribute( QStringLiteral( "point_symbol" ), qgsEnumValueToKey( mPointSymbol ) );
55 element.setAttribute( QStringLiteral( "point_color" ), QgsColorUtils::colorToString( mPointColor ) );
56 element.setAttribute( QStringLiteral( "respect_layer_colors" ), mRespectLayerColors ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
57 element.setAttribute( QStringLiteral( "opacity_by_distance" ), mApplyOpacityByDistanceEffect ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
58
59 parentElement.appendChild( element );
60 return element;
61}
62
63bool QgsPointCloudLayerElevationProperties::readXml( const QDomElement &element, const QgsReadWriteContext &context )
64{
65 const QDomElement elevationElement = element.firstChildElement( QStringLiteral( "elevation" ) ).toElement();
66 readCommonProperties( elevationElement, context );
67
68 mMaximumScreenError = elevationElement.attribute( QStringLiteral( "max_screen_error" ), QStringLiteral( "0.3" ) ).toDouble();
69 bool ok = false;
70 mMaximumScreenErrorUnit = QgsUnitTypes::decodeRenderUnit( elevationElement.attribute( QStringLiteral( "max_screen_error_unit" ) ), &ok );
71 if ( !ok )
72 mMaximumScreenErrorUnit = Qgis::RenderUnit::Millimeters;
73 mPointSize = elevationElement.attribute( QStringLiteral( "point_size" ), QStringLiteral( "0.6" ) ).toDouble();
74 mPointSizeUnit = QgsUnitTypes::decodeRenderUnit( elevationElement.attribute( QStringLiteral( "point_size_unit" ) ), &ok );
75 if ( !ok )
76 mPointSizeUnit = Qgis::RenderUnit::Millimeters;
77 mPointSymbol = qgsEnumKeyToValue( elevationElement.attribute( QStringLiteral( "point_symbol" ) ), Qgis::PointCloudSymbol::Square );
78 const QString colorString = elevationElement.attribute( QStringLiteral( "point_color" ) );
79 if ( !colorString.isEmpty() )
80 {
81 mPointColor = QgsColorUtils::colorFromString( elevationElement.attribute( QStringLiteral( "point_color" ) ) );
82 }
83 else
84 {
86 }
87 mRespectLayerColors = elevationElement.attribute( QStringLiteral( "respect_layer_colors" ), QStringLiteral( "1" ) ).toInt();
88 mApplyOpacityByDistanceEffect = elevationElement.attribute( QStringLiteral( "opacity_by_distance" ) ).toInt();
89
90 return true;
91}
92
94{
95 std::unique_ptr< QgsPointCloudLayerElevationProperties > res = std::make_unique< QgsPointCloudLayerElevationProperties >( nullptr );
96 res->copyCommonProperties( this );
97
98 res->mMaximumScreenError = mMaximumScreenError;
99 res->mMaximumScreenErrorUnit = mMaximumScreenErrorUnit;
100 res->mPointSize = mPointSize;
101 res->mPointSizeUnit = mPointSizeUnit;
102 res->mPointSymbol = mPointSymbol;
103 res->mPointColor = mPointColor;
104 res->mRespectLayerColors = mRespectLayerColors;
105 res->mApplyOpacityByDistanceEffect = mApplyOpacityByDistanceEffect;
106
107 return res.release();
108}
109
111{
112 QStringList properties;
113 properties << tr( "Scale: %1" ).arg( mZScale );
114 properties << tr( "Offset: %1" ).arg( mZOffset );
115 return QStringLiteral( "<ul><li>%1</li></ul>" ).arg( properties.join( QLatin1String( "</li><li>" ) ) );
116}
117
119{
120 // TODO -- test actual point cloud z range
121 return true;
122}
123
125{
126 if ( QgsPointCloudLayer *pcLayer = qobject_cast< QgsPointCloudLayer * >( layer ) )
127 {
128 if ( pcLayer->dataProvider() )
129 {
130 const QgsPointCloudStatistics stats = pcLayer->statistics();
131
132 // try to fetch z range from provider metadata
133 const double zMin = stats.minimum( QStringLiteral( "Z" ) );
134 const double zMax = stats.maximum( QStringLiteral( "Z" ) );
135 if ( !std::isnan( zMin ) && !std::isnan( zMax ) )
136 {
137 return QgsDoubleRange( zMin * mZScale + mZOffset, zMax * mZScale + mZOffset );
138 }
139 }
140 }
141
142 return QgsDoubleRange();
143}
144
146{
147 const QgsDoubleRange range = calculateZRange( layer );
148 if ( !range.isInfinite() && range.lower() != range.upper() )
149 return {range.lower(), range.upper() };
150 else if ( !range.isInfinite() )
151 return {range.lower() };
152 else
153 return {};
154}
155
160
162{
163 if ( qgsDoubleNear( error, mMaximumScreenError ) )
164 return;
165
166 mMaximumScreenError = error;
167 emit changed();
169}
170
172{
173 if ( unit == mMaximumScreenErrorUnit )
174 return;
175
176 mMaximumScreenErrorUnit = unit;
177 emit changed();
179}
180
185
187{
188 if ( mPointSymbol == symbol )
189 return;
190
191 mPointSymbol = symbol;
192 emit changed();
194}
195
197{
198 if ( color == mPointColor )
199 return;
200
201 mPointColor = color;
202 emit changed();
204}
205
207{
208 if ( apply == mApplyOpacityByDistanceEffect )
209 return;
210
211 mApplyOpacityByDistanceEffect = apply;
212 emit changed();
213
214 // turning ON opacity by distance requires a profile regeneration, turning it off does not.
215 if ( mApplyOpacityByDistanceEffect )
217 else
219}
220
222{
223 if ( qgsDoubleNear( size, mPointSize ) )
224 return;
225
226 mPointSize = size;
227 emit changed();
229}
230
232{
233 if ( mPointSizeUnit == units )
234 return;
235
236 mPointSizeUnit = units;
237 emit changed();
239}
240
242{
243 if ( mRespectLayerColors == enabled )
244 return;
245
246 mRespectLayerColors = enabled;
247 emit changed();
248
249 // turning ON respect layer colors requires a profile regeneration, turning it off does not.
250 if ( mRespectLayerColors )
252 else
254}
PointCloudSymbol
Rendering symbols for point cloud points.
Definition qgis.h:3942
@ Square
Renders points as squares.
RenderUnit
Rendering size units.
Definition qgis.h:4839
@ Millimeters
Millimeters.
static QgsColorSchemeRegistry * colorSchemeRegistry()
Returns the application's color scheme registry, used for managing color schemes.
QColor fetchRandomStyleColor() const
Returns a random color for use with a new symbol style (e.g.
static QColor colorFromString(const QString &string)
Decodes a string into a color value.
static QString colorToString(const QColor &color)
Encodes a color into a string value.
QgsRange which stores a range of double values.
Definition qgsrange.h:231
bool isInfinite() const
Returns true if the range consists of all possible values.
Definition qgsrange.h:285
Base class for storage of map layer elevation properties.
void writeCommonProperties(QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context)
Writes common class properties to a DOM element, to be used later with readXml().
void profileGenerationPropertyChanged()
Emitted when any of the elevation properties which relate solely to generation of elevation profiles ...
void readCommonProperties(const QDomElement &element, const QgsReadWriteContext &context)
Reads common class properties from a DOM element previously written by writeXml().
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...
Base class for all map layer types.
Definition qgsmaplayer.h:76
void rendererChanged()
Signal emitted when renderer is changed.
Point cloud layer specific subclass of QgsMapLayerElevationProperties.
void setRespectLayerColors(bool enabled)
Sets whether layer coloring should be respected when rendering elevation profile plots.
QString htmlSummary() const override
Returns a HTML formatted summary of the properties.
void setPointColor(const QColor &color)
Sets the color used drawing points in elevation profile charts.
bool showByDefaultInElevationProfilePlots() const override
Returns true if the layer should be visible by default in newly created elevation profile plots.
bool hasElevation() const override
Returns true if the layer has an elevation or z component.
void setApplyOpacityByDistanceEffect(bool apply)
Sets whether a reduced opacity by distance from profile curve effect should be applied when drawing p...
QDomElement writeXml(QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override
Writes the properties to a DOM element, to be used later with readXml().
void setPointSize(double size)
Sets the point size used for drawing points in elevation profile charts.
bool readXml(const QDomElement &element, const QgsReadWriteContext &context) override
Reads the elevation properties from a DOM element previously written by writeXml().
void setPointSymbol(Qgis::PointCloudSymbol symbol)
Sets the symbol used drawing points in elevation profile charts.
QgsDoubleRange calculateZRange(QgsMapLayer *layer) const override
Attempts to calculate the overall elevation or z range for the specified layer, using the settings de...
void setMaximumScreenError(double error)
Sets the maximum screen error allowed when generating elevation profiles for the point cloud.
bool isVisibleInZRange(const QgsDoubleRange &range, QgsMapLayer *layer=nullptr) const override
Returns true if the layer should be visible and rendered for the specified z range.
void setPointSizeUnit(const Qgis::RenderUnit units)
Sets the units used for the point size used for drawing points in elevation profile charts.
QgsPointCloudLayerElevationProperties * clone() const override
Creates a clone of the properties.
void setMaximumScreenErrorUnit(Qgis::RenderUnit unit)
Sets the unit for the maximum screen error allowed when generating elevation profiles for the point c...
QList< double > significantZValues(QgsMapLayer *layer) const override
Returns a list of significant elevation/z-values for the specified layer, using the settings defined ...
Qgis::PointCloudSymbol pointSymbol() const
Returns the symbol used drawing points in elevation profile charts.
QgsPointCloudLayerElevationProperties(QObject *parent)
Constructor for QgsPointCloudLayerElevationProperties, with the specified parent object.
Represents a map layer supporting display of point clouds.
Class used to store statistics of a point cloud dataset.
double maximum(const QString &attribute) const
Returns the maximum value for the attribute attribute If no matching statistic is available then NaN ...
double minimum(const QString &attribute) const
Returns the minimum value for the attribute attribute If no matching statistic is available then NaN ...
T lower() const
Returns the lower bound of the range.
Definition qgsrange.h:78
T upper() const
Returns the upper bound of the range.
Definition qgsrange.h:85
The class is used as a container of context for various read/write operations on other objects.
static Q_INVOKABLE Qgis::RenderUnit decodeRenderUnit(const QString &string, bool *ok=nullptr)
Decodes a render unit from a string.
static Q_INVOKABLE QString encodeUnit(Qgis::DistanceUnit unit)
Encodes a distance unit to a string.
T qgsEnumKeyToValue(const QString &key, const T &defaultValue, bool tryValueAsKey=true, bool *returnOk=nullptr)
Returns the value corresponding to the given key of an enum.
Definition qgis.h:6127
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
Definition qgis.h:5834
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition qgis.h:6108
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition qgis.h:5917