QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
qgspointcloudlayer3drenderer.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgspointcloudlayer3drenderer.cpp
3 --------------------------------------
4 Date : October 2020
5 Copyright : (C) 2020 by Peter Petrik
6 Email : zilolv dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
17
18#include <memory>
19
20#include "qgs3dsymbolregistry.h"
21#include "qgs3dutils.h"
23#include "qgspointcloudindex.h"
24#include "qgspointcloudlayer.h"
28#include "qgsxmlutils.h"
29
31 : Qgs3DRenderContext( context )
32 , mSymbol( std::move( symbol ) )
33 , mZValueScale( zValueScale )
34 , mZValueFixedOffset( zValueFixedOffset )
35 , mCoordinateTransform( coordinateTransform )
36 , mFeedback( new QgsFeedback )
37{
38 updateExtent();
39}
40
45
50
52{
53 mFilteredOutCategories = categories;
54}
55
57{
58 QSet<int> filteredOut;
59 for ( const QgsPointCloudCategory &category : mFilteredOutCategories )
60 filteredOut.insert( category.value() );
61 return filteredOut;
62}
63
69
71{
72 return mFeedback->isCanceled();
73}
74
76{
77 mFeedback->cancel();
78}
79
80void QgsPointCloud3DRenderContext::updateExtent()
81{
82 if ( extent().isEmpty() )
83 {
84 // an empty extent means no filter, so let's pass it without transformation
85 mLayerExtent = QgsRectangle();
86 }
87 else
88 {
89 try
90 {
91 mLayerExtent = mCoordinateTransform.transformBoundingBox( extent(), Qgis::TransformDirection::Reverse );
92 }
93 catch ( const QgsCsException & )
94 {
95 // bad luck, can't reproject for some reason. Let's use an empty extent to skip filtering.
96 QgsDebugError( QStringLiteral( "Transformation of extent failed!" ) );
97 mLayerExtent = QgsRectangle();
98 }
99 }
100}
101// ---------
102
103
108
110{
112 r->readXml( elem, context );
113 return r;
114}
115
116
117// ---------
118
119
123
128
130{
131 return qobject_cast<QgsPointCloudLayer *>( mLayerRef.layer );
132}
133
135{
136 return QStringLiteral( "pointcloud" );
137}
138
140{
142 if ( mSymbol )
143 {
144 QgsAbstract3DSymbol *symbolClone = mSymbol->clone();
145 r->setSymbol( dynamic_cast<QgsPointCloud3DSymbol *>( symbolClone ) );
146 }
147 r->setMaximumScreenError( mMaximumScreenError );
148 r->setShowBoundingBoxes( mShowBoundingBoxes );
149 r->setZoomOutBehavior( mZoomOutBehavior );
150 return r;
151}
152
154{
155 QgsPointCloudLayer *pcl = layer();
156 if ( !pcl || !pcl->dataProvider() )
157 return nullptr;
158 if ( !mSymbol )
159 return nullptr;
160
161 const QgsCoordinateTransform coordinateTransform( pcl->crs3D(), map->crs(), map->transformContext() );
162
163 Qt3DCore::QEntity *entity = nullptr;
164 if ( pcl->index() )
165 {
166 entity = new QgsPointCloudLayerChunkedEntity( map, pcl, pcl->index(), coordinateTransform, mSymbol->clone(), static_cast<float>( maximumScreenError() ), showBoundingBoxes(), static_cast<const QgsPointCloudLayerElevationProperties *>( pcl->elevationProperties() )->zScale(), static_cast<const QgsPointCloudLayerElevationProperties *>( pcl->elevationProperties() )->zOffset(), mPointBudget );
167 }
168 else if ( !pcl->dataProvider()->subIndexes().isEmpty() )
169 {
170 entity = new QgsVirtualPointCloudEntity( map, pcl, coordinateTransform, mSymbol->clone(), static_cast<float>( maximumScreenError() ), showBoundingBoxes(), static_cast<const QgsPointCloudLayerElevationProperties *>( pcl->elevationProperties() )->zScale(), static_cast<const QgsPointCloudLayerElevationProperties *>( pcl->elevationProperties() )->zOffset(), mPointBudget );
171 }
172 return entity;
173}
174
179
180void QgsPointCloudLayer3DRenderer::writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const
181{
182 Q_UNUSED( context )
183
184 QDomDocument doc = elem.ownerDocument();
185
186 elem.setAttribute( QStringLiteral( "layer" ), mLayerRef.layerId );
187 elem.setAttribute( QStringLiteral( "max-screen-error" ), maximumScreenError() );
188 elem.setAttribute( QStringLiteral( "show-bounding-boxes" ), showBoundingBoxes() ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
189 elem.setAttribute( QStringLiteral( "point-budget" ), mPointBudget );
190 elem.setAttribute( QStringLiteral( "zoom-out-behavior" ), qgsEnumValueToKey( mZoomOutBehavior ) );
191
192 QDomElement elemSymbol = doc.createElement( QStringLiteral( "symbol" ) );
193 if ( mSymbol )
194 {
195 elemSymbol.setAttribute( QStringLiteral( "type" ), mSymbol->symbolType() );
196 mSymbol->writeXml( elemSymbol, context );
197 }
198 elem.appendChild( elemSymbol );
199}
200
201void QgsPointCloudLayer3DRenderer::readXml( const QDomElement &elem, const QgsReadWriteContext &context )
202{
203 mLayerRef = QgsMapLayerRef( elem.attribute( QStringLiteral( "layer" ) ) );
204
205 const QDomElement elemSymbol = elem.firstChildElement( QStringLiteral( "symbol" ) );
206
207 const QString symbolType = elemSymbol.attribute( QStringLiteral( "type" ) );
208 mShowBoundingBoxes = elem.attribute( QStringLiteral( "show-bounding-boxes" ), QStringLiteral( "0" ) ).toInt();
209 mMaximumScreenError = elem.attribute( QStringLiteral( "max-screen-error" ), QStringLiteral( "3.0" ) ).toDouble();
210 mPointBudget = elem.attribute( QStringLiteral( "point-budget" ), QStringLiteral( "5000000" ) ).toInt();
211 mZoomOutBehavior = qgsEnumKeyToValue( elem.attribute( QStringLiteral( "zoom-out-behavior" ) ), Qgis::PointCloudZoomOutRenderBehavior::RenderExtents );
212
213 if ( symbolType == QLatin1String( "single-color" ) )
214 mSymbol = std::make_unique<QgsSingleColorPointCloud3DSymbol>();
215 else if ( symbolType == QLatin1String( "color-ramp" ) )
216 mSymbol = std::make_unique<QgsColorRampPointCloud3DSymbol>();
217 else if ( symbolType == QLatin1String( "rgb" ) )
218 mSymbol = std::make_unique<QgsRgbPointCloud3DSymbol>();
219 else if ( symbolType == QLatin1String( "classification" ) )
220 mSymbol = std::make_unique<QgsClassificationPointCloud3DSymbol>();
221 else
222 mSymbol.reset();
223
224 if ( mSymbol )
225 mSymbol->readXml( elemSymbol, context );
226}
227
229{
230 mLayerRef.setLayer( project.mapLayer( mLayerRef.layerId ) );
231}
232
234{
235 return mMaximumScreenError;
236}
237
239{
240 mMaximumScreenError = error;
241}
242
244{
245 return mShowBoundingBoxes;
246}
247
252
254{
255 mPointBudget = budget;
256}
257
259{
260 std::unique_ptr<QgsPointCloudLayer3DRenderer> renderer3D = Qgs3DUtils::convert2DPointCloudRendererTo3D( renderer );
261 if ( !renderer3D )
262 {
263 setSymbol( nullptr );
264 return false;
265 }
266
267 QgsPointCloud3DSymbol *newSymbol = const_cast<QgsPointCloud3DSymbol *>(
268 static_cast<QgsPointCloud3DSymbol *>( renderer3D->symbol()->clone() )
269 );
270 // we need to retain some settings from the previous symbol, like point size
271 const QgsPointCloud3DSymbol *oldSymbol = symbol();
272 if ( oldSymbol )
273 oldSymbol->copyBaseSettings( newSymbol );
274 setSymbol( newSymbol );
275 return true;
276}
@ RenderExtents
Render only point cloud extents when zoomed out.
Definition qgis.h:6086
@ Reverse
Reverse/inverse transform (from destination to source).
Definition qgis.h:2673
Definition of the world.
QgsCoordinateReferenceSystem crs() const
Returns coordinate reference system used in the 3D scene.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context, which stores various information regarding which datum tran...
Qgs3DRenderContext()=default
QgsRectangle extent() const
Returns the 3D scene's 2D extent in the 3D scene's CRS.
Qgs3DRendererAbstractMetadata(const QString &type)
Constructor of the base class.
static std::unique_ptr< QgsPointCloudLayer3DRenderer > convert2DPointCloudRendererTo3D(QgsPointCloudRenderer *renderer)
Creates a QgsPointCloudLayer3DRenderer matching the symbol settings of a given QgsPointCloudRenderer.
Base class for all renderers that participate in 3D views.
Abstract base class for 3D symbols that are used by VectorLayer3DRenderer objects.
virtual QgsAbstract3DSymbol * clone() const =0
Returns a new instance of the symbol with the same settings.
Handles coordinate transforms between two coordinate systems.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
double zScale() const
Returns the z scale, which is a scaling factor which should be applied to z values from the layer.
double zOffset() const
Returns the z offset, which is a fixed offset amount which should be added to z values from the layer...
QgsCoordinateReferenceSystem crs3D
Definition qgsmaplayer.h:89
QSet< int > getFilteredOutValues() const
Returns a set containing the filtered out values.
QgsPointCloud3DSymbol * symbol() const
Returns the symbol used for rendering the point cloud.
double zValueScale() const
Returns any constant scaling factor which must be applied to z values taken from the point cloud inde...
void setFilteredOutCategories(const QgsPointCloudCategoryList &categories)
Sets the list of categories of the classification that won't be rendered.
QgsPointCloudAttributeCollection attributes() const
Returns the attributes associated with the rendered block.
void setSymbol(QgsPointCloud3DSymbol *symbol)
Sets the symbol used for rendering the point cloud Takes ownership over the passed symbol.
bool isCanceled() const
Returns true if the rendering is canceled.
void setCoordinateTransform(const QgsCoordinateTransform &coordinateTransform)
Sets the coordinate transform used to transform points from layer CRS to the map CRS.
QgsCoordinateTransform coordinateTransform() const
Returns the coordinate transform used to transform points from layer CRS to the map CRS.
void cancelRendering() const
Cancels rendering.
double zValueFixedOffset() const
Returns any constant offset which must be applied to z values taken from the point cloud index.
QgsPointCloud3DRenderContext(const Qgs3DRenderContext &context, const QgsCoordinateTransform &coordinateTransform, std::unique_ptr< QgsPointCloud3DSymbol > symbol, double zValueScale, double zValueFixedOffset)
Constructor for QgsPointCloud3DRenderContext.
void setAttributes(const QgsPointCloudAttributeCollection &attributes)
Sets the attributes associated with the rendered block.
3D symbol that draws point cloud geometries as 3D objects.
void copyBaseSettings(QgsAbstract3DSymbol *destination) const override
A collection of point cloud attributes.
Represents an individual category (class) from a QgsPointCloudClassifiedRenderer.
virtual QVector< QgsPointCloudSubIndex > subIndexes()
Returns a list of sub indexes available if the provider supports multiple indexes,...
QgsAbstract3DRenderer * createRenderer(QDomElement &elem, const QgsReadWriteContext &context) override
Creates an instance of a 3D renderer based on a DOM element with renderer configuration.
3D renderer that renders all points from a point cloud layer.
void resolveReferences(const QgsProject &project) override
Resolves references to other objects - second phase of loading - after readXml().
void setLayer(QgsPointCloudLayer *layer)
Sets point cloud layer associated with the renderer.
double maximumScreenError() const
Returns the maximum screen error allowed when rendering the point cloud.
void setPointRenderingBudget(int budget)
Sets the maximum number of points to be rendered in the scene.
void writeXml(QDomElement &elem, const QgsReadWriteContext &context) const override
Writes renderer's properties to given XML element.
const QgsPointCloud3DSymbol * symbol() const
Returns 3D symbol associated with the renderer.
QString type() const override
Returns unique identifier of the renderer class (used to identify subclass).
bool showBoundingBoxes() const
Returns whether bounding boxes will be visible when rendering the point cloud.
QgsPointCloudLayer3DRenderer()
Takes ownership of the symbol object.
QgsPointCloudLayer3DRenderer * clone() const override
Returns a cloned instance.
QgsPointCloudLayer * layer() const
Returns point cloud layer associated with the renderer.
void setSymbol(QgsPointCloud3DSymbol *symbol)
Sets the 3D symbol associated with the renderer.
void setMaximumScreenError(double error)
Sets the maximum screen error allowed when rendering the point cloud.
void readXml(const QDomElement &elem, const QgsReadWriteContext &context) override
Reads renderer's properties from given XML element.
bool convertFrom2DRenderer(QgsPointCloudRenderer *renderer) override
Updates the 3D renderer's symbol to match that of a given QgsPointCloudRenderer.
void setShowBoundingBoxes(bool showBoundingBoxes)
Sets whether bounding boxes will be visible when rendering the point cloud.
Qt3DCore::QEntity * createEntity(Qgs3DMapSettings *map) const override
Returns a 3D entity that will be used to show renderer's data in 3D scene.
void setZoomOutBehavior(const Qgis::PointCloudZoomOutRenderBehavior behavior)
Sets the renderer behavior when zoomed out.
Point cloud layer specific subclass of QgsMapLayerElevationProperties.
Represents a map layer supporting display of point clouds.
QgsMapLayerElevationProperties * elevationProperties() override
Returns the layer's elevation properties.
QgsPointCloudIndex index() const
Returns the point cloud index associated with the layer.
QgsPointCloudDataProvider * dataProvider() override
Returns the layer's data provider, it may be nullptr.
Abstract base class for 2d point cloud renderers.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:109
Q_INVOKABLE QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
A container for the context for various read/write operations on objects.
A rectangle specified with double values.
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:6817
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition qgis.h:6798
#define QgsDebugError(str)
Definition qgslogger.h:57
_LayerRef< QgsMapLayer > QgsMapLayerRef
QList< QgsPointCloudCategory > QgsPointCloudCategoryList