QGIS API Documentation 3.37.0-Master (4ace69f83af)
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 "qgs3dutils.h"
19#include "qgschunkedentity_p.h"
21
22#include "qgspointcloudindex.h"
23#include "qgspointcloudlayer.h"
25#include "qgsxmlutils.h"
26#include "qgsapplication.h"
27#include "qgs3dsymbolregistry.h"
30
31QgsPointCloud3DRenderContext::QgsPointCloud3DRenderContext( const Qgs3DMapSettings &map, const QgsCoordinateTransform &coordinateTransform, std::unique_ptr<QgsPointCloud3DSymbol> symbol, double zValueScale, double zValueFixedOffset )
32 : Qgs3DRenderContext( map )
33 , mSymbol( std::move( symbol ) )
34 , mZValueScale( zValueScale )
35 , mZValueFixedOffset( zValueFixedOffset )
36 , mCoordinateTransform( coordinateTransform )
37 , mFeedback( new QgsFeedback )
38{
39 updateExtent();
40}
41
46
48{
49 mSymbol.reset( symbol );
50}
51
53{
54 mFilteredOutCategories = categories;
55}
56
58{
59 QSet<int> filteredOut;
60 for ( const QgsPointCloudCategory &category : mFilteredOutCategories )
61 filteredOut.insert( category.value() );
62 return filteredOut;
63}
64
66{
67 mCoordinateTransform = coordinateTransform;
68 updateExtent();
69}
70
72{
73 return mFeedback->isCanceled();
74}
75
77{
78 mFeedback->cancel();
79}
80
81void QgsPointCloud3DRenderContext::updateExtent()
82{
83 if ( map().extent().isEmpty() )
84 {
85 // an empty extent means no filter, so let's pass it without transformation
86 mExtent = QgsRectangle();
87 }
88 else
89 {
90 try
91 {
92 mExtent = mCoordinateTransform.transformBoundingBox( map().extent(), Qgis::TransformDirection::Reverse );
93 }
94 catch ( const QgsCsException & )
95 {
96 // bad luck, can't reproject for some reason. Let's use an empty extent to skip filtering.
97 QgsDebugError( QStringLiteral( "Transformation of extent failed!" ) );
98 mExtent = QgsRectangle();
99 }
100 }
101}
102// ---------
103
104
109
111{
113 r->readXml( elem, context );
114 return r;
115}
116
117
118// ---------
119
120
124
129
131{
132 return qobject_cast<QgsPointCloudLayer *>( mLayerRef.layer );
133}
134
136{
137 return QStringLiteral( "pointcloud" );
138}
139
141{
143 if ( mSymbol )
144 {
145 QgsAbstract3DSymbol *symbolClone = mSymbol->clone();
146 r->setSymbol( dynamic_cast<QgsPointCloud3DSymbol *>( symbolClone ) );
147 }
148 r->setMaximumScreenError( mMaximumScreenError );
149 r->setShowBoundingBoxes( mShowBoundingBoxes );
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->crs(), map.crs(), map.transformContext() );
162
163 Qt3DCore::QEntity *entity = nullptr;
164 if ( pcl->dataProvider()->index() )
165 {
166 entity = new QgsPointCloudLayerChunkedEntity( pcl->dataProvider()->index(), map, coordinateTransform, dynamic_cast<QgsPointCloud3DSymbol *>( mSymbol->clone() ), maximumScreenError(), showBoundingBoxes(),
167 static_cast< const QgsPointCloudLayerElevationProperties * >( pcl->elevationProperties() )->zScale(),
168 static_cast< const QgsPointCloudLayerElevationProperties * >( pcl->elevationProperties() )->zOffset(), mPointBudget );
169 }
170 else if ( !pcl->dataProvider()->subIndexes().isEmpty() )
171 {
172 entity = new QgsVirtualPointCloudEntity( pcl, map, coordinateTransform, dynamic_cast<QgsPointCloud3DSymbol *>( mSymbol->clone() ), maximumScreenError(), showBoundingBoxes(),
173 static_cast< const QgsPointCloudLayerElevationProperties * >( pcl->elevationProperties() )->zScale(),
174 static_cast< const QgsPointCloudLayerElevationProperties * >( pcl->elevationProperties() )->zOffset(), mPointBudget );
175 }
176 return entity;
177}
178
180{
181 mSymbol.reset( symbol );
182}
183
184void QgsPointCloudLayer3DRenderer::writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const
185{
186 Q_UNUSED( context )
187
188 QDomDocument doc = elem.ownerDocument();
189
190 elem.setAttribute( QStringLiteral( "layer" ), mLayerRef.layerId );
191 elem.setAttribute( QStringLiteral( "max-screen-error" ), maximumScreenError() );
192 elem.setAttribute( QStringLiteral( "show-bounding-boxes" ), showBoundingBoxes() ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
193 elem.setAttribute( QStringLiteral( "point-budget" ), mPointBudget );
194
195 QDomElement elemSymbol = doc.createElement( QStringLiteral( "symbol" ) );
196 if ( mSymbol )
197 {
198 elemSymbol.setAttribute( QStringLiteral( "type" ), mSymbol->symbolType() );
199 mSymbol->writeXml( elemSymbol, context );
200 }
201 elem.appendChild( elemSymbol );
202}
203
204void QgsPointCloudLayer3DRenderer::readXml( const QDomElement &elem, const QgsReadWriteContext &context )
205{
206 mLayerRef = QgsMapLayerRef( elem.attribute( QStringLiteral( "layer" ) ) );
207
208 const QDomElement elemSymbol = elem.firstChildElement( QStringLiteral( "symbol" ) );
209
210 const QString symbolType = elemSymbol.attribute( QStringLiteral( "type" ) );
211 mShowBoundingBoxes = elem.attribute( QStringLiteral( "show-bounding-boxes" ), QStringLiteral( "0" ) ).toInt();
212 mMaximumScreenError = elem.attribute( QStringLiteral( "max-screen-error" ), QStringLiteral( "3.0" ) ).toDouble();
213 mPointBudget = elem.attribute( QStringLiteral( "point-budget" ), QStringLiteral( "5000000" ) ).toInt();
214
215 if ( symbolType == QLatin1String( "single-color" ) )
216 mSymbol.reset( new QgsSingleColorPointCloud3DSymbol );
217 else if ( symbolType == QLatin1String( "color-ramp" ) )
218 mSymbol.reset( new QgsColorRampPointCloud3DSymbol );
219 else if ( symbolType == QLatin1String( "rgb" ) )
220 mSymbol.reset( new QgsRgbPointCloud3DSymbol );
221 else if ( symbolType == QLatin1String( "classification" ) )
222 mSymbol.reset( new QgsClassificationPointCloud3DSymbol );
223 else
224 mSymbol.reset();
225
226 if ( mSymbol )
227 mSymbol->readXml( elemSymbol, context );
228}
229
231{
232 mLayerRef.setLayer( project.mapLayer( mLayerRef.layerId ) );
233}
234
236{
237 return mMaximumScreenError;
238}
239
241{
242 mMaximumScreenError = error;
243}
244
246{
247 return mShowBoundingBoxes;
248}
249
251{
252 mShowBoundingBoxes = showBoundingBoxes;
253}
254
256{
257 mPointBudget = budget;
258}
259
261{
262 std::unique_ptr< QgsPointCloudLayer3DRenderer > renderer3D = Qgs3DUtils::convert2DPointCloudRendererTo3D( renderer );
263 if ( !renderer3D )
264 {
265 setSymbol( nullptr );
266 return false;
267 }
268
269 QgsPointCloud3DSymbol *newSymbol = const_cast<QgsPointCloud3DSymbol *>(
270 static_cast<QgsPointCloud3DSymbol *>( renderer3D->symbol()->clone() )
271 );
272 // we need to retain some settings from the previous symbol, like point size
273 const QgsPointCloud3DSymbol *oldSymbol = symbol();
274 if ( oldSymbol )
275 oldSymbol->copyBaseSettings( newSymbol );
276 setSymbol( newSymbol );
277 return true;
278}
@ Reverse
Reverse/inverse transform (from destination to source)
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...
Base metadata class for 3D renderers.
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 may to participate in 3D view.
Class for doing transforms between two map coordinate systems.
QgsRectangle transformBoundingBox(const QgsRectangle &rectangle, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward, bool handle180Crossover=false) const
Transforms a rectangle from the source CRS to the destination CRS.
Custom exception class for Coordinate Reference System related exceptions.
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 crs
Definition qgsmaplayer.h:81
QgsRectangle extent() const
Returns the 3D scene's extent in layer crs.
QSet< int > getFilteredOutValues() const
Returns a set containing the filtered out values.
QgsPointCloud3DSymbol * symbol() const
Returns the symbol used for rendering the point cloud.
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.
QgsPointCloud3DRenderContext(const Qgs3DMapSettings &map, 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.
void copyBaseSettings(QgsAbstract3DSymbol *destination) const override
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,...
virtual QgsPointCloudIndex * index() const
Returns the point cloud index associated with the provider.
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)
Qt3DCore::QEntity * createEntity(const Qgs3DMapSettings &map) const override
Returns a 3D entity that will be used to show renderer's data in 3D scene.
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.
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.
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:107
Q_INVOKABLE QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
The class is used as a container of context for various read/write operations on other objects.
A rectangle specified with double values.
#define QgsDebugError(str)
Definition qgslogger.h:38
_LayerRef< QgsMapLayer > QgsMapLayerRef
QList< QgsPointCloudCategory > QgsPointCloudCategoryList
QPointer< TYPE > layer
Weak pointer to map layer.
void setLayer(TYPE *l)
Sets the reference to point to a specified layer.
QString layerId
Original layer ID.