QGIS API Documentation 3.43.0-Master (4da382ed187)
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#if !defined( Q_OS_MAC )
53#include <GL/gl.h>
54#endif
55
56#if QT_VERSION < QT_VERSION_CHECK( 6, 0, 0 )
57#include <Qt3DRender/QBuffer>
58typedef Qt3DRender::QBuffer Qt3DQBuffer;
59#else
60#include <Qt3DCore/QBuffer>
61typedef Qt3DCore::QBuffer Qt3DQBuffer;
62#endif
63
64// declared here as Qgs3DTypes has no cpp file
65const char *Qgs3DTypes::PROP_NAME_3D_RENDERER_FLAG = "PROP_NAME_3D_RENDERER_FLAG";
66
68{
69 // Set policy to always render frame, so we don't wait forever.
70 Qt3DRender::QRenderSettings::RenderPolicy oldPolicy = engine.renderSettings()->renderPolicy();
71 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::Always );
72
73 // Wait for at least one frame to render
74 Qt3DLogic::QFrameAction *frameAction = new Qt3DLogic::QFrameAction();
75 scene->addComponent( frameAction );
76 QEventLoop evLoop;
77 QObject::connect( frameAction, &Qt3DLogic::QFrameAction::triggered, &evLoop, &QEventLoop::quit );
78 evLoop.exec();
79 scene->removeComponent( frameAction );
80 frameAction->deleteLater();
81
82 engine.renderSettings()->setRenderPolicy( oldPolicy );
83}
84
86{
87 QImage resImage;
88 QEventLoop evLoop;
89
90 // We need to change render policy to RenderPolicy::Always, since otherwise render capture node won't work
91 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::Always );
92
93 waitForFrame( engine, scene );
94
95 auto saveImageFcn = [&evLoop, &resImage]( const QImage &img ) {
96 resImage = img;
97 evLoop.quit();
98 };
99
100 const QMetaObject::Connection conn1 = QObject::connect( &engine, &QgsAbstract3DEngine::imageCaptured, saveImageFcn );
101 QMetaObject::Connection conn2;
102
103 auto requestImageFcn = [&engine, scene] {
104 if ( scene->sceneState() == Qgs3DMapScene::Ready )
105 {
106 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::OnDemand );
107 engine.requestCaptureImage();
108 }
109 };
110
111 if ( scene->sceneState() == Qgs3DMapScene::Ready )
112 {
113 requestImageFcn();
114 }
115 else
116 {
117 // first wait until scene is loaded
118 conn2 = QObject::connect( scene, &Qgs3DMapScene::sceneStateChanged, requestImageFcn );
119 }
120
121 evLoop.exec();
122
123 QObject::disconnect( conn1 );
124 if ( conn2 )
125 QObject::disconnect( conn2 );
126
127 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::OnDemand );
128 return resImage;
129}
130
132{
133 QImage resImage;
134 QEventLoop evLoop;
135
136 // We need to change render policy to RenderPolicy::Always, since otherwise render capture node won't work
137 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::Always );
138
139 auto requestImageFcn = [&engine, scene] {
140 if ( scene->sceneState() == Qgs3DMapScene::Ready )
141 {
142 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::OnDemand );
144 }
145 };
146
147 auto saveImageFcn = [&evLoop, &resImage]( const QImage &img ) {
148 resImage = img;
149 evLoop.quit();
150 };
151
152 QMetaObject::Connection conn1 = QObject::connect( &engine, &QgsAbstract3DEngine::depthBufferCaptured, saveImageFcn );
153 QMetaObject::Connection conn2;
154
155 // Make sure once-per-frame functions run
156 waitForFrame( engine, scene );
157 if ( scene->sceneState() == Qgs3DMapScene::Ready )
158 {
159 requestImageFcn();
160 }
161 else
162 {
163 // first wait until scene is loaded
164 conn2 = QObject::connect( scene, &Qgs3DMapScene::sceneStateChanged, requestImageFcn );
165 }
166
167 evLoop.exec();
168
169 QObject::disconnect( conn1 );
170 if ( conn2 )
171 QObject::disconnect( conn2 );
172
173 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::OnDemand );
174 return resImage;
175}
176
177
178double Qgs3DUtils::calculateEntityGpuMemorySize( Qt3DCore::QEntity *entity )
179{
180 long long usedGpuMemory = 0;
181 for ( Qt3DQBuffer *buffer : entity->findChildren<Qt3DQBuffer *>() )
182 {
183 usedGpuMemory += buffer->data().size();
184 }
185 for ( Qt3DRender::QTexture2D *tex : entity->findChildren<Qt3DRender::QTexture2D *>() )
186 {
187 // TODO : lift the assumption that the texture is RGBA
188 usedGpuMemory += tex->width() * tex->height() * 4;
189 }
190 return usedGpuMemory / 1024.0 / 1024.0;
191}
192
193
194bool Qgs3DUtils::exportAnimation( const Qgs3DAnimationSettings &animationSettings, Qgs3DMapSettings &mapSettings, int framesPerSecond, const QString &outputDirectory, const QString &fileNameTemplate, const QSize &outputSize, QString &error, QgsFeedback *feedback )
195{
196 if ( animationSettings.keyFrames().size() < 2 )
197 {
198 error = QObject::tr( "Unable to export 3D animation. Add at least 2 keyframes" );
199 return false;
200 }
201
202 const float duration = animationSettings.duration(); //in seconds
203 if ( duration <= 0 )
204 {
205 error = QObject::tr( "Unable to export 3D animation (invalid duration)." );
206 return false;
207 }
208
209 float time = 0;
210 int frameNo = 0;
211 const int totalFrames = static_cast<int>( duration * framesPerSecond );
212
213 if ( fileNameTemplate.isEmpty() )
214 {
215 error = QObject::tr( "Filename template is empty" );
216 return false;
217 }
218
219 const int numberOfDigits = fileNameTemplate.count( QLatin1Char( '#' ) );
220 if ( numberOfDigits < 0 )
221 {
222 error = QObject::tr( "Wrong filename template format (must contain #)" );
223 return false;
224 }
225 const QString token( numberOfDigits, QLatin1Char( '#' ) );
226 if ( !fileNameTemplate.contains( token ) )
227 {
228 error = QObject::tr( "Filename template must contain all # placeholders in one continuous group." );
229 return false;
230 }
231
232 if ( !QDir().exists( outputDirectory ) )
233 {
234 if ( !QDir().mkpath( outputDirectory ) )
235 {
236 error = QObject::tr( "Output directory could not be created." );
237 return false;
238 }
239 }
240
242 engine.setSize( outputSize );
243 Qgs3DMapScene *scene = new Qgs3DMapScene( mapSettings, &engine );
244 engine.setRootEntity( scene );
245 // We need to change render policy to RenderPolicy::Always, since otherwise render capture node won't work
246 engine.renderSettings()->setRenderPolicy( Qt3DRender::QRenderSettings::RenderPolicy::Always );
247
248 while ( time <= duration )
249 {
250 if ( feedback )
251 {
252 if ( feedback->isCanceled() )
253 {
254 error = QObject::tr( "Export canceled" );
255 return false;
256 }
257 feedback->setProgress( frameNo / static_cast<double>( totalFrames ) * 100 );
258 }
259 ++frameNo;
260
261 const Qgs3DAnimationSettings::Keyframe kf = animationSettings.interpolate( time );
262 scene->cameraController()->setLookingAtMapPoint( kf.point, kf.dist, kf.pitch, kf.yaw );
263
264 QString fileName( fileNameTemplate );
265 const QString frameNoPaddedLeft( QStringLiteral( "%1" ).arg( frameNo, numberOfDigits, 10, QChar( '0' ) ) ); // e.g. 0001
266 fileName.replace( token, frameNoPaddedLeft );
267 const QString path = QDir( outputDirectory ).filePath( fileName );
268
269 const QImage img = Qgs3DUtils::captureSceneImage( engine, scene );
270
271 img.save( path );
272
273 time += 1.0f / static_cast<float>( framesPerSecond );
274 }
275
276 return true;
277}
278
279
280int Qgs3DUtils::maxZoomLevel( double tile0width, double tileResolution, double maxError )
281{
282 if ( maxError <= 0 || tileResolution <= 0 || tile0width <= 0 )
283 return 0; // invalid input
284
285 // derived from:
286 // tile width [map units] = tile0width / 2^zoomlevel
287 // tile error [map units] = tile width / tile resolution
288 // + re-arranging to get zoom level if we know tile error we want to get
289 const double zoomLevel = -log( tileResolution * maxError / tile0width ) / log( 2 );
290 return round( zoomLevel ); // we could use ceil() here if we wanted to always get to the desired error
291}
292
294{
295 switch ( altClamp )
296 {
298 return QStringLiteral( "absolute" );
300 return QStringLiteral( "relative" );
302 return QStringLiteral( "terrain" );
303 }
305}
306
307
309{
310 if ( str == QLatin1String( "absolute" ) )
312 else if ( str == QLatin1String( "terrain" ) )
314 else // "relative" (default)
316}
317
318
320{
321 switch ( altBind )
322 {
324 return QStringLiteral( "vertex" );
326 return QStringLiteral( "centroid" );
327 }
329}
330
331
333{
334 if ( str == QLatin1String( "vertex" ) )
336 else // "centroid" (default)
338}
339
341{
342 switch ( mode )
343 {
345 return QStringLiteral( "no-culling" );
347 return QStringLiteral( "front" );
348 case Qgs3DTypes::Back:
349 return QStringLiteral( "back" );
351 return QStringLiteral( "front-and-back" );
352 }
354}
355
357{
358 if ( str == QLatin1String( "front" ) )
359 return Qgs3DTypes::Front;
360 else if ( str == QLatin1String( "back" ) )
361 return Qgs3DTypes::Back;
362 else if ( str == QLatin1String( "front-and-back" ) )
364 else
366}
367
368float Qgs3DUtils::clampAltitude( const QgsPoint &p, Qgis::AltitudeClamping altClamp, Qgis::AltitudeBinding altBind, float offset, const QgsPoint &centroid, const Qgs3DRenderContext &context )
369{
370 float terrainZ = 0;
371 switch ( altClamp )
372 {
375 {
376 const QgsPointXY pt = altBind == Qgis::AltitudeBinding::Vertex ? p : centroid;
377 terrainZ = context.terrainRenderingEnabled() && context.terrainGenerator() ? context.terrainGenerator()->heightAt( pt.x(), pt.y(), context ) : 0;
378 break;
379 }
380
382 break;
383 }
384
385 float geomZ = 0;
386 if ( p.is3D() )
387 {
388 switch ( altClamp )
389 {
392 geomZ = p.z();
393 break;
394
396 break;
397 }
398 }
399
400 const float z = ( terrainZ + geomZ ) * static_cast<float>( context.terrainSettings()->verticalScale() ) + offset;
401 return z;
402}
403
404void Qgs3DUtils::clampAltitudes( QgsLineString *lineString, Qgis::AltitudeClamping altClamp, Qgis::AltitudeBinding altBind, const QgsPoint &centroid, float offset, const Qgs3DRenderContext &context )
405{
406 for ( int i = 0; i < lineString->nCoordinates(); ++i )
407 {
408 float terrainZ = 0;
409 switch ( altClamp )
410 {
413 {
414 QgsPointXY pt;
415 switch ( altBind )
416 {
418 pt.setX( lineString->xAt( i ) );
419 pt.setY( lineString->yAt( i ) );
420 break;
421
423 pt.set( centroid.x(), centroid.y() );
424 break;
425 }
426
427 terrainZ = context.terrainRenderingEnabled() && context.terrainGenerator() ? context.terrainGenerator()->heightAt( pt.x(), pt.y(), context ) : 0;
428 break;
429 }
430
432 break;
433 }
434
435 float geomZ = 0;
436
437 switch ( altClamp )
438 {
441 geomZ = lineString->zAt( i );
442 break;
443
445 break;
446 }
447
448 const float z = ( terrainZ + geomZ ) * static_cast<float>( context.terrainSettings()->verticalScale() ) + offset;
449 lineString->setZAt( i, z );
450 }
451}
452
453
454bool Qgs3DUtils::clampAltitudes( QgsPolygon *polygon, Qgis::AltitudeClamping altClamp, Qgis::AltitudeBinding altBind, float offset, const Qgs3DRenderContext &context )
455{
456 if ( !polygon->is3D() )
457 polygon->addZValue( 0 );
458
459 QgsPoint centroid;
460 switch ( altBind )
461 {
463 break;
464
466 centroid = polygon->centroid();
467 break;
468 }
469
470 QgsCurve *curve = const_cast<QgsCurve *>( polygon->exteriorRing() );
471 QgsLineString *lineString = qgsgeometry_cast<QgsLineString *>( curve );
472 if ( !lineString )
473 return false;
474
475 clampAltitudes( lineString, altClamp, altBind, centroid, offset, context );
476
477 for ( int i = 0; i < polygon->numInteriorRings(); ++i )
478 {
479 QgsCurve *curve = const_cast<QgsCurve *>( polygon->interiorRing( i ) );
480 QgsLineString *lineString = qgsgeometry_cast<QgsLineString *>( curve );
481 if ( !lineString )
482 return false;
483
484 clampAltitudes( lineString, altClamp, altBind, centroid, offset, context );
485 }
486 return true;
487}
488
489
490QString Qgs3DUtils::matrix4x4toString( const QMatrix4x4 &m )
491{
492 const float *d = m.constData();
493 QStringList elems;
494 elems.reserve( 16 );
495 for ( int i = 0; i < 16; ++i )
496 elems << QString::number( d[i] );
497 return elems.join( ' ' );
498}
499
500QMatrix4x4 Qgs3DUtils::stringToMatrix4x4( const QString &str )
501{
502 QMatrix4x4 m;
503 float *d = m.data();
504 QStringList elems = str.split( ' ' );
505 for ( int i = 0; i < 16; ++i )
506 d[i] = elems[i].toFloat();
507 return m;
508}
509
510void Qgs3DUtils::extractPointPositions( const QgsFeature &f, const Qgs3DRenderContext &context, const QgsVector3D &chunkOrigin, Qgis::AltitudeClamping altClamp, QVector<QVector3D> &positions )
511{
512 const QgsAbstractGeometry *g = f.geometry().constGet();
513 for ( auto it = g->vertices_begin(); it != g->vertices_end(); ++it )
514 {
515 const QgsPoint pt = *it;
516 float geomZ = 0;
517 if ( pt.is3D() )
518 {
519 geomZ = pt.z();
520 }
521 const float terrainZ = context.terrainRenderingEnabled() && context.terrainGenerator() ? static_cast<float>( context.terrainGenerator()->heightAt( pt.x(), pt.y(), context ) * context.terrainSettings()->verticalScale() ) : 0.f;
522 float h = 0.0f;
523 switch ( altClamp )
524 {
526 h = geomZ;
527 break;
529 h = terrainZ;
530 break;
532 h = terrainZ + geomZ;
533 break;
534 }
535 positions.append( QVector3D(
536 static_cast<float>( pt.x() - chunkOrigin.x() ),
537 static_cast<float>( pt.y() - chunkOrigin.y() ),
538 h
539 ) );
540 QgsDebugMsgLevel( QStringLiteral( "%1 %2 %3" ).arg( positions.last().x() ).arg( positions.last().y() ).arg( positions.last().z() ), 2 );
541 }
542}
543
549static inline uint outcode( QVector4D v )
550{
551 // For a discussion of outcodes see pg 388 Dunn & Parberry.
552 // For why you can't just test if the point is in a bounding box
553 // consider the case where a view frustum with view-size 1.5 x 1.5
554 // is tested against a 2x2 box which encloses the near-plane, while
555 // all the points in the box are outside the frustum.
556 // TODO: optimise this with assembler - according to D&P this can
557 // be done in one line of assembler on some platforms
558 uint code = 0;
559 if ( v.x() < -v.w() )
560 code |= 0x01;
561 if ( v.x() > v.w() )
562 code |= 0x02;
563 if ( v.y() < -v.w() )
564 code |= 0x04;
565 if ( v.y() > v.w() )
566 code |= 0x08;
567 if ( v.z() < -v.w() )
568 code |= 0x10;
569 if ( v.z() > v.w() )
570 code |= 0x20;
571 return code;
572}
573
574
585bool Qgs3DUtils::isCullable( const QgsAABB &bbox, const QMatrix4x4 &viewProjectionMatrix )
586{
587 uint out = 0xff;
588
589 for ( int i = 0; i < 8; ++i )
590 {
591 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 );
592 const QVector4D pc = viewProjectionMatrix * p;
593
594 // if the logical AND of all the outcodes is non-zero then the BB is
595 // definitely outside the view frustum.
596 out = out & outcode( pc );
597 }
598 return out;
599}
600
602{
603 return QgsVector3D( mapCoords.x() - origin.x(), mapCoords.y() - origin.y(), mapCoords.z() - origin.z() );
604}
605
607{
608 return QgsVector3D( worldCoords.x() + origin.x(), worldCoords.y() + origin.y(), worldCoords.z() + origin.z() );
609}
610
612{
613 QgsRectangle extentMapCrs( extent );
614 if ( crs1 != crs2 )
615 {
616 // reproject if necessary
617 QgsCoordinateTransform ct( crs1, crs2, context );
619 try
620 {
621 extentMapCrs = ct.transformBoundingBox( extentMapCrs );
622 }
623 catch ( const QgsCsException & )
624 {
625 // bad luck, can't reproject for some reason
626 QgsDebugError( QStringLiteral( "3D utils: transformation of extent failed: " ) + extentMapCrs.toString( -1 ) );
627 }
628 }
629 return extentMapCrs;
630}
631
632QgsAABB Qgs3DUtils::layerToWorldExtent( const QgsRectangle &extent, double zMin, double zMax, const QgsCoordinateReferenceSystem &layerCrs, const QgsVector3D &mapOrigin, const QgsCoordinateReferenceSystem &mapCrs, const QgsCoordinateTransformContext &context )
633{
634 const QgsRectangle extentMapCrs( Qgs3DUtils::tryReprojectExtent2D( extent, layerCrs, mapCrs, context ) );
635 return mapToWorldExtent( extentMapCrs, zMin, zMax, mapOrigin );
636}
637
639{
640 const QgsRectangle extentMap = worldToMapExtent( bbox, mapOrigin );
641 return Qgs3DUtils::tryReprojectExtent2D( extentMap, mapCrs, layerCrs, context );
642}
643
644QgsAABB Qgs3DUtils::mapToWorldExtent( const QgsRectangle &extent, double zMin, double zMax, const QgsVector3D &mapOrigin )
645{
646 const QgsVector3D extentMin3D( extent.xMinimum(), extent.yMinimum(), zMin );
647 const QgsVector3D extentMax3D( extent.xMaximum(), extent.yMaximum(), zMax );
648 const QgsVector3D worldExtentMin3D = mapToWorldCoordinates( extentMin3D, mapOrigin );
649 const QgsVector3D worldExtentMax3D = mapToWorldCoordinates( extentMax3D, mapOrigin );
650 QgsAABB rootBbox( worldExtentMin3D.x(), worldExtentMin3D.y(), worldExtentMin3D.z(), worldExtentMax3D.x(), worldExtentMax3D.y(), worldExtentMax3D.z() );
651 return rootBbox;
652}
653
655{
656 const QgsVector3D extentMin3D( box3D.xMinimum(), box3D.yMinimum(), box3D.zMinimum() );
657 const QgsVector3D extentMax3D( box3D.xMaximum(), box3D.yMaximum(), box3D.zMaximum() );
658 const QgsVector3D worldExtentMin3D = mapToWorldCoordinates( extentMin3D, mapOrigin );
659 const QgsVector3D worldExtentMax3D = mapToWorldCoordinates( extentMax3D, mapOrigin );
660 // casting to float should be ok, assuming that the map origin is not too far from the box
661 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() ) );
662}
663
665{
666 const QgsVector3D worldExtentMin3D = Qgs3DUtils::worldToMapCoordinates( QgsVector3D( bbox.xMin, bbox.yMin, bbox.zMin ), mapOrigin );
667 const QgsVector3D worldExtentMax3D = Qgs3DUtils::worldToMapCoordinates( QgsVector3D( bbox.xMax, bbox.yMax, bbox.zMax ), mapOrigin );
668 const QgsRectangle extentMap( worldExtentMin3D.x(), worldExtentMin3D.y(), worldExtentMax3D.x(), worldExtentMax3D.y() );
669 // we discard zMin/zMax here because we don't need it
670 return extentMap;
671}
672
673
675{
676 const QgsVector3D mapPoint1 = worldToMapCoordinates( worldPoint1, origin1 );
677 QgsVector3D mapPoint2 = mapPoint1;
678 if ( crs1 != crs2 )
679 {
680 // reproject if necessary
681 const QgsCoordinateTransform ct( crs1, crs2, context );
682 try
683 {
684 const QgsPointXY pt = ct.transform( QgsPointXY( mapPoint1.x(), mapPoint1.y() ) );
685 mapPoint2.set( pt.x(), pt.y(), mapPoint1.z() );
686 }
687 catch ( const QgsCsException & )
688 {
689 // bad luck, can't reproject for some reason
690 }
691 }
692 return mapToWorldCoordinates( mapPoint2, origin2 );
693}
694
695void Qgs3DUtils::estimateVectorLayerZRange( QgsVectorLayer *layer, double &zMin, double &zMax )
696{
697 if ( !QgsWkbTypes::hasZ( layer->wkbType() ) )
698 {
699 zMin = 0;
700 zMax = 0;
701 return;
702 }
703
704 zMin = std::numeric_limits<double>::max();
705 zMax = std::numeric_limits<double>::lowest();
706
707 QgsFeature f;
708 QgsFeatureIterator it = layer->getFeatures( QgsFeatureRequest().setNoAttributes().setLimit( 100 ) );
709 while ( it.nextFeature( f ) )
710 {
711 const QgsGeometry g = f.geometry();
712 for ( auto vit = g.vertices_begin(); vit != g.vertices_end(); ++vit )
713 {
714 const double z = ( *vit ).z();
715 if ( z < zMin )
716 zMin = z;
717 if ( z > zMax )
718 zMax = z;
719 }
720 }
721
722 if ( zMin == std::numeric_limits<double>::max() && zMax == std::numeric_limits<double>::lowest() )
723 {
724 zMin = 0;
725 zMax = 0;
726 }
727}
728
737
739{
741 settings.setAmbient( material->ambient() );
742 settings.setDiffuse( material->diffuse() );
743 settings.setSpecular( material->specular() );
744 settings.setShininess( material->shininess() );
745 return settings;
746}
747
748QgsRay3D Qgs3DUtils::rayFromScreenPoint( const QPoint &point, const QSize &windowSize, Qt3DRender::QCamera *camera )
749{
750 const QVector3D deviceCoords( point.x(), point.y(), 0.0 );
751 // normalized device coordinates
752 const QVector3D normDeviceCoords( 2.0 * deviceCoords.x() / windowSize.width() - 1.0f, 1.0f - 2.0 * deviceCoords.y() / windowSize.height(), camera->nearPlane() );
753 // clip coordinates
754 const QVector4D rayClip( normDeviceCoords.x(), normDeviceCoords.y(), -1.0, 0.0 );
755
756 const QMatrix4x4 invertedProjMatrix = camera->projectionMatrix().inverted();
757 const QMatrix4x4 invertedViewMatrix = camera->viewMatrix().inverted();
758
759 // ray direction in view coordinates
760 QVector4D rayDirView = invertedProjMatrix * rayClip;
761 // ray origin in world coordinates
762 const QVector4D rayOriginWorld = invertedViewMatrix * QVector4D( 0.0f, 0.0f, 0.0f, 1.0f );
763
764 // ray direction in world coordinates
765 rayDirView.setZ( -1.0f );
766 rayDirView.setW( 0.0f );
767 const QVector4D rayDirWorld4D = invertedViewMatrix * rayDirView;
768 QVector3D rayDirWorld( rayDirWorld4D.x(), rayDirWorld4D.y(), rayDirWorld4D.z() );
769 rayDirWorld = rayDirWorld.normalized();
770
771 return QgsRay3D( QVector3D( rayOriginWorld ), rayDirWorld );
772}
773
774QVector3D Qgs3DUtils::screenPointToWorldPos( const QPoint &screenPoint, double depth, const QSize &screenSize, Qt3DRender::QCamera *camera )
775{
776 double dNear = camera->nearPlane();
777 double dFar = camera->farPlane();
778 double distance = ( 2.0 * dNear * dFar ) / ( dFar + dNear - ( depth * 2 - 1 ) * ( dFar - dNear ) );
779
780 QgsRay3D ray = Qgs3DUtils::rayFromScreenPoint( screenPoint, screenSize, camera );
781 double dot = QVector3D::dotProduct( ray.direction(), camera->viewVector().normalized() );
782 distance /= dot;
783
784 return ray.origin() + distance * ray.direction();
785}
786
787void Qgs3DUtils::pitchAndYawFromViewVector( QVector3D vect, double &pitch, double &yaw )
788{
789 vect.normalize();
790
791 pitch = qRadiansToDegrees( qAcos( vect.y() ) );
792 yaw = qRadiansToDegrees( qAtan2( -vect.z(), vect.x() ) ) + 90;
793}
794
795QVector2D Qgs3DUtils::screenToTextureCoordinates( QVector2D screenXY, QSize winSize )
796{
797 return QVector2D( screenXY.x() / winSize.width(), 1 - screenXY.y() / winSize.width() );
798}
799
800QVector2D Qgs3DUtils::textureToScreenCoordinates( QVector2D textureXY, QSize winSize )
801{
802 return QVector2D( textureXY.x() * winSize.width(), ( 1 - textureXY.y() ) * winSize.height() );
803}
804
805std::unique_ptr<QgsPointCloudLayer3DRenderer> Qgs3DUtils::convert2DPointCloudRendererTo3D( QgsPointCloudRenderer *renderer )
806{
807 if ( !renderer )
808 return nullptr;
809
810 std::unique_ptr<QgsPointCloud3DSymbol> symbol3D;
811 if ( renderer->type() == QLatin1String( "ramp" ) )
812 {
813 const QgsPointCloudAttributeByRampRenderer *renderer2D = dynamic_cast<const QgsPointCloudAttributeByRampRenderer *>( renderer );
814 symbol3D = std::make_unique<QgsColorRampPointCloud3DSymbol>();
815 QgsColorRampPointCloud3DSymbol *symbol = static_cast<QgsColorRampPointCloud3DSymbol *>( symbol3D.get() );
816 symbol->setAttribute( renderer2D->attribute() );
817 symbol->setColorRampShaderMinMax( renderer2D->minimum(), renderer2D->maximum() );
818 symbol->setColorRampShader( renderer2D->colorRampShader() );
819 }
820 else if ( renderer->type() == QLatin1String( "rgb" ) )
821 {
822 const QgsPointCloudRgbRenderer *renderer2D = dynamic_cast<const QgsPointCloudRgbRenderer *>( renderer );
823 symbol3D = std::make_unique<QgsRgbPointCloud3DSymbol>();
824 QgsRgbPointCloud3DSymbol *symbol = static_cast<QgsRgbPointCloud3DSymbol *>( symbol3D.get() );
825 symbol->setRedAttribute( renderer2D->redAttribute() );
826 symbol->setGreenAttribute( renderer2D->greenAttribute() );
827 symbol->setBlueAttribute( renderer2D->blueAttribute() );
828
829 symbol->setRedContrastEnhancement( renderer2D->redContrastEnhancement() ? new QgsContrastEnhancement( *renderer2D->redContrastEnhancement() ) : nullptr );
830 symbol->setGreenContrastEnhancement( renderer2D->greenContrastEnhancement() ? new QgsContrastEnhancement( *renderer2D->greenContrastEnhancement() ) : nullptr );
831 symbol->setBlueContrastEnhancement( renderer2D->blueContrastEnhancement() ? new QgsContrastEnhancement( *renderer2D->blueContrastEnhancement() ) : nullptr );
832 }
833 else if ( renderer->type() == QLatin1String( "classified" ) )
834 {
835 const QgsPointCloudClassifiedRenderer *renderer2D = dynamic_cast<const QgsPointCloudClassifiedRenderer *>( renderer );
836 symbol3D = std::make_unique<QgsClassificationPointCloud3DSymbol>();
837 QgsClassificationPointCloud3DSymbol *symbol = static_cast<QgsClassificationPointCloud3DSymbol *>( symbol3D.get() );
838 symbol->setAttribute( renderer2D->attribute() );
839 symbol->setCategoriesList( renderer2D->categories() );
840 }
841
842 if ( symbol3D )
843 {
844 auto renderer3D = std::make_unique<QgsPointCloudLayer3DRenderer>();
845 renderer3D->setSymbol( symbol3D.release() );
846 return renderer3D;
847 }
848 return nullptr;
849}
850
851QHash<QgsMapLayer *, QVector<QgsRayCastingUtils::RayHit>> Qgs3DUtils::castRay( Qgs3DMapScene *scene, const QgsRay3D &ray, const QgsRayCastingUtils::RayCastContext &context )
852{
853 QgsRayCastingUtils::Ray3D r( ray.origin(), ray.direction(), context.maxDistance );
854 QHash<QgsMapLayer *, QVector<QgsRayCastingUtils::RayHit>> results;
855 const QList<QgsMapLayer *> keys = scene->layers();
856 for ( QgsMapLayer *layer : keys )
857 {
858 Qt3DCore::QEntity *entity = scene->layerEntity( layer );
859
860 if ( QgsChunkedEntity *chunkedEntity = qobject_cast<QgsChunkedEntity *>( entity ) )
861 {
862 const QVector<QgsRayCastingUtils::RayHit> result = chunkedEntity->rayIntersection( r, context );
863 if ( !result.isEmpty() )
864 results[layer] = result;
865 }
866 }
867 if ( QgsTerrainEntity *terrain = scene->terrainEntity() )
868 {
869 const QVector<QgsRayCastingUtils::RayHit> result = terrain->rayIntersection( r, context );
870 if ( !result.isEmpty() )
871 results[nullptr] = result; // Terrain hits are not tied to a layer so we use nullptr as their key here
872 }
873 if ( QgsGlobeEntity *globe = scene->globeEntity() )
874 {
875 const QVector<QgsRayCastingUtils::RayHit> result = globe->rayIntersection( r, context );
876 if ( !result.isEmpty() )
877 results[nullptr] = result; // Terrain hits are not tied to a layer so we use nullptr as their key here
878 }
879 return results;
880}
881
882float Qgs3DUtils::screenSpaceError( float epsilon, float distance, int screenSize, float fov )
883{
884 /* This routine approximately calculates how an error (epsilon) of an object in world coordinates
885 * at given distance (between camera and the object) will look like in screen coordinates.
886 *
887 * the math below simply uses triangle similarity:
888 *
889 * epsilon phi
890 * ----------------------------- = ----------------
891 * [ frustum width at distance ] [ screen width ]
892 *
893 * Then we solve for phi, substituting [frustum width at distance] = 2 * distance * tan(fov / 2)
894 *
895 * ________xxx__ xxx = real world error (epsilon)
896 * \ | / x = screen space error (phi)
897 * \ | /
898 * \___|_x_/ near plane (screen space)
899 * \ | /
900 * \ | /
901 * \|/ angle = field of view
902 * camera
903 */
904 float phi = epsilon * static_cast<float>( screenSize ) / static_cast<float>( 2 * distance * tan( fov * M_PI / ( 2 * 180 ) ) );
905 return phi;
906}
907
908void Qgs3DUtils::computeBoundingBoxNearFarPlanes( const QgsAABB &bbox, const QMatrix4x4 &viewMatrix, float &fnear, float &ffar )
909{
910 fnear = 1e9;
911 ffar = 0;
912
913 for ( int i = 0; i < 8; ++i )
914 {
915 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 );
916
917 const QVector4D pc = viewMatrix * p;
918
919 const float dst = -pc.z(); // in camera coordinates, x grows right, y grows down, z grows to the back
920 fnear = std::min( fnear, dst );
921 ffar = std::max( ffar, dst );
922 }
923}
924
925Qt3DRender::QCullFace::CullingMode Qgs3DUtils::qt3DcullingMode( Qgs3DTypes::CullingMode mode )
926{
927 switch ( mode )
928 {
930 return Qt3DRender::QCullFace::NoCulling;
932 return Qt3DRender::QCullFace::Front;
933 case Qgs3DTypes::Back:
934 return Qt3DRender::QCullFace::Back;
936 return Qt3DRender::QCullFace::FrontAndBack;
937 }
938 return Qt3DRender::QCullFace::NoCulling;
939}
940
941
942QByteArray Qgs3DUtils::addDefinesToShaderCode( const QByteArray &shaderCode, const QStringList &defines )
943{
944 // There is one caveat to take care of - GLSL source code needs to start with #version as
945 // a first directive, otherwise we get the old GLSL 100 version. So we can't just prepend the
946 // shader source code, but insert our defines at the right place.
947
948 QStringList defineLines;
949 for ( const QString &define : defines )
950 defineLines += "#define " + define + "\n";
951
952 QString definesText = defineLines.join( QString() );
953
954 QByteArray newShaderCode = shaderCode;
955 int versionIndex = shaderCode.indexOf( "#version " );
956 int insertionIndex = versionIndex == -1 ? 0 : shaderCode.indexOf( '\n', versionIndex + 1 ) + 1;
957 newShaderCode.insert( insertionIndex, definesText.toLatin1() );
958 return newShaderCode;
959}
960
961QByteArray Qgs3DUtils::removeDefinesFromShaderCode( const QByteArray &shaderCode, const QStringList &defines )
962{
963 QByteArray newShaderCode = shaderCode;
964
965 for ( const QString &define : defines )
966 {
967 const QString defineLine = "#define " + define + "\n";
968 const int defineLineIndex = newShaderCode.indexOf( defineLine.toUtf8() );
969 if ( defineLineIndex != -1 )
970 {
971 newShaderCode.remove( defineLineIndex, defineLine.size() );
972 }
973 }
974
975 return newShaderCode;
976}
977
978void Qgs3DUtils::decomposeTransformMatrix( const QMatrix4x4 &matrix, QVector3D &translation, QQuaternion &rotation, QVector3D &scale )
979{
980 // decompose the transform matrix
981 // assuming the last row has values [0 0 0 1]
982 // see https://math.stackexchange.com/questions/237369/given-this-transformation-matrix-how-do-i-decompose-it-into-translation-rotati
983 const float *md = matrix.data(); // returns data in column-major order
984 const float sx = QVector3D( md[0], md[1], md[2] ).length();
985 const float sy = QVector3D( md[4], md[5], md[6] ).length();
986 const float sz = QVector3D( md[8], md[9], md[10] ).length();
987 float rd[9] = {
988 md[0] / sx,
989 md[4] / sy,
990 md[8] / sz,
991 md[1] / sx,
992 md[5] / sy,
993 md[9] / sz,
994 md[2] / sx,
995 md[6] / sy,
996 md[10] / sz,
997 };
998 const QMatrix3x3 rot3x3( rd ); // takes data in row-major order
999
1000 scale = QVector3D( sx, sy, sz );
1001 rotation = QQuaternion::fromRotationMatrix( rot3x3 );
1002 translation = QVector3D( md[12], md[13], md[14] );
1003}
1004
1005int Qgs3DUtils::openGlMaxClipPlanes( QSurface *surface )
1006{
1007 int numPlanes = 6;
1008
1009 QOpenGLContext context;
1010 context.setFormat( QSurfaceFormat::defaultFormat() );
1011 if ( context.create() )
1012 {
1013 if ( context.makeCurrent( surface ) )
1014 {
1015 QOpenGLFunctions *funcs = context.functions();
1016 funcs->glGetIntegerv( GL_MAX_CLIP_PLANES, &numPlanes );
1017 }
1018 }
1019
1020 return numPlanes;
1021}
1022
1023QQuaternion Qgs3DUtils::rotationFromPitchHeadingAngles( float pitchAngle, float headingAngle )
1024{
1025 return QQuaternion::fromAxisAndAngle( QVector3D( 0, 0, 1 ), headingAngle ) * QQuaternion::fromAxisAndAngle( QVector3D( 1, 0, 0 ), pitchAngle );
1026}
1027
1028QgsPoint Qgs3DUtils::screenPointToMapCoordinates( const QPoint &screenPoint, const QSize size, const QgsCameraController *cameraController, const Qgs3DMapSettings *mapSettings )
1029{
1030 const QgsRay3D ray = rayFromScreenPoint( screenPoint, size, cameraController->camera() );
1031
1032 // pick an arbitrary point mid-way between near and far plane
1033 const float pointDistance = ( cameraController->camera()->farPlane() + cameraController->camera()->nearPlane() ) / 2;
1034 const QVector3D worldPoint = ray.origin() + pointDistance * ray.direction().normalized();
1035 const QgsVector3D mapTransform = worldToMapCoordinates( worldPoint, mapSettings->origin() );
1036 const QgsPoint mapPoint( mapTransform.x(), mapTransform.y(), mapTransform.z() );
1037 return mapPoint;
1038}
1039
1040// computes the portion of the Y=y plane the camera is looking at
1041void Qgs3DUtils::calculateViewExtent( const Qt3DRender::QCamera *camera, float maxRenderingDistance, float z, float &minX, float &maxX, float &minY, float &maxY, float &minZ, float &maxZ )
1042{
1043 const QVector3D cameraPos = camera->position();
1044 const QMatrix4x4 projectionMatrix = camera->projectionMatrix();
1045 const QMatrix4x4 viewMatrix = camera->viewMatrix();
1046 float depth = 1.0f;
1047 QVector4D viewCenter = viewMatrix * QVector4D( camera->viewCenter(), 1.0f );
1048 viewCenter /= viewCenter.w();
1049 viewCenter = projectionMatrix * viewCenter;
1050 viewCenter /= viewCenter.w();
1051 depth = viewCenter.z();
1052 QVector<QVector3D> viewFrustumPoints = {
1053 QVector3D( 0.0f, 0.0f, depth ),
1054 QVector3D( 0.0f, 1.0f, depth ),
1055 QVector3D( 1.0f, 0.0f, depth ),
1056 QVector3D( 1.0f, 1.0f, depth ),
1057 QVector3D( 0.0f, 0.0f, 0 ),
1058 QVector3D( 0.0f, 1.0f, 0 ),
1059 QVector3D( 1.0f, 0.0f, 0 ),
1060 QVector3D( 1.0f, 1.0f, 0 )
1061 };
1062 maxX = std::numeric_limits<float>::lowest();
1063 maxY = std::numeric_limits<float>::lowest();
1064 maxZ = std::numeric_limits<float>::lowest();
1065 minX = std::numeric_limits<float>::max();
1066 minY = std::numeric_limits<float>::max();
1067 minZ = std::numeric_limits<float>::max();
1068 for ( int i = 0; i < viewFrustumPoints.size(); ++i )
1069 {
1070 // convert from view port space to world space
1071 viewFrustumPoints[i] = viewFrustumPoints[i].unproject( viewMatrix, projectionMatrix, QRect( 0, 0, 1, 1 ) );
1072 minX = std::min( minX, viewFrustumPoints[i].x() );
1073 maxX = std::max( maxX, viewFrustumPoints[i].x() );
1074 minY = std::min( minY, viewFrustumPoints[i].y() );
1075 maxY = std::max( maxY, viewFrustumPoints[i].y() );
1076 minZ = std::min( minZ, viewFrustumPoints[i].z() );
1077 maxZ = std::max( maxZ, viewFrustumPoints[i].z() );
1078 // find the intersection between the line going from cameraPos to the frustum quad point
1079 // and the horizontal plane Z=z
1080 // if the intersection is on the back side of the viewing panel we get a point that is
1081 // maxRenderingDistance units in front of the camera
1082 const QVector3D pt = cameraPos;
1083 const QVector3D vect = ( viewFrustumPoints[i] - pt ).normalized();
1084 float t = ( z - pt.z() ) / vect.z();
1085 if ( t < 0 )
1086 t = maxRenderingDistance;
1087 else
1088 t = std::min( t, maxRenderingDistance );
1089 viewFrustumPoints[i] = pt + t * vect;
1090 minX = std::min( minX, viewFrustumPoints[i].x() );
1091 maxX = std::max( maxX, viewFrustumPoints[i].x() );
1092 minY = std::min( minY, viewFrustumPoints[i].y() );
1093 maxY = std::max( maxY, viewFrustumPoints[i].y() );
1094 minZ = std::min( minZ, viewFrustumPoints[i].z() );
1095 maxZ = std::max( maxZ, viewFrustumPoints[i].z() );
1096 }
1097}
1098
1099QList<QVector4D> Qgs3DUtils::lineSegmentToClippingPlanes( const QgsVector3D &startPoint, const QgsVector3D &endPoint, const double distance, const QgsVector3D &origin )
1100{
1101 // return empty vector if distance is negative
1102 if ( distance < 0 )
1103 return QList<QVector4D>();
1104
1105 QgsVector3D lineDirection( endPoint - startPoint );
1106 lineDirection.normalize();
1107 const QgsVector lineDirection2DPerp = QgsVector( lineDirection.x(), lineDirection.y() ).perpVector();
1108 const QgsVector3D linePerp( lineDirection2DPerp.x(), lineDirection2DPerp.y(), 0 );
1109
1110 QList<QVector4D> clippingPlanes;
1111 QgsVector3D planePoint;
1112 double originDistance;
1113
1114 // the naming is assigned according to line direction
1116 planePoint = startPoint;
1117 originDistance = QgsVector3D::dotProduct( planePoint - origin, lineDirection );
1118 clippingPlanes << QVector4D( static_cast<float>( lineDirection.x() ), static_cast<float>( lineDirection.y() ), 0, static_cast<float>( -originDistance ) );
1119
1121 planePoint = startPoint + linePerp * distance;
1122 originDistance = QgsVector3D::dotProduct( planePoint - origin, -linePerp );
1123 clippingPlanes << QVector4D( static_cast<float>( -linePerp.x() ), static_cast<float>( -linePerp.y() ), 0, static_cast<float>( -originDistance ) );
1124
1126 planePoint = endPoint;
1127 originDistance = QgsVector3D::dotProduct( planePoint - origin, -lineDirection );
1128 clippingPlanes << QVector4D( static_cast<float>( -lineDirection.x() ), static_cast<float>( -lineDirection.y() ), 0, static_cast<float>( -originDistance ) );
1129
1131 planePoint = startPoint - linePerp * distance;
1132 originDistance = QgsVector3D::dotProduct( planePoint - origin, linePerp );
1133 clippingPlanes << QVector4D( static_cast<float>( linePerp.x() ), static_cast<float>( linePerp.y() ), 0, static_cast<float>( -originDistance ) );
1134
1135 return clippingPlanes;
1136}
1137
1138QgsCameraPose Qgs3DUtils::lineSegmentToCameraPose( const QgsVector3D &startPoint, const QgsVector3D &endPoint, const QgsDoubleRange &elevationRange, const float fieldOfView, const QgsVector3D &worldOrigin )
1139{
1140 QgsCameraPose cameraPose;
1141 // we tilt the view slightly to see flat layers if the elevationRange is infinite (scene has flat terrain, vector layers...)
1142 elevationRange.isInfinite() ? cameraPose.setPitchAngle( 89 ) : cameraPose.setPitchAngle( 90 );
1143
1144 // calculate the middle of the front side defined by clipping planes
1145 QgsVector linePerpVec( ( endPoint - startPoint ).x(), ( endPoint - startPoint ).y() );
1146 linePerpVec = -linePerpVec.normalized().perpVector();
1147 const QgsVector3D linePerpVec3D( linePerpVec.x(), linePerpVec.y(), 0 );
1148 QgsVector3D middle( startPoint + ( endPoint - startPoint ) / 2 );
1149
1150 double elevationRangeHalf;
1151 elevationRange.isInfinite() ? elevationRangeHalf = 0 : elevationRangeHalf = ( elevationRange.upper() - elevationRange.lower() ) / 2;
1152 const double side = std::max( middle.distance( startPoint ), elevationRangeHalf );
1153 const double distance = ( side / std::tan( fieldOfView / 2 * M_PI / 180 ) ) * 1.05;
1154 cameraPose.setDistanceFromCenterPoint( static_cast<float>( distance ) );
1155
1156 elevationRange.isInfinite() ? middle.setZ( 0 ) : middle.setZ( elevationRange.lower() + ( elevationRange.upper() - elevationRange.lower() ) / 2 );
1157 cameraPose.setCenterPoint( mapToWorldCoordinates( middle, worldOrigin ) );
1158
1159 const QgsVector3D northDirectionVec( 0, -1, 0 );
1160 // calculate the angle between vector pointing to the north and vector pointing from the front side of clipped area
1161 float yawAngle = static_cast<float>( acos( QgsVector3D::dotProduct( linePerpVec3D, northDirectionVec ) ) * 180 / M_PI );
1162 // 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
1163 if ( QgsVector3D::crossProduct( linePerpVec3D, northDirectionVec ).z() > 0 )
1164 {
1165 yawAngle = 360 - yawAngle;
1166 }
1167 cameraPose.setHeadingAngle( yawAngle );
1168
1169 return cameraPose;
1170}
1171
1172std::unique_ptr<Qt3DRender::QCamera> Qgs3DUtils::copyCamera( Qt3DRender::QCamera *cam )
1173{
1174 std::unique_ptr<Qt3DRender::QCamera> copy = std::make_unique<Qt3DRender::QCamera>();
1175 copy->setPosition( cam->position() );
1176 copy->setViewCenter( cam->viewCenter() );
1177 copy->setUpVector( cam->upVector() );
1178 copy->setProjectionMatrix( cam->projectionMatrix() );
1179 copy->setNearPlane( cam->nearPlane() );
1180 copy->setFarPlane( cam->farPlane() );
1181 copy->setAspectRatio( cam->aspectRatio() );
1182 copy->setFieldOfView( cam->fieldOfView() );
1183 return copy;
1184}
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 std::unique_ptr< Qt3DRender::QCamera > copyCamera(Qt3DRender::QCamera *cam)
Returns new camera object with copied properties.
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.
void setLookingAtMapPoint(const QgsVector3D &point, float distance, float pitch, float yaw)
Sets camera configuration like setLookingAtPoint(), but the point is given in map coordinates.
Qt3DRender::QCamera * camera() const
Returns camera that is being controlled.
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:6897
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 map 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.