QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
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"
24#include "qgsxmlutils.h"
25#include "qgsapplication.h"
26#include "qgs3dsymbolregistry.h"
29
30QgsPointCloud3DRenderContext::QgsPointCloud3DRenderContext( const Qgs3DMapSettings &map, const QgsCoordinateTransform &coordinateTransform, std::unique_ptr<QgsPointCloud3DSymbol> symbol, double zValueScale, double zValueFixedOffset )
31 : Qgs3DRenderContext( map )
32 , mSymbol( std::move( symbol ) )
33 , mZValueScale( zValueScale )
34 , mZValueFixedOffset( zValueFixedOffset )
35 , mCoordinateTransform( coordinateTransform )
36 , mFeedback( new QgsFeedback )
37{
38 updateExtent();
39}
40
42{
43 mAttributes = attributes;
44}
45
47{
48 mSymbol.reset( symbol );
49}
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
65{
66 mCoordinateTransform = coordinateTransform;
67 updateExtent();
68}
69
71{
72 return mFeedback->isCanceled();
73}
74
76{
77 mFeedback->cancel();
78}
79
80void QgsPointCloud3DRenderContext::updateExtent()
81{
82 if ( map().extent().isEmpty() )
83 {
84 // an empty extent means no filter, so let's pass it without transformation
85 mExtent = QgsRectangle();
86 }
87 else
88 {
89 try
90 {
91 mExtent = mCoordinateTransform.transformBoundingBox( map().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 QgsDebugMsg( QStringLiteral( "Transformation of extent failed!" ) );
97 mExtent = QgsRectangle();
98 }
99 }
100}
101// ---------
102
103
105 : Qgs3DRendererAbstractMetadata( QStringLiteral( "pointcloud" ) )
106{
107}
108
110{
112 r->readXml( elem, context );
113 return r;
114}
115
116
117// ---------
118
119
121{
122}
123
125{
126 mLayerRef = QgsMapLayerRef( layer );
127}
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 return r;
150}
151
153{
154 QgsPointCloudLayer *pcl = layer();
155 if ( !pcl || !pcl->dataProvider() || !pcl->dataProvider()->index() )
156 return nullptr;
157 if ( !mSymbol )
158 return nullptr;
159
160 const QgsCoordinateTransform coordinateTransform( pcl->crs(), map.crs(), map.transformContext() );
161
162 QgsPointCloudLayerChunkedEntity *entity = new QgsPointCloudLayerChunkedEntity( pcl->dataProvider()->index(), map, coordinateTransform, dynamic_cast<QgsPointCloud3DSymbol *>( mSymbol->clone() ), maximumScreenError(), showBoundingBoxes(),
163 static_cast< const QgsPointCloudLayerElevationProperties * >( pcl->elevationProperties() )->zScale(),
164 static_cast< const QgsPointCloudLayerElevationProperties * >( pcl->elevationProperties() )->zOffset(), mPointBudget );
165 return entity;
166}
167
169{
170 mSymbol.reset( symbol );
171}
172
173void QgsPointCloudLayer3DRenderer::writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const
174{
175 Q_UNUSED( context )
176
177 QDomDocument doc = elem.ownerDocument();
178
179 elem.setAttribute( QStringLiteral( "layer" ), mLayerRef.layerId );
180 elem.setAttribute( QStringLiteral( "max-screen-error" ), maximumScreenError() );
181 elem.setAttribute( QStringLiteral( "show-bounding-boxes" ), showBoundingBoxes() ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
182 elem.setAttribute( QStringLiteral( "point-budget" ), mPointBudget );
183
184 QDomElement elemSymbol = doc.createElement( QStringLiteral( "symbol" ) );
185 if ( mSymbol )
186 {
187 elemSymbol.setAttribute( QStringLiteral( "type" ), mSymbol->symbolType() );
188 mSymbol->writeXml( elemSymbol, context );
189 }
190 elem.appendChild( elemSymbol );
191}
192
193void QgsPointCloudLayer3DRenderer::readXml( const QDomElement &elem, const QgsReadWriteContext &context )
194{
195 mLayerRef = QgsMapLayerRef( elem.attribute( QStringLiteral( "layer" ) ) );
196
197 const QDomElement elemSymbol = elem.firstChildElement( QStringLiteral( "symbol" ) );
198
199 const QString symbolType = elemSymbol.attribute( QStringLiteral( "type" ) );
200 mShowBoundingBoxes = elem.attribute( QStringLiteral( "show-bounding-boxes" ), QStringLiteral( "0" ) ).toInt();
201 mMaximumScreenError = elem.attribute( QStringLiteral( "max-screen-error" ), QStringLiteral( "3.0" ) ).toDouble();
202 mPointBudget = elem.attribute( QStringLiteral( "point-budget" ), QStringLiteral( "5000000" ) ).toInt();
203
204 if ( symbolType == QLatin1String( "single-color" ) )
205 mSymbol.reset( new QgsSingleColorPointCloud3DSymbol );
206 else if ( symbolType == QLatin1String( "color-ramp" ) )
207 mSymbol.reset( new QgsColorRampPointCloud3DSymbol );
208 else if ( symbolType == QLatin1String( "rgb" ) )
209 mSymbol.reset( new QgsRgbPointCloud3DSymbol );
210 else if ( symbolType == QLatin1String( "classification" ) )
211 mSymbol.reset( new QgsClassificationPointCloud3DSymbol );
212 else
213 mSymbol.reset();
214
215 if ( mSymbol )
216 mSymbol->readXml( elemSymbol, context );
217}
218
220{
221 mLayerRef.setLayer( project.mapLayer( mLayerRef.layerId ) );
222}
223
225{
226 return mMaximumScreenError;
227}
228
230{
231 mMaximumScreenError = error;
232}
233
235{
236 return mShowBoundingBoxes;
237}
238
240{
241 mShowBoundingBoxes = showBoundingBoxes;
242}
243
245{
246 mPointBudget = budget;
247}
248
250{
251 std::unique_ptr< QgsPointCloudLayer3DRenderer > renderer3D = Qgs3DUtils::convert2DPointCloudRendererTo3D( renderer );
252 if ( !renderer3D )
253 {
254 setSymbol( nullptr );
255 return false;
256 }
257
258 QgsPointCloud3DSymbol *newSymbol = const_cast<QgsPointCloud3DSymbol *>(
259 static_cast<QgsPointCloud3DSymbol *>( renderer3D->symbol()->clone() )
260 );
261 // we need to retain some settings from the previous symbol, like point size
262 const QgsPointCloud3DSymbol *oldSymbol = symbol();
263 if ( oldSymbol )
264 oldSymbol->copyBaseSettings( newSymbol );
265 setSymbol( newSymbol );
266 return true;
267}
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.
Definition: qgs3dutils.cpp:741
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 SIP_THROW(QgsCsException)
Transforms a rectangle from the source CRS to the destination CRS.
Custom exception class for Coordinate Reference System related exceptions.
Definition: qgsexception.h:66
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:45
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:79
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 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:105
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.
Definition: qgsrectangle.h:42
#define QgsDebugMsg(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.