QGIS API Documentation 3.43.0-Master (32433f7016e)
qgs3dutils.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgs3dutils.cpp
3 --------------------------------------
4 Date : July 2017
5 Copyright : (C) 2017 by Martin Dobias
6 Email : wonder 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
16#include "qgs3dutils.h"
17
18#include "qgs3dmapcanvas.h"
19#include "qgslinestring.h"
20#include "qgspolygon.h"
21#include "qgsfeaturerequest.h"
22#include "qgsfeatureiterator.h"
23#include "qgsfeature.h"
24#include "qgsabstractgeometry.h"
25#include "qgsvectorlayer.h"
27#include "qgsfeedback.h"
30#include "qgs3dmapscene.h"
31#include "qgsabstract3dengine.h"
32#include "qgsterraingenerator.h"
33#include "qgscameracontroller.h"
34#include "qgschunkedentity.h"
35#include "qgsterrainentity.h"
44
45#include <QtMath>
46#include <Qt3DExtras/QPhongMaterial>
47#include <Qt3DRender/QRenderSettings>
48#include <QOpenGLContext>
49#include <QOpenGLFunctions>
50#include <Qt3DLogic/QFrameAction>
51
52
53#if QT_VERSION < QT_VERSION_CHECK( 6, 0, 0 )
54#include <Qt3DRender/QBuffer>
55typedef Qt3DRender::QBuffer Qt3DQBuffer;
56#else
57#include <Qt3DCore/QBuffer>
58typedef Qt3DCore::QBuffer Qt3DQBuffer;
59#endif
60
61// declared here as Qgs3DTypes has no cpp file
62const char *Qgs3DTypes::PROP_NAME_3D_RENDERER_FLAG = "PROP_NAME_3D_RENDERER_FLAG";
63
65{
66 // Set policy to always render frame, so we don't wait forever.
67 Qt3DRender::QRenderSettings::RenderPolicy oldPolicy = engine.renderSettings()->renderPolicy();
68 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::Always );
69
70 // Wait for at least one frame to render
71 Qt3DLogic::QFrameAction *frameAction = new Qt3DLogic::QFrameAction();
72 scene->addComponent( frameAction );
73 QEventLoop evLoop;
74 QObject::connect( frameAction, &Qt3DLogic::QFrameAction::triggered, &evLoop, &QEventLoop::quit );
75 evLoop.exec();
76 scene->removeComponent( frameAction );
77 frameAction->deleteLater();
78
79 engine.renderSettings()->setRenderPolicy( oldPolicy );
80}
81
83{
84 QImage resImage;
85 QEventLoop evLoop;
86
87 // We need to change render policy to RenderPolicy::Always, since otherwise render capture node won't work
88 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::Always );
89
90 waitForFrame( engine, scene );
91
92 auto saveImageFcn = [&evLoop, &resImage]( const QImage &img ) {
93 resImage = img;
94 evLoop.quit();
95 };
96
97 const QMetaObject::Connection conn1 = QObject::connect( &engine, &QgsAbstract3DEngine::imageCaptured, saveImageFcn );
98 QMetaObject::Connection conn2;
99
100 auto requestImageFcn = [&engine, scene] {
101 if ( scene->sceneState() == Qgs3DMapScene::Ready )
102 {
103 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::OnDemand );
104 engine.requestCaptureImage();
105 }
106 };
107
108 if ( scene->sceneState() == Qgs3DMapScene::Ready )
109 {
110 requestImageFcn();
111 }
112 else
113 {
114 // first wait until scene is loaded
115 conn2 = QObject::connect( scene, &Qgs3DMapScene::sceneStateChanged, requestImageFcn );
116 }
117
118 evLoop.exec();
119
120 QObject::disconnect( conn1 );
121 if ( conn2 )
122 QObject::disconnect( conn2 );
123
124 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::OnDemand );
125 return resImage;
126}
127
129{
130 QImage resImage;
131 QEventLoop evLoop;
132
133 // We need to change render policy to RenderPolicy::Always, since otherwise render capture node won't work
134 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::Always );
135
136 auto requestImageFcn = [&engine, scene] {
137 if ( scene->sceneState() == Qgs3DMapScene::Ready )
138 {
139 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::OnDemand );
141 }
142 };
143
144 auto saveImageFcn = [&evLoop, &resImage]( const QImage &img ) {
145 resImage = img;
146 evLoop.quit();
147 };
148
149 QMetaObject::Connection conn1 = QObject::connect( &engine, &QgsAbstract3DEngine::depthBufferCaptured, saveImageFcn );
150 QMetaObject::Connection conn2;
151
152 // Make sure once-per-frame functions run
153 waitForFrame( engine, scene );
154 if ( scene->sceneState() == Qgs3DMapScene::Ready )
155 {
156 requestImageFcn();
157 }
158 else
159 {
160 // first wait until scene is loaded
161 conn2 = QObject::connect( scene, &Qgs3DMapScene::sceneStateChanged, requestImageFcn );
162 }
163
164 evLoop.exec();
165
166 QObject::disconnect( conn1 );
167 if ( conn2 )
168 QObject::disconnect( conn2 );
169
170 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::OnDemand );
171 return resImage;
172}
173
174
175double Qgs3DUtils::calculateEntityGpuMemorySize( Qt3DCore::QEntity *entity )
176{
177 long long usedGpuMemory = 0;
178 for ( Qt3DQBuffer *buffer : entity->findChildren<Qt3DQBuffer *>() )
179 {
180 usedGpuMemory += buffer->data().size();
181 }
182 for ( Qt3DRender::QTexture2D *tex : entity->findChildren<Qt3DRender::QTexture2D *>() )
183 {
184 // TODO : lift the assumption that the texture is RGBA
185 usedGpuMemory += tex->width() * tex->height() * 4;
186 }
187 return usedGpuMemory / 1024.0 / 1024.0;
188}
189
190
191bool Qgs3DUtils::exportAnimation( const Qgs3DAnimationSettings &animationSettings, Qgs3DMapSettings &mapSettings, int framesPerSecond, const QString &outputDirectory, const QString &fileNameTemplate, const QSize &outputSize, QString &error, QgsFeedback *feedback )
192{
193 if ( animationSettings.keyFrames().size() < 2 )
194 {
195 error = QObject::tr( "Unable to export 3D animation. Add at least 2 keyframes" );
196 return false;
197 }
198
199 const float duration = animationSettings.duration(); //in seconds
200 if ( duration <= 0 )
201 {
202 error = QObject::tr( "Unable to export 3D animation (invalid duration)." );
203 return false;
204 }
205
206 float time = 0;
207 int frameNo = 0;
208 const int totalFrames = static_cast<int>( duration * framesPerSecond );
209
210 if ( fileNameTemplate.isEmpty() )
211 {
212 error = QObject::tr( "Filename template is empty" );
213 return false;
214 }
215
216 const int numberOfDigits = fileNameTemplate.count( QLatin1Char( '#' ) );
217 if ( numberOfDigits < 0 )
218 {
219 error = QObject::tr( "Wrong filename template format (must contain #)" );
220 return false;
221 }
222 const QString token( numberOfDigits, QLatin1Char( '#' ) );
223 if ( !fileNameTemplate.contains( token ) )
224 {
225 error = QObject::tr( "Filename template must contain all # placeholders in one continuous group." );
226 return false;
227 }
228
229 if ( !QDir().exists( outputDirectory ) )
230 {
231 if ( !QDir().mkpath( outputDirectory ) )
232 {
233 error = QObject::tr( "Output directory could not be created." );
234 return false;
235 }
236 }
237
239 engine.setSize( outputSize );
240 Qgs3DMapScene *scene = new Qgs3DMapScene( mapSettings, &engine );
241 engine.setRootEntity( scene );
242 // We need to change render policy to RenderPolicy::Always, since otherwise render capture node won't work
243 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::Always );
244
245 while ( time <= duration )
246 {
247 if ( feedback )
248 {
249 if ( feedback->isCanceled() )
250 {
251 error = QObject::tr( "Export canceled" );
252 return false;
253 }
254 feedback->setProgress( frameNo / static_cast<double>( totalFrames ) * 100 );
255 }
256 ++frameNo;
257
258 const Qgs3DAnimationSettings::Keyframe kf = animationSettings.interpolate( time );
259 scene->cameraController()->setLookingAtPoint( kf.point, kf.dist, kf.pitch, kf.yaw );
260
261 QString fileName( fileNameTemplate );
262 const QString frameNoPaddedLeft( QStringLiteral( "%1" ).arg( frameNo, numberOfDigits, 10, QChar( '0' ) ) ); // e.g. 0001
263 fileName.replace( token, frameNoPaddedLeft );
264 const QString path = QDir( outputDirectory ).filePath( fileName );
265
266 const QImage img = Qgs3DUtils::captureSceneImage( engine, scene );
267
268 img.save( path );
269
270 time += 1.0f / static_cast<float>( framesPerSecond );
271 }
272
273 return true;
274}
275
276
277int Qgs3DUtils::maxZoomLevel( double tile0width, double tileResolution, double maxError )
278{
279 if ( maxError <= 0 || tileResolution <= 0 || tile0width <= 0 )
280 return 0; // invalid input
281
282 // derived from:
283 // tile width [map units] = tile0width / 2^zoomlevel
284 // tile error [map units] = tile width / tile resolution
285 // + re-arranging to get zoom level if we know tile error we want to get
286 const double zoomLevel = -log( tileResolution * maxError / tile0width ) / log( 2 );
287 return round( zoomLevel ); // we could use ceil() here if we wanted to always get to the desired error
288}
289
291{
292 switch ( altClamp )
293 {
295 return QStringLiteral( "absolute" );
297 return QStringLiteral( "relative" );
299 return QStringLiteral( "terrain" );
300 }
302}
303
304
306{
307 if ( str == QLatin1String( "absolute" ) )
309 else if ( str == QLatin1String( "terrain" ) )
311 else // "relative" (default)
313}
314
315
317{
318 switch ( altBind )
319 {
321 return QStringLiteral( "vertex" );
323 return QStringLiteral( "centroid" );
324 }
326}
327
328
330{
331 if ( str == QLatin1String( "vertex" ) )
333 else // "centroid" (default)
335}
336
338{
339 switch ( mode )
340 {
342 return QStringLiteral( "no-culling" );
344 return QStringLiteral( "front" );
345 case Qgs3DTypes::Back:
346 return QStringLiteral( "back" );
348 return QStringLiteral( "front-and-back" );
349 }
351}
352
354{
355 if ( str == QLatin1String( "front" ) )
356 return Qgs3DTypes::Front;
357 else if ( str == QLatin1String( "back" ) )
358 return Qgs3DTypes::Back;
359 else if ( str == QLatin1String( "front-and-back" ) )
361 else
363}
364
365float Qgs3DUtils::clampAltitude( const QgsPoint &p, Qgis::AltitudeClamping altClamp, Qgis::AltitudeBinding altBind, float offset, const QgsPoint &centroid, const Qgs3DRenderContext &context )
366{
367 float terrainZ = 0;
368 switch ( altClamp )
369 {
372 {
373 const QgsPointXY pt = altBind == Qgis::AltitudeBinding::Vertex ? p : centroid;
374 terrainZ = context.terrainRenderingEnabled() && context.terrainGenerator() ? context.terrainGenerator()->heightAt( pt.x(), pt.y(), context ) : 0;
375 break;
376 }
377
379 break;
380 }
381
382 float geomZ = 0;
383 if ( p.is3D() )
384 {
385 switch ( altClamp )
386 {
389 geomZ = p.z();
390 break;
391
393 break;
394 }
395 }
396
397 const float z = ( terrainZ + geomZ ) * static_cast<float>( context.terrainSettings()->verticalScale() ) + offset;
398 return z;
399}
400
401void Qgs3DUtils::clampAltitudes( QgsLineString *lineString, Qgis::AltitudeClamping altClamp, Qgis::AltitudeBinding altBind, const QgsPoint &centroid, float offset, const Qgs3DRenderContext &context )
402{
403 for ( int i = 0; i < lineString->nCoordinates(); ++i )
404 {
405 float terrainZ = 0;
406 switch ( altClamp )
407 {
410 {
411 QgsPointXY pt;
412 switch ( altBind )
413 {
415 pt.setX( lineString->xAt( i ) );
416 pt.setY( lineString->yAt( i ) );
417 break;
418
420 pt.set( centroid.x(), centroid.y() );
421 break;
422 }
423
424 terrainZ = context.terrainRenderingEnabled() && context.terrainGenerator() ? context.terrainGenerator()->heightAt( pt.x(), pt.y(), context ) : 0;
425 break;
426 }
427
429 break;
430 }
431
432 float geomZ = 0;
433
434 switch ( altClamp )
435 {
438 geomZ = lineString->zAt( i );
439 break;
440
442 break;
443 }
444
445 const float z = ( terrainZ + geomZ ) * static_cast<float>( context.terrainSettings()->verticalScale() ) + offset;
446 lineString->setZAt( i, z );
447 }
448}
449
450
451bool Qgs3DUtils::clampAltitudes( QgsPolygon *polygon, Qgis::AltitudeClamping altClamp, Qgis::AltitudeBinding altBind, float offset, const Qgs3DRenderContext &context )
452{
453 if ( !polygon->is3D() )
454 polygon->addZValue( 0 );
455
456 QgsPoint centroid;
457 switch ( altBind )
458 {
460 break;
461
463 centroid = polygon->centroid();
464 break;
465 }
466
467 QgsCurve *curve = const_cast<QgsCurve *>( polygon->exteriorRing() );
468 QgsLineString *lineString = qgsgeometry_cast<QgsLineString *>( curve );
469 if ( !lineString )
470 return false;
471
472 clampAltitudes( lineString, altClamp, altBind, centroid, offset, context );
473
474 for ( int i = 0; i < polygon->numInteriorRings(); ++i )
475 {
476 QgsCurve *curve = const_cast<QgsCurve *>( polygon->interiorRing( i ) );
477 QgsLineString *lineString = qgsgeometry_cast<QgsLineString *>( curve );
478 if ( !lineString )
479 return false;
480
481 clampAltitudes( lineString, altClamp, altBind, centroid, offset, context );
482 }
483 return true;
484}
485
486
487QString Qgs3DUtils::matrix4x4toString( const QMatrix4x4 &m )
488{
489 const float *d = m.constData();
490 QStringList elems;
491 elems.reserve( 16 );
492 for ( int i = 0; i < 16; ++i )
493 elems << QString::number( d[i] );
494 return elems.join( ' ' );
495}
496
497QMatrix4x4 Qgs3DUtils::stringToMatrix4x4( const QString &str )
498{
499 QMatrix4x4 m;
500 float *d = m.data();
501 QStringList elems = str.split( ' ' );
502 for ( int i = 0; i < 16; ++i )
503 d[i] = elems[i].toFloat();
504 return m;
505}
506
507void Qgs3DUtils::extractPointPositions( const QgsFeature &f, const Qgs3DRenderContext &context, const QgsVector3D &chunkOrigin, Qgis::AltitudeClamping altClamp, QVector<QVector3D> &positions )
508{
509 const QgsAbstractGeometry *g = f.geometry().constGet();
510 for ( auto it = g->vertices_begin(); it != g->vertices_end(); ++it )
511 {
512 const QgsPoint pt = *it;
513 float geomZ = 0;
514 if ( pt.is3D() )
515 {
516 geomZ = pt.z();
517 }
518 const float terrainZ = context.terrainRenderingEnabled() && context.terrainGenerator() ? static_cast<float>( context.terrainGenerator()->heightAt( pt.x(), pt.y(), context ) * context.terrainSettings()->verticalScale() ) : 0.f;
519 float h = 0.0f;
520 switch ( altClamp )
521 {
523 h = geomZ;
524 break;
526 h = terrainZ;
527 break;
529 h = terrainZ + geomZ;
530 break;
531 }
532 positions.append( QVector3D(
533 static_cast<float>( pt.x() - chunkOrigin.x() ),
534 static_cast<float>( pt.y() - chunkOrigin.y() ),
535 h
536 ) );
537 QgsDebugMsgLevel( QStringLiteral( "%1 %2 %3" ).arg( positions.last().x() ).arg( positions.last().y() ).arg( positions.last().z() ), 2 );
538 }
539}
540
546static inline uint outcode( QVector4D v )
547{
548 // For a discussion of outcodes see pg 388 Dunn & Parberry.
549 // For why you can't just test if the point is in a bounding box
550 // consider the case where a view frustum with view-size 1.5 x 1.5
551 // is tested against a 2x2 box which encloses the near-plane, while
552 // all the points in the box are outside the frustum.
553 // TODO: optimise this with assembler - according to D&P this can
554 // be done in one line of assembler on some platforms
555 uint code = 0;
556 if ( v.x() < -v.w() )
557 code |= 0x01;
558 if ( v.x() > v.w() )
559 code |= 0x02;
560 if ( v.y() < -v.w() )
561 code |= 0x04;
562 if ( v.y() > v.w() )
563 code |= 0x08;
564 if ( v.z() < -v.w() )
565 code |= 0x10;
566 if ( v.z() > v.w() )
567 code |= 0x20;
568 return code;
569}
570
571
582bool Qgs3DUtils::isCullable( const QgsAABB &bbox, const QMatrix4x4 &viewProjectionMatrix )
583{
584 uint out = 0xff;
585
586 for ( int i = 0; i < 8; ++i )
587 {
588 const QVector4D p( ( ( i >> 0 ) & 1 ) ? bbox.xMin : bbox.xMax, ( ( i >> 1 ) & 1 ) ? bbox.yMin : bbox.yMax, ( ( i >> 2 ) & 1 ) ? bbox.zMin : bbox.zMax, 1 );
589 const QVector4D pc = viewProjectionMatrix * p;
590
591 // if the logical AND of all the outcodes is non-zero then the BB is
592 // definitely outside the view frustum.
593 out = out & outcode( pc );
594 }
595 return out;
596}
597
599{
600 return QgsVector3D( mapCoords.x() - origin.x(), mapCoords.y() - origin.y(), mapCoords.z() - origin.z() );
601}
602
604{
605 return QgsVector3D( worldCoords.x() + origin.x(), worldCoords.y() + origin.y(), worldCoords.z() + origin.z() );
606}
607
609{
610 QgsRectangle extentMapCrs( extent );
611 if ( crs1 != crs2 )
612 {
613 // reproject if necessary
614 QgsCoordinateTransform ct( crs1, crs2, context );
616 try
617 {
618 extentMapCrs = ct.transformBoundingBox( extentMapCrs );
619 }
620 catch ( const QgsCsException & )
621 {
622 // bad luck, can't reproject for some reason
623 QgsDebugError( QStringLiteral( "3D utils: transformation of extent failed: " ) + extentMapCrs.toString( -1 ) );
624 }
625 }
626 return extentMapCrs;
627}
628
629QgsAABB Qgs3DUtils::layerToWorldExtent( const QgsRectangle &extent, double zMin, double zMax, const QgsCoordinateReferenceSystem &layerCrs, const QgsVector3D &mapOrigin, const QgsCoordinateReferenceSystem &mapCrs, const QgsCoordinateTransformContext &context )
630{
631 const QgsRectangle extentMapCrs( Qgs3DUtils::tryReprojectExtent2D( extent, layerCrs, mapCrs, context ) );
632 return mapToWorldExtent( extentMapCrs, zMin, zMax, mapOrigin );
633}
634
636{
637 const QgsRectangle extentMap = worldToMapExtent( bbox, mapOrigin );
638 return Qgs3DUtils::tryReprojectExtent2D( extentMap, mapCrs, layerCrs, context );
639}
640
641QgsAABB Qgs3DUtils::mapToWorldExtent( const QgsRectangle &extent, double zMin, double zMax, const QgsVector3D &mapOrigin )
642{
643 const QgsVector3D extentMin3D( extent.xMinimum(), extent.yMinimum(), zMin );
644 const QgsVector3D extentMax3D( extent.xMaximum(), extent.yMaximum(), zMax );
645 const QgsVector3D worldExtentMin3D = mapToWorldCoordinates( extentMin3D, mapOrigin );
646 const QgsVector3D worldExtentMax3D = mapToWorldCoordinates( extentMax3D, mapOrigin );
647 QgsAABB rootBbox( worldExtentMin3D.x(), worldExtentMin3D.y(), worldExtentMin3D.z(), worldExtentMax3D.x(), worldExtentMax3D.y(), worldExtentMax3D.z() );
648 return rootBbox;
649}
650
652{
653 const QgsVector3D extentMin3D( box3D.xMinimum(), box3D.yMinimum(), box3D.zMinimum() );
654 const QgsVector3D extentMax3D( box3D.xMaximum(), box3D.yMaximum(), box3D.zMaximum() );
655 const QgsVector3D worldExtentMin3D = mapToWorldCoordinates( extentMin3D, mapOrigin );
656 const QgsVector3D worldExtentMax3D = mapToWorldCoordinates( extentMax3D, mapOrigin );
657 // casting to float should be ok, assuming that the map origin is not too far from the box
658 return QgsAABB( static_cast<float>( worldExtentMin3D.x() ), static_cast<float>( worldExtentMin3D.y() ), static_cast<float>( worldExtentMin3D.z() ), static_cast<float>( worldExtentMax3D.x() ), static_cast<float>( worldExtentMax3D.y() ), static_cast<float>( worldExtentMax3D.z() ) );
659}
660
662{
663 const QgsVector3D worldExtentMin3D = Qgs3DUtils::worldToMapCoordinates( QgsVector3D( bbox.xMin, bbox.yMin, bbox.zMin ), mapOrigin );
664 const QgsVector3D worldExtentMax3D = Qgs3DUtils::worldToMapCoordinates( QgsVector3D( bbox.xMax, bbox.yMax, bbox.zMax ), mapOrigin );
665 const QgsRectangle extentMap( worldExtentMin3D.x(), worldExtentMin3D.y(), worldExtentMax3D.x(), worldExtentMax3D.y() );
666 // we discard zMin/zMax here because we don't need it
667 return extentMap;
668}
669
670
672{
673 const QgsVector3D mapPoint1 = worldToMapCoordinates( worldPoint1, origin1 );
674 QgsVector3D mapPoint2 = mapPoint1;
675 if ( crs1 != crs2 )
676 {
677 // reproject if necessary
678 const QgsCoordinateTransform ct( crs1, crs2, context );
679 try
680 {
681 const QgsPointXY pt = ct.transform( QgsPointXY( mapPoint1.x(), mapPoint1.y() ) );
682 mapPoint2.set( pt.x(), pt.y(), mapPoint1.z() );
683 }
684 catch ( const QgsCsException & )
685 {
686 // bad luck, can't reproject for some reason
687 }
688 }
689 return mapToWorldCoordinates( mapPoint2, origin2 );
690}
691
692void Qgs3DUtils::estimateVectorLayerZRange( QgsVectorLayer *layer, double &zMin, double &zMax )
693{
694 if ( !QgsWkbTypes::hasZ( layer->wkbType() ) )
695 {
696 zMin = 0;
697 zMax = 0;
698 return;
699 }
700
701 zMin = std::numeric_limits<double>::max();
702 zMax = std::numeric_limits<double>::lowest();
703
704 QgsFeature f;
705 QgsFeatureIterator it = layer->getFeatures( QgsFeatureRequest().setNoAttributes().setLimit( 100 ) );
706 while ( it.nextFeature( f ) )
707 {
708 const QgsGeometry g = f.geometry();
709 for ( auto vit = g.vertices_begin(); vit != g.vertices_end(); ++vit )
710 {
711 const double z = ( *vit ).z();
712 if ( z < zMin )
713 zMin = z;
714 if ( z > zMax )
715 zMax = z;
716 }
717 }
718
719 if ( zMin == std::numeric_limits<double>::max() && zMax == std::numeric_limits<double>::lowest() )
720 {
721 zMin = 0;
722 zMax = 0;
723 }
724}
725
734
736{
738 settings.setAmbient( material->ambient() );
739 settings.setDiffuse( material->diffuse() );
740 settings.setSpecular( material->specular() );
741 settings.setShininess( material->shininess() );
742 return settings;
743}
744
745QgsRay3D Qgs3DUtils::rayFromScreenPoint( const QPoint &point, const QSize &windowSize, Qt3DRender::QCamera *camera )
746{
747 const QVector3D deviceCoords( point.x(), point.y(), 0.0 );
748 // normalized device coordinates
749 const QVector3D normDeviceCoords( 2.0 * deviceCoords.x() / windowSize.width() - 1.0f, 1.0f - 2.0 * deviceCoords.y() / windowSize.height(), camera->nearPlane() );
750 // clip coordinates
751 const QVector4D rayClip( normDeviceCoords.x(), normDeviceCoords.y(), -1.0, 0.0 );
752
753 const QMatrix4x4 invertedProjMatrix = camera->projectionMatrix().inverted();
754 const QMatrix4x4 invertedViewMatrix = camera->viewMatrix().inverted();
755
756 // ray direction in view coordinates
757 QVector4D rayDirView = invertedProjMatrix * rayClip;
758 // ray origin in world coordinates
759 const QVector4D rayOriginWorld = invertedViewMatrix * QVector4D( 0.0f, 0.0f, 0.0f, 1.0f );
760
761 // ray direction in world coordinates
762 rayDirView.setZ( -1.0f );
763 rayDirView.setW( 0.0f );
764 const QVector4D rayDirWorld4D = invertedViewMatrix * rayDirView;
765 QVector3D rayDirWorld( rayDirWorld4D.x(), rayDirWorld4D.y(), rayDirWorld4D.z() );
766 rayDirWorld = rayDirWorld.normalized();
767
768 return QgsRay3D( QVector3D( rayOriginWorld ), rayDirWorld );
769}
770
771QVector3D Qgs3DUtils::screenPointToWorldPos( const QPoint &screenPoint, double depth, const QSize &screenSize, Qt3DRender::QCamera *camera )
772{
773 double dNear = camera->nearPlane();
774 double dFar = camera->farPlane();
775 double distance = ( 2.0 * dNear * dFar ) / ( dFar + dNear - ( depth * 2 - 1 ) * ( dFar - dNear ) );
776
777 QgsRay3D ray = Qgs3DUtils::rayFromScreenPoint( screenPoint, screenSize, camera );
778 double dot = QVector3D::dotProduct( ray.direction(), camera->viewVector().normalized() );
779 distance /= dot;
780
781 return ray.origin() + distance * ray.direction();
782}
783
784void Qgs3DUtils::pitchAndYawFromViewVector( QVector3D vect, double &pitch, double &yaw )
785{
786 vect.normalize();
787
788 pitch = qRadiansToDegrees( qAcos( vect.y() ) );
789 yaw = qRadiansToDegrees( qAtan2( -vect.z(), vect.x() ) ) + 90;
790}
791
792QVector2D Qgs3DUtils::screenToTextureCoordinates( QVector2D screenXY, QSize winSize )
793{
794 return QVector2D( screenXY.x() / winSize.width(), 1 - screenXY.y() / winSize.width() );
795}
796
797QVector2D Qgs3DUtils::textureToScreenCoordinates( QVector2D textureXY, QSize winSize )
798{
799 return QVector2D( textureXY.x() * winSize.width(), ( 1 - textureXY.y() ) * winSize.height() );
800}
801
802std::unique_ptr<QgsPointCloudLayer3DRenderer> Qgs3DUtils::convert2DPointCloudRendererTo3D( QgsPointCloudRenderer *renderer )
803{
804 if ( !renderer )
805 return nullptr;
806
807 std::unique_ptr<QgsPointCloud3DSymbol> symbol3D;
808 if ( renderer->type() == QLatin1String( "ramp" ) )
809 {
810 const QgsPointCloudAttributeByRampRenderer *renderer2D = dynamic_cast<const QgsPointCloudAttributeByRampRenderer *>( renderer );
811 symbol3D = std::make_unique<QgsColorRampPointCloud3DSymbol>();
812 QgsColorRampPointCloud3DSymbol *symbol = static_cast<QgsColorRampPointCloud3DSymbol *>( symbol3D.get() );
813 symbol->setAttribute( renderer2D->attribute() );
814 symbol->setColorRampShaderMinMax( renderer2D->minimum(), renderer2D->maximum() );
815 symbol->setColorRampShader( renderer2D->colorRampShader() );
816 }
817 else if ( renderer->type() == QLatin1String( "rgb" ) )
818 {
819 const QgsPointCloudRgbRenderer *renderer2D = dynamic_cast<const QgsPointCloudRgbRenderer *>( renderer );
820 symbol3D = std::make_unique<QgsRgbPointCloud3DSymbol>();
821 QgsRgbPointCloud3DSymbol *symbol = static_cast<QgsRgbPointCloud3DSymbol *>( symbol3D.get() );
822 symbol->setRedAttribute( renderer2D->redAttribute() );
823 symbol->setGreenAttribute( renderer2D->greenAttribute() );
824 symbol->setBlueAttribute( renderer2D->blueAttribute() );
825
826 symbol->setRedContrastEnhancement( renderer2D->redContrastEnhancement() ? new QgsContrastEnhancement( *renderer2D->redContrastEnhancement() ) : nullptr );
827 symbol->setGreenContrastEnhancement( renderer2D->greenContrastEnhancement() ? new QgsContrastEnhancement( *renderer2D->greenContrastEnhancement() ) : nullptr );
828 symbol->setBlueContrastEnhancement( renderer2D->blueContrastEnhancement() ? new QgsContrastEnhancement( *renderer2D->blueContrastEnhancement() ) : nullptr );
829 }
830 else if ( renderer->type() == QLatin1String( "classified" ) )
831 {
832 const QgsPointCloudClassifiedRenderer *renderer2D = dynamic_cast<const QgsPointCloudClassifiedRenderer *>( renderer );
833 symbol3D = std::make_unique<QgsClassificationPointCloud3DSymbol>();
834 QgsClassificationPointCloud3DSymbol *symbol = static_cast<QgsClassificationPointCloud3DSymbol *>( symbol3D.get() );
835 symbol->setAttribute( renderer2D->attribute() );
836 symbol->setCategoriesList( renderer2D->categories() );
837 }
838
839 if ( symbol3D )
840 {
841 auto renderer3D = std::make_unique<QgsPointCloudLayer3DRenderer>();
842 renderer3D->setSymbol( symbol3D.release() );
843 return renderer3D;
844 }
845 return nullptr;
846}
847
848QHash<QgsMapLayer *, QVector<QgsRayCastingUtils::RayHit>> Qgs3DUtils::castRay( Qgs3DMapScene *scene, const QgsRay3D &ray, const QgsRayCastingUtils::RayCastContext &context )
849{
850 QgsRayCastingUtils::Ray3D r( ray.origin(), ray.direction(), context.maxDistance );
851 QHash<QgsMapLayer *, QVector<QgsRayCastingUtils::RayHit>> results;
852 const QList<QgsMapLayer *> keys = scene->layers();
853 for ( QgsMapLayer *layer : keys )
854 {
855 Qt3DCore::QEntity *entity = scene->layerEntity( layer );
856
857 if ( QgsChunkedEntity *chunkedEntity = qobject_cast<QgsChunkedEntity *>( entity ) )
858 {
859 const QVector<QgsRayCastingUtils::RayHit> result = chunkedEntity->rayIntersection( r, context );
860 if ( !result.isEmpty() )
861 results[layer] = result;
862 }
863 }
864 if ( QgsTerrainEntity *terrain = scene->terrainEntity() )
865 {
866 const QVector<QgsRayCastingUtils::RayHit> result = terrain->rayIntersection( r, context );
867 if ( !result.isEmpty() )
868 results[nullptr] = result; // Terrain hits are not tied to a layer so we use nullptr as their key here
869 }
870 if ( QgsGlobeEntity *globe = scene->globeEntity() )
871 {
872 const QVector<QgsRayCastingUtils::RayHit> result = globe->rayIntersection( r, context );
873 if ( !result.isEmpty() )
874 results[nullptr] = result; // Terrain hits are not tied to a layer so we use nullptr as their key here
875 }
876 return results;
877}
878
879float Qgs3DUtils::screenSpaceError( float epsilon, float distance, int screenSize, float fov )
880{
881 /* This routine approximately calculates how an error (epsilon) of an object in world coordinates
882 * at given distance (between camera and the object) will look like in screen coordinates.
883 *
884 * the math below simply uses triangle similarity:
885 *
886 * epsilon phi
887 * ----------------------------- = ----------------
888 * [ frustum width at distance ] [ screen width ]
889 *
890 * Then we solve for phi, substituting [frustum width at distance] = 2 * distance * tan(fov / 2)
891 *
892 * ________xxx__ xxx = real world error (epsilon)
893 * \ | / x = screen space error (phi)
894 * \ | /
895 * \___|_x_/ near plane (screen space)
896 * \ | /
897 * \ | /
898 * \|/ angle = field of view
899 * camera
900 */
901 float phi = epsilon * static_cast<float>( screenSize ) / static_cast<float>( 2 * distance * tan( fov * M_PI / ( 2 * 180 ) ) );
902 return phi;
903}
904
905void Qgs3DUtils::computeBoundingBoxNearFarPlanes( const QgsAABB &bbox, const QMatrix4x4 &viewMatrix, float &fnear, float &ffar )
906{
907 fnear = 1e9;
908 ffar = 0;
909
910 for ( int i = 0; i < 8; ++i )
911 {
912 const QVector4D p( ( ( i >> 0 ) & 1 ) ? bbox.xMin : bbox.xMax, ( ( i >> 1 ) & 1 ) ? bbox.yMin : bbox.yMax, ( ( i >> 2 ) & 1 ) ? bbox.zMin : bbox.zMax, 1 );
913
914 const QVector4D pc = viewMatrix * p;
915
916 const float dst = -pc.z(); // in camera coordinates, x grows right, y grows down, z grows to the back
917 fnear = std::min( fnear, dst );
918 ffar = std::max( ffar, dst );
919 }
920}
921
922Qt3DRender::QCullFace::CullingMode Qgs3DUtils::qt3DcullingMode( Qgs3DTypes::CullingMode mode )
923{
924 switch ( mode )
925 {
927 return Qt3DRender::QCullFace::NoCulling;
929 return Qt3DRender::QCullFace::Front;
930 case Qgs3DTypes::Back:
931 return Qt3DRender::QCullFace::Back;
933 return Qt3DRender::QCullFace::FrontAndBack;
934 }
935 return Qt3DRender::QCullFace::NoCulling;
936}
937
938
939QByteArray Qgs3DUtils::addDefinesToShaderCode( const QByteArray &shaderCode, const QStringList &defines )
940{
941 // There is one caveat to take care of - GLSL source code needs to start with #version as
942 // a first directive, otherwise we get the old GLSL 100 version. So we can't just prepend the
943 // shader source code, but insert our defines at the right place.
944
945 QStringList defineLines;
946 for ( const QString &define : defines )
947 defineLines += "#define " + define + "\n";
948
949 QString definesText = defineLines.join( QString() );
950
951 QByteArray newShaderCode = shaderCode;
952 int versionIndex = shaderCode.indexOf( "#version " );
953 int insertionIndex = versionIndex == -1 ? 0 : shaderCode.indexOf( '\n', versionIndex + 1 ) + 1;
954 newShaderCode.insert( insertionIndex, definesText.toLatin1() );
955 return newShaderCode;
956}
957
958QByteArray Qgs3DUtils::removeDefinesFromShaderCode( const QByteArray &shaderCode, const QStringList &defines )
959{
960 QByteArray newShaderCode = shaderCode;
961
962 for ( const QString &define : defines )
963 {
964 const QString defineLine = "#define " + define + "\n";
965 const int defineLineIndex = newShaderCode.indexOf( defineLine.toUtf8() );
966 if ( defineLineIndex != -1 )
967 {
968 newShaderCode.remove( defineLineIndex, defineLine.size() );
969 }
970 }
971
972 return newShaderCode;
973}
974
975void Qgs3DUtils::decomposeTransformMatrix( const QMatrix4x4 &matrix, QVector3D &translation, QQuaternion &rotation, QVector3D &scale )
976{
977 // decompose the transform matrix
978 // assuming the last row has values [0 0 0 1]
979 // see https://math.stackexchange.com/questions/237369/given-this-transformation-matrix-how-do-i-decompose-it-into-translation-rotati
980 const float *md = matrix.data(); // returns data in column-major order
981 const float sx = QVector3D( md[0], md[1], md[2] ).length();
982 const float sy = QVector3D( md[4], md[5], md[6] ).length();
983 const float sz = QVector3D( md[8], md[9], md[10] ).length();
984 float rd[9] = {
985 md[0] / sx,
986 md[4] / sy,
987 md[8] / sz,
988 md[1] / sx,
989 md[5] / sy,
990 md[9] / sz,
991 md[2] / sx,
992 md[6] / sy,
993 md[10] / sz,
994 };
995 const QMatrix3x3 rot3x3( rd ); // takes data in row-major order
996
997 scale = QVector3D( sx, sy, sz );
998 rotation = QQuaternion::fromRotationMatrix( rot3x3 );
999 translation = QVector3D( md[12], md[13], md[14] );
1000}
1001
1002int Qgs3DUtils::openGlMaxClipPlanes( QSurface *surface )
1003{
1004 int numPlanes = 6;
1005
1006 QOpenGLContext context;
1007 context.setFormat( QSurfaceFormat::defaultFormat() );
1008 if ( context.create() )
1009 {
1010 if ( context.makeCurrent( surface ) )
1011 {
1012 QOpenGLFunctions *funcs = context.functions();
1013 funcs->glGetIntegerv( GL_MAX_CLIP_PLANES, &numPlanes );
1014 }
1015 }
1016
1017 return numPlanes;
1018}
1019
1020QQuaternion Qgs3DUtils::rotationFromPitchHeadingAngles( float pitchAngle, float headingAngle )
1021{
1022 return QQuaternion::fromAxisAndAngle( QVector3D( 0, 0, 1 ), headingAngle ) * QQuaternion::fromAxisAndAngle( QVector3D( 1, 0, 0 ), pitchAngle );
1023}
1024
1025QgsPoint Qgs3DUtils::screenPointToMapCoordinates( const QPoint &screenPoint, const QSize size, const QgsCameraController *cameraController, const Qgs3DMapSettings *mapSettings )
1026{
1027 const QgsRay3D ray = rayFromScreenPoint( screenPoint, size, cameraController->camera() );
1028
1029 // pick an arbitrary point mid-way between near and far plane
1030 const float pointDistance = ( cameraController->camera()->farPlane() + cameraController->camera()->nearPlane() ) / 2;
1031 const QVector3D worldPoint = ray.origin() + pointDistance * ray.direction().normalized();
1032 const QgsVector3D mapTransform = worldToMapCoordinates( worldPoint, mapSettings->origin() );
1033 const QgsPoint mapPoint( mapTransform.x(), mapTransform.y(), mapTransform.z() );
1034 return mapPoint;
1035}
1036
1037// computes the portion of the Y=y plane the camera is looking at
1038void Qgs3DUtils::calculateViewExtent( const Qt3DRender::QCamera *camera, float maxRenderingDistance, float z, float &minX, float &maxX, float &minY, float &maxY, float &minZ, float &maxZ )
1039{
1040 const QVector3D cameraPos = camera->position();
1041 const QMatrix4x4 projectionMatrix = camera->projectionMatrix();
1042 const QMatrix4x4 viewMatrix = camera->viewMatrix();
1043 float depth = 1.0f;
1044 QVector4D viewCenter = viewMatrix * QVector4D( camera->viewCenter(), 1.0f );
1045 viewCenter /= viewCenter.w();
1046 viewCenter = projectionMatrix * viewCenter;
1047 viewCenter /= viewCenter.w();
1048 depth = viewCenter.z();
1049 QVector<QVector3D> viewFrustumPoints = {
1050 QVector3D( 0.0f, 0.0f, depth ),
1051 QVector3D( 0.0f, 1.0f, depth ),
1052 QVector3D( 1.0f, 0.0f, depth ),
1053 QVector3D( 1.0f, 1.0f, depth ),
1054 QVector3D( 0.0f, 0.0f, 0 ),
1055 QVector3D( 0.0f, 1.0f, 0 ),
1056 QVector3D( 1.0f, 0.0f, 0 ),
1057 QVector3D( 1.0f, 1.0f, 0 )
1058 };
1059 maxX = std::numeric_limits<float>::lowest();
1060 maxY = std::numeric_limits<float>::lowest();
1061 maxZ = std::numeric_limits<float>::lowest();
1062 minX = std::numeric_limits<float>::max();
1063 minY = std::numeric_limits<float>::max();
1064 minZ = std::numeric_limits<float>::max();
1065 for ( int i = 0; i < viewFrustumPoints.size(); ++i )
1066 {
1067 // convert from view port space to world space
1068 viewFrustumPoints[i] = viewFrustumPoints[i].unproject( viewMatrix, projectionMatrix, QRect( 0, 0, 1, 1 ) );
1069 minX = std::min( minX, viewFrustumPoints[i].x() );
1070 maxX = std::max( maxX, viewFrustumPoints[i].x() );
1071 minY = std::min( minY, viewFrustumPoints[i].y() );
1072 maxY = std::max( maxY, viewFrustumPoints[i].y() );
1073 minZ = std::min( minZ, viewFrustumPoints[i].z() );
1074 maxZ = std::max( maxZ, viewFrustumPoints[i].z() );
1075 // find the intersection between the line going from cameraPos to the frustum quad point
1076 // and the horizontal plane Z=z
1077 // if the intersection is on the back side of the viewing panel we get a point that is
1078 // maxRenderingDistance units in front of the camera
1079 const QVector3D pt = cameraPos;
1080 const QVector3D vect = ( viewFrustumPoints[i] - pt ).normalized();
1081 float t = ( z - pt.z() ) / vect.z();
1082 if ( t < 0 )
1083 t = maxRenderingDistance;
1084 else
1085 t = std::min( t, maxRenderingDistance );
1086 viewFrustumPoints[i] = pt + t * vect;
1087 minX = std::min( minX, viewFrustumPoints[i].x() );
1088 maxX = std::max( maxX, viewFrustumPoints[i].x() );
1089 minY = std::min( minY, viewFrustumPoints[i].y() );
1090 maxY = std::max( maxY, viewFrustumPoints[i].y() );
1091 minZ = std::min( minZ, viewFrustumPoints[i].z() );
1092 maxZ = std::max( maxZ, viewFrustumPoints[i].z() );
1093 }
1094}
1095
1096QList<QVector4D> Qgs3DUtils::lineSegmentToClippingPlanes( const QgsVector3D &startPoint, const QgsVector3D &endPoint, const double distance, const QgsVector3D &origin )
1097{
1098 // return empty vector if distance is negative
1099 if ( distance < 0 )
1100 return QList<QVector4D>();
1101
1102 QgsVector3D lineDirection( endPoint - startPoint );
1103 lineDirection.normalize();
1104 const QgsVector lineDirection2DPerp = QgsVector( lineDirection.x(), lineDirection.y() ).perpVector();
1105 const QgsVector3D linePerp( lineDirection2DPerp.x(), lineDirection2DPerp.y(), 0 );
1106
1107 QList<QVector4D> clippingPlanes;
1108 QgsVector3D planePoint;
1109 double originDistance;
1110
1111 // the naming is assigned according to line direction
1113 planePoint = startPoint;
1114 originDistance = QgsVector3D::dotProduct( planePoint - origin, lineDirection );
1115 clippingPlanes << QVector4D( static_cast<float>( lineDirection.x() ), static_cast<float>( lineDirection.y() ), 0, static_cast<float>( -originDistance ) );
1116
1118 planePoint = startPoint + linePerp * distance;
1119 originDistance = QgsVector3D::dotProduct( planePoint - origin, -linePerp );
1120 clippingPlanes << QVector4D( static_cast<float>( -linePerp.x() ), static_cast<float>( -linePerp.y() ), 0, static_cast<float>( -originDistance ) );
1121
1123 planePoint = endPoint;
1124 originDistance = QgsVector3D::dotProduct( planePoint - origin, -lineDirection );
1125 clippingPlanes << QVector4D( static_cast<float>( -lineDirection.x() ), static_cast<float>( -lineDirection.y() ), 0, static_cast<float>( -originDistance ) );
1126
1128 planePoint = startPoint - linePerp * distance;
1129 originDistance = QgsVector3D::dotProduct( planePoint - origin, linePerp );
1130 clippingPlanes << QVector4D( static_cast<float>( linePerp.x() ), static_cast<float>( linePerp.y() ), 0, static_cast<float>( -originDistance ) );
1131
1132 return clippingPlanes;
1133}
1134
1135QgsCameraPose Qgs3DUtils::lineSegmentToCameraPose( const QgsVector3D &startPoint, const QgsVector3D &endPoint, const QgsDoubleRange &elevationRange, const float fieldOfView, const QgsVector3D &worldOrigin )
1136{
1137 QgsCameraPose cameraPose;
1138 // we tilt the view slightly to see flat layers if the elevationRange is infinite (scene has flat terrain, vector layers...)
1139 elevationRange.isInfinite() ? cameraPose.setPitchAngle( 89 ) : cameraPose.setPitchAngle( 90 );
1140
1141 // calculate the middle of the front side defined by clipping planes
1142 QgsVector linePerpVec( ( endPoint - startPoint ).x(), ( endPoint - startPoint ).y() );
1143 linePerpVec = -linePerpVec.normalized().perpVector();
1144 const QgsVector3D linePerpVec3D( linePerpVec.x(), linePerpVec.y(), 0 );
1145 QgsVector3D middle( startPoint + ( endPoint - startPoint ) / 2 );
1146
1147 double elevationRangeHalf;
1148 elevationRange.isInfinite() ? elevationRangeHalf = 0 : elevationRangeHalf = ( elevationRange.upper() - elevationRange.lower() ) / 2;
1149 const double side = std::max( middle.distance( startPoint ), elevationRangeHalf );
1150 const double distance = ( side / std::tan( fieldOfView / 2 * M_PI / 180 ) ) * 1.05;
1151 cameraPose.setDistanceFromCenterPoint( static_cast<float>( distance ) );
1152
1153 elevationRange.isInfinite() ? middle.setZ( 0 ) : middle.setZ( elevationRange.lower() + ( elevationRange.upper() - elevationRange.lower() ) / 2 );
1154 cameraPose.setCenterPoint( mapToWorldCoordinates( middle, worldOrigin ) );
1155
1156 const QgsVector3D northDirectionVec( 0, -1, 0 );
1157 // calculate the angle between vector pointing to the north and vector pointing from the front side of clipped area
1158 float yawAngle = static_cast<float>( acos( QgsVector3D::dotProduct( linePerpVec3D, northDirectionVec ) ) * 180 / M_PI );
1159 // check if the angle between the view point is to the left or right of the scene north, apply angle offset if necessary for camera
1160 if ( QgsVector3D::crossProduct( linePerpVec3D, northDirectionVec ).z() > 0 )
1161 {
1162 yawAngle = 360 - yawAngle;
1163 }
1164 cameraPose.setHeadingAngle( yawAngle );
1165
1166 return cameraPose;
1167}
AltitudeClamping
Altitude clamping.
Definition qgis.h:3833
@ Relative
Elevation is relative to terrain height (final elevation = terrain elevation + feature elevation)
@ Terrain
Elevation is clamped to terrain (final elevation = terrain elevation)
@ Absolute
Elevation is taken directly from feature and is independent of terrain height (final elevation = feat...
AltitudeBinding
Altitude binding.
Definition qgis.h:3846
@ Centroid
Clamp just centroid of feature.
@ Vertex
Clamp every vertex of feature.
Holds information about animation in 3D view.
Keyframe interpolate(float time) const
Interpolates camera position and rotation at the given point in time.
float duration() const
Returns duration of the whole animation in seconds.
Keyframes keyFrames() const
Returns keyframes of the animation.
Entity that encapsulates our 3D scene - contains all other entities (such as terrain) as children.
QgsGlobeEntity * globeEntity()
Returns globe entity (may be nullptr if not using globe scene, terrain rendering is disabled or when ...
QgsCameraController * cameraController() const
Returns camera controller.
@ Ready
The scene is fully loaded/updated.
QgsTerrainEntity * terrainEntity()
Returns terrain entity (may be nullptr if using globe scene, terrain rendering is disabled or when te...
Qt3DCore::QEntity * layerEntity(QgsMapLayer *layer) const
Returns the entity belonging to layer.
void sceneStateChanged()
Emitted when the scene's state has changed.
SceneState sceneState() const
Returns the current state of the scene.
QList< QgsMapLayer * > layers() const
Returns the layers that contain chunked entities.
Definition of the world.
QgsVector3D origin() const
Returns coordinates in map CRS at which 3D scene has origin (0,0,0).
Rendering context for preparation of 3D entities.
const QgsAbstractTerrainSettings * terrainSettings() const
Returns the terrain settings.
QgsTerrainGenerator * terrainGenerator() const
Returns the terrain generator.
bool terrainRenderingEnabled() const
Returns whether the 2D terrain surface will be rendered.
static const char * PROP_NAME_3D_RENDERER_FLAG
Qt property name to hold the 3D geometry renderer flag.
Definition qgs3dtypes.h:43
CullingMode
Triangle culling mode.
Definition qgs3dtypes.h:35
@ FrontAndBack
Will not render anything.
Definition qgs3dtypes.h:39
@ NoCulling
Will render both front and back faces of triangles.
Definition qgs3dtypes.h:36
@ Front
Will render only back faces of triangles.
Definition qgs3dtypes.h:37
@ Back
Will render only front faces of triangles (recommended when input data are consistent)
Definition qgs3dtypes.h:38
static QgsVector3D transformWorldCoordinates(const QgsVector3D &worldPoint1, const QgsVector3D &origin1, const QgsCoordinateReferenceSystem &crs1, const QgsVector3D &origin2, const QgsCoordinateReferenceSystem &crs2, const QgsCoordinateTransformContext &context)
Transforms a world point from (origin1, crs1) to (origin2, crs2)
static QQuaternion rotationFromPitchHeadingAngles(float pitchAngle, float headingAngle)
Returns rotation quaternion that performs rotation around X axis by pitchAngle, followed by rotation ...
static QByteArray removeDefinesFromShaderCode(const QByteArray &shaderCode, const QStringList &defines)
Removes some define macros from a shader source code.
static Qt3DRender::QCullFace::CullingMode qt3DcullingMode(Qgs3DTypes::CullingMode mode)
Converts Qgs3DTypes::CullingMode mode into its Qt3D equivalent.
static QList< QVector4D > lineSegmentToClippingPlanes(const QgsVector3D &startPoint, const QgsVector3D &endPoint, double distance, const QgsVector3D &origin)
Returns a list of 4 planes derived from a line extending from startPoint to endPoint.
static Qgs3DTypes::CullingMode cullingModeFromString(const QString &str)
Converts a string to a value from CullingMode enum.
static Qgis::AltitudeClamping altClampingFromString(const QString &str)
Converts a string to a value from AltitudeClamping enum.
static QString matrix4x4toString(const QMatrix4x4 &m)
Converts a 4x4 transform matrix to a string.
static QgsRectangle worldToMapExtent(const QgsAABB &bbox, const QgsVector3D &mapOrigin)
Converts axis aligned bounding box in 3D world coordinates to extent in map coordinates.
static QgsRectangle worldToLayerExtent(const QgsAABB &bbox, const QgsCoordinateReferenceSystem &layerCrs, const QgsVector3D &mapOrigin, const QgsCoordinateReferenceSystem &mapCrs, const QgsCoordinateTransformContext &context)
Converts axis aligned bounding box in 3D world coordinates to extent in map layer CRS.
static void pitchAndYawFromViewVector(QVector3D vect, double &pitch, double &yaw)
Function used to extract the pitch and yaw (also known as heading) angles in degrees from the view ve...
static void decomposeTransformMatrix(const QMatrix4x4 &matrix, QVector3D &translation, QQuaternion &rotation, QVector3D &scale)
Tries to decompose a 4x4 transform matrix into translation, rotation and scale components.
static int maxZoomLevel(double tile0width, double tileResolution, double maxError)
Calculates the highest needed zoom level for tiles in quad-tree given width of the base tile (zoom le...
static QgsAABB mapToWorldExtent(const QgsRectangle &extent, double zMin, double zMax, const QgsVector3D &mapOrigin)
Converts map extent to axis aligned bounding box in 3D world coordinates.
static QgsAABB layerToWorldExtent(const QgsRectangle &extent, double zMin, double zMax, const QgsCoordinateReferenceSystem &layerCrs, const QgsVector3D &mapOrigin, const QgsCoordinateReferenceSystem &mapCrs, const QgsCoordinateTransformContext &context)
Converts extent (in map layer's CRS) to axis aligned bounding box in 3D world coordinates.
static Qgis::AltitudeBinding altBindingFromString(const QString &str)
Converts a string to a value from AltitudeBinding enum.
static double calculateEntityGpuMemorySize(Qt3DCore::QEntity *entity)
Calculates approximate usage of GPU memory by an entity.
static QString cullingModeToString(Qgs3DTypes::CullingMode mode)
Converts a value from CullingMode enum to a string.
static QHash< QgsMapLayer *, QVector< QgsRayCastingUtils::RayHit > > castRay(Qgs3DMapScene *scene, const QgsRay3D &ray, const QgsRayCastingUtils::RayCastContext &context)
Casts a ray through the scene and returns information about the intersecting entities (ray uses World...
static bool isCullable(const QgsAABB &bbox, const QMatrix4x4 &viewProjectionMatrix)
Returns true if bbox is completely outside the current viewing volume.
static QVector2D screenToTextureCoordinates(QVector2D screenXY, QSize winSize)
Converts from screen coordinates to texture coordinates.
static float screenSpaceError(float epsilon, float distance, int screenSize, float fov)
This routine approximately calculates how an error (epsilon) of an object in world coordinates at giv...
static void estimateVectorLayerZRange(QgsVectorLayer *layer, double &zMin, double &zMax)
Try to estimate range of Z values used in the given vector layer and store that in zMin and zMax.
static QgsPoint screenPointToMapCoordinates(const QPoint &screenPoint, QSize size, const QgsCameraController *cameraController, const Qgs3DMapSettings *mapSettings)
Transform the given screen point to QgsPoint in map coordinates.
static QgsPhongMaterialSettings phongMaterialFromQt3DComponent(Qt3DExtras::QPhongMaterial *material)
Returns phong material settings object based on the Qt3D material.
static QString altClampingToString(Qgis::AltitudeClamping altClamp)
Converts a value from AltitudeClamping enum to a string.
static QgsRectangle tryReprojectExtent2D(const QgsRectangle &extent, const QgsCoordinateReferenceSystem &crs1, const QgsCoordinateReferenceSystem &crs2, const QgsCoordinateTransformContext &context)
Reprojects extent from crs1 to crs2 coordinate reference system with context context.
static QByteArray addDefinesToShaderCode(const QByteArray &shaderCode, const QStringList &defines)
Inserts some define macros into a shader source code.
static QMatrix4x4 stringToMatrix4x4(const QString &str)
Convert a string to a 4x4 transform matrix.
static QgsVector3D worldToMapCoordinates(const QgsVector3D &worldCoords, const QgsVector3D &origin)
Converts 3D world coordinates to map coordinates (applies offset)
static QgsVector3D mapToWorldCoordinates(const QgsVector3D &mapCoords, const QgsVector3D &origin)
Converts map coordinates to 3D world coordinates (applies offset)
static QVector2D textureToScreenCoordinates(QVector2D textureXY, QSize winSize)
Converts from texture coordinates coordinates to screen coordinates.
static void computeBoundingBoxNearFarPlanes(const QgsAABB &bbox, const QMatrix4x4 &viewMatrix, float &fnear, float &ffar)
This routine computes nearPlane farPlane from the closest and farthest corners point of bounding box ...
static bool exportAnimation(const Qgs3DAnimationSettings &animationSettings, Qgs3DMapSettings &mapSettings, int framesPerSecond, const QString &outputDirectory, const QString &fileNameTemplate, const QSize &outputSize, QString &error, QgsFeedback *feedback=nullptr)
Captures 3D animation frames to the selected folder.
static QVector3D screenPointToWorldPos(const QPoint &screenPoint, double depth, const QSize &screenSize, Qt3DRender::QCamera *camera)
Converts the clicked mouse position to the corresponding 3D world coordinates.
static void waitForFrame(QgsAbstract3DEngine &engine, Qgs3DMapScene *scene)
Waits for a frame to be rendered.
static float clampAltitude(const QgsPoint &p, Qgis::AltitudeClamping altClamp, Qgis::AltitudeBinding altBind, float offset, const QgsPoint &centroid, const Qgs3DRenderContext &context)
Clamps altitude of a vertex according to the settings, returns Z value.
static QString altBindingToString(Qgis::AltitudeBinding altBind)
Converts a value from AltitudeBinding enum to a string.
static void clampAltitudes(QgsLineString *lineString, Qgis::AltitudeClamping altClamp, Qgis::AltitudeBinding altBind, const QgsPoint &centroid, float offset, const Qgs3DRenderContext &context)
Clamps altitude of vertices of a linestring according to the settings.
static QgsRay3D rayFromScreenPoint(const QPoint &point, const QSize &windowSize, Qt3DRender::QCamera *camera)
Convert from clicked point on the screen to a ray in world coordinates.
static QImage captureSceneImage(QgsAbstract3DEngine &engine, Qgs3DMapScene *scene)
Captures image of the current 3D scene of a 3D engine.
static QgsCameraPose lineSegmentToCameraPose(const QgsVector3D &startPoint, const QgsVector3D &endPoint, const QgsDoubleRange &elevationRange, float fieldOfView, const QgsVector3D &worldOrigin)
Returns the camera pose for a camera looking at mid-point between startPoint and endPoint.
static void calculateViewExtent(const Qt3DRender::QCamera *camera, float maxRenderingDistance, float z, float &minX, float &maxX, float &minY, float &maxY, float &minZ, float &maxZ)
Computes the portion of the Y=y plane the camera is looking at.
static std::unique_ptr< QgsPointCloudLayer3DRenderer > convert2DPointCloudRendererTo3D(QgsPointCloudRenderer *renderer)
Creates a QgsPointCloudLayer3DRenderer matching the symbol settings of a given QgsPointCloudRenderer.
static void extractPointPositions(const QgsFeature &f, const Qgs3DRenderContext &context, const QgsVector3D &chunkOrigin, Qgis::AltitudeClamping altClamp, QVector< QVector3D > &positions)
Calculates (x,y,z) positions of (multi)point from the given feature.
static QImage captureSceneDepthBuffer(QgsAbstract3DEngine &engine, Qgs3DMapScene *scene)
Captures the depth buffer of the current 3D scene of a 3D engine.
static int openGlMaxClipPlanes(QSurface *surface)
Gets the maximum number of clip planes that can be used.
static QgsExpressionContext globalProjectLayerExpressionContext(QgsVectorLayer *layer)
Returns expression context for use in preparation of 3D data of a layer.
Axis-aligned bounding box - in world coords.
Definition qgsaabb.h:35
float yMax
Definition qgsaabb.h:102
float xMax
Definition qgsaabb.h:101
float xMin
Definition qgsaabb.h:98
float zMax
Definition qgsaabb.h:103
float yMin
Definition qgsaabb.h:99
float zMin
Definition qgsaabb.h:100
Base class for 3D engine implementation.
void requestCaptureImage()
Starts a request for an image rendered by the engine.
void requestDepthBufferCapture()
Starts a request for an image containing the depth buffer data of the engine.
void imageCaptured(const QImage &image)
Emitted after a call to requestCaptureImage() to return the captured image.
void depthBufferCaptured(const QImage &image)
Emitted after a call to requestDepthBufferCapture() to return the captured depth buffer.
virtual Qt3DRender::QRenderSettings * renderSettings()=0
Returns access to the engine's render settings (the frame graph can be accessed from here)
Abstract base class for all geometries.
vertex_iterator vertices_end() const
Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry.
bool is3D() const
Returns true if the geometry is 3D and contains a z-value.
vertex_iterator vertices_begin() const
Returns STL-style iterator pointing to the first vertex of the geometry.
virtual QgsPoint centroid() const
Returns the centroid of the geometry.
double verticalScale() const
Returns the vertical scale (exaggeration) for terrain.
A 3-dimensional box composed of x, y, z coordinates.
Definition qgsbox3d.h:43
double yMaximum() const
Returns the maximum y value.
Definition qgsbox3d.h:231
double xMinimum() const
Returns the minimum x value.
Definition qgsbox3d.h:196
double zMaximum() const
Returns the maximum z value.
Definition qgsbox3d.h:259
double xMaximum() const
Returns the maximum x value.
Definition qgsbox3d.h:203
double zMinimum() const
Returns the minimum z value.
Definition qgsbox3d.h:252
double yMinimum() const
Returns the minimum y value.
Definition qgsbox3d.h:224
Object that controls camera movement based on user input.
Qt3DRender::QCamera * camera() const
Returns camera that is being controlled.
void setLookingAtPoint(const QgsVector3D &point, float distance, float pitch, float yaw)
Sets the complete camera configuration: the point towards it is looking (in 3D world coordinates),...
Encapsulates camera pose in a 3D scene.
void setPitchAngle(float pitch)
Sets pitch angle in degrees.
void setCenterPoint(const QgsVector3D &point)
Sets center point (towards which point the camera is looking)
void setHeadingAngle(float heading)
Sets heading (yaw) angle in degrees.
void setDistanceFromCenterPoint(float distance)
Sets distance of the camera from the center point.
3D symbol that draws point cloud geometries as 3D objects using classification of the dataset.
void setCategoriesList(const QgsPointCloudCategoryList &categories)
Sets the list of categories of the classification.
void setAttribute(const QString &attribute)
Sets the attribute used to select the color of the point cloud.
3D symbol that draws point cloud geometries as 3D objects using color ramp shader.
void setAttribute(const QString &attribute)
Sets the attribute used to select the color of the point cloud.
void setColorRampShaderMinMax(double min, double max)
Sets the minimum and maximum values used when classifying colors in the color ramp shader.
void setColorRampShader(const QgsColorRampShader &colorRampShader)
Sets the color ramp shader used to render the point cloud.
Handles contrast enhancement and clipping.
Represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
Handles coordinate transforms between two coordinate systems.
void setBallparkTransformsAreAppropriate(bool appropriate)
Sets whether approximate "ballpark" results are appropriate for this coordinate transform.
QgsPointXY transform(const QgsPointXY &point, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward) const
Transform the point from the source CRS to the destination CRS.
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.
int numInteriorRings() const
Returns the number of interior rings contained with the curve polygon.
bool addZValue(double zValue=0) override
Adds a z-dimension to the geometry, initialized to a preset value.
const QgsCurve * exteriorRing() const
Returns the curve polygon's exterior ring.
const QgsCurve * interiorRing(int i) const
Retrieves an interior ring from the curve polygon.
Abstract base class for curved geometry type.
Definition qgscurve.h:35
QgsRange which stores a range of double values.
Definition qgsrange.h:233
bool isInfinite() const
Returns true if the range consists of all possible values.
Definition qgsrange.h:287
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
Wraps a request for features to a vector layer (or directly its vector data provider).
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
QgsGeometry geometry
Definition qgsfeature.h:69
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
bool isCanceled() const
Tells whether the operation has been canceled already.
Definition qgsfeedback.h:53
void setProgress(double progress)
Sets the current progress for the feedback object.
Definition qgsfeedback.h:61
A geometry is the spatial representation of a feature.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
QgsAbstractGeometry::vertex_iterator vertices_begin() const
Returns STL-style iterator pointing to the first vertex of the geometry.
QgsAbstractGeometry::vertex_iterator vertices_end() const
Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry.
Line string geometry type, with support for z-dimension and m-values.
int nCoordinates() const override
Returns the number of nodes contained in the geometry.
double yAt(int index) const override
Returns the y-coordinate of the specified node in the line string.
void setZAt(int index, double z)
Sets the z-coordinate of the specified node in the line string.
double zAt(int index) const override
Returns the z-coordinate of the specified node in the line string.
double xAt(int index) const override
Returns the x-coordinate of the specified node in the line string.
Base class for all map layer types.
Definition qgsmaplayer.h:77
Off-screen 3D engine implementation.
void setSize(QSize s) override
Sets the size of the rendering area (in pixels)
void setRootEntity(Qt3DCore::QEntity *root) override
Sets root entity of the 3D scene.
Qt3DRender::QRenderSettings * renderSettings() override
Returns access to the engine's render settings (the frame graph can be accessed from here)
Basic shading material used for rendering based on the Phong shading model with three color component...
void setDiffuse(const QColor &diffuse)
Sets diffuse color component.
void setShininess(double shininess)
Sets shininess of the surface.
void setAmbient(const QColor &ambient)
Sets ambient color component.
void setSpecular(const QColor &specular)
Sets specular color component.
An RGB renderer for 2d visualisation of point clouds using embedded red, green and blue attributes.
double maximum() const
Returns the maximum value for attributes which will be used by the color ramp shader.
QgsColorRampShader colorRampShader() const
Returns the color ramp shader function used to visualize the attribute.
double minimum() const
Returns the minimum value for attributes which will be used by the color ramp shader.
QString attribute() const
Returns the attribute to use for the renderer.
Renders point clouds by a classification attribute.
QString attribute() const
Returns the attribute to use for the renderer.
QgsPointCloudCategoryList categories() const
Returns the classification categories used for rendering.
Abstract base class for 2d point cloud renderers.
virtual QString type() const =0
Returns the identifier of the renderer type.
An RGB renderer for 2d visualisation of point clouds using embedded red, green and blue attributes.
QString redAttribute() const
Returns the attribute to use for the red channel.
QString greenAttribute() const
Returns the attribute to use for the green channel.
const QgsContrastEnhancement * greenContrastEnhancement() const
Returns the contrast enhancement to use for the green channel.
QString blueAttribute() const
Returns the attribute to use for the blue channel.
const QgsContrastEnhancement * blueContrastEnhancement() const
Returns the contrast enhancement to use for the blue channel.
const QgsContrastEnhancement * redContrastEnhancement() const
Returns the contrast enhancement to use for the red channel.
Represents a 2D point.
Definition qgspointxy.h:60
void setY(double y)
Sets the y value of the point.
Definition qgspointxy.h:129
void set(double x, double y)
Sets the x and y value of the point.
Definition qgspointxy.h:136
double y
Definition qgspointxy.h:64
double x
Definition qgspointxy.h:63
void setX(double x)
Sets the x value of the point.
Definition qgspointxy.h:119
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:49
double z
Definition qgspoint.h:54
double x
Definition qgspoint.h:52
double y
Definition qgspoint.h:53
Polygon geometry type.
Definition qgspolygon.h:33
static QgsProject * instance()
Returns the QgsProject singleton instance.
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
A representation of a ray in 3D.
Definition qgsray3d.h:31
QVector3D origin() const
Returns the origin of the ray.
Definition qgsray3d.h:44
QVector3D direction() const
Returns the direction of the ray see setDirection()
Definition qgsray3d.h:50
A rectangle specified with double values.
Q_INVOKABLE QString toString(int precision=16) const
Returns a string representation of form xmin,ymin : xmax,ymax Coordinates will be truncated to the sp...
double xMinimum
double yMinimum
double xMaximum
double yMaximum
3D symbol that draws point cloud geometries as 3D objects using RGB colors in the dataset.
void setBlueAttribute(const QString &attribute)
Sets the attribute to use for the blue channel.
void setGreenContrastEnhancement(QgsContrastEnhancement *enhancement SIP_TRANSFER)
Sets the contrast enhancement to use for the green channel.
void setGreenAttribute(const QString &attribute)
Sets the attribute to use for the green channel.
void setBlueContrastEnhancement(QgsContrastEnhancement *enhancement SIP_TRANSFER)
Sets the contrast enhancement to use for the blue channel.
void setRedContrastEnhancement(QgsContrastEnhancement *enhancement SIP_TRANSFER)
Sets the contrast enhancement to use for the red channel.
void setRedAttribute(const QString &attribute)
Sets the attribute to use for the red channel.
virtual float heightAt(double x, double y, const Qgs3DRenderContext &context) const
Returns height at (x,y) in map's CRS.
A 3D vector (similar to QVector3D) with the difference that it uses double precision instead of singl...
Definition qgsvector3d.h:30
double y() const
Returns Y coordinate.
Definition qgsvector3d.h:49
double z() const
Returns Z coordinate.
Definition qgsvector3d.h:51
void setZ(double z)
Sets Z coordinate.
Definition qgsvector3d.h:69
double distance(const QgsVector3D &other) const
Returns the distance with the other QgsVector3D.
static double dotProduct(const QgsVector3D &v1, const QgsVector3D &v2)
Returns the dot product of two vectors.
double x() const
Returns X coordinate.
Definition qgsvector3d.h:47
void normalize()
Normalizes the current vector in place.
static QgsVector3D crossProduct(const QgsVector3D &v1, const QgsVector3D &v2)
Returns the cross product of two vectors.
void set(double x, double y, double z)
Sets vector coordinates.
Definition qgsvector3d.h:72
Represents a vector layer which manages a vector based dataset.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
Represent a 2-dimensional vector.
Definition qgsvector.h:30
double y() const
Returns the vector's y-component.
Definition qgsvector.h:152
QgsVector normalized() const
Returns the vector's normalized (or "unit") vector (ie same angle but length of 1....
Definition qgsvector.cpp:28
QgsVector perpVector() const
Returns the perpendicular vector to this vector (rotated 90 degrees counter-clockwise)
Definition qgsvector.h:160
double x() const
Returns the vector's x-component.
Definition qgsvector.h:143
static bool hasZ(Qgis::WkbType type)
Tests whether a WKB type contains the z-dimension.
#define BUILTIN_UNREACHABLE
Definition qgis.h:6896
Qt3DCore::QBuffer Qt3DQBuffer
Qt3DCore::QBuffer Qt3DQBuffer
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:41
#define QgsDebugError(str)
Definition qgslogger.h:40
float pitch
Tilt of the camera in degrees (0 = looking from the top, 90 = looking from the side,...
float yaw
Horizontal rotation around the focal point in degrees.
QgsVector3D point
Point towards which the camera is looking in 3D world coords.
float dist
Distance of the camera from the focal point.
Helper struct to store ray casting parameters.
float maxDistance
The maximum distance from ray origin to look for hits when casting a ray.