QGIS API Documentation  3.23.0-Master (eb871beae0)
qgsabstract3dengine.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsabstract3dengine.h
3  --------------------------------------
4  Date : July 2018
5  Copyright : (C) 2018 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 #ifndef QGSABSTRACT3DENGINE_H
17 #define QGSABSTRACT3DENGINE_H
18 
19 #include "qgis_3d.h"
20 
21 #include <QObject>
22 
23 #define SIP_NO_FILE
24 
25 class QColor;
26 class QRect;
27 class QSurface;
28 
29 namespace Qt3DCore
30 {
31  class QEntity;
32 }
33 
34 namespace Qt3DRender
35 {
36  class QRenderSettings;
37  class QCamera;
38  class QFrameGraphNode;
39 }
40 
42 
59 class _3D_EXPORT QgsAbstract3DEngine : public QObject
60 {
61  Q_OBJECT
62  public:
63 
67  QgsAbstract3DEngine( QObject *parent = nullptr );
68 
70  virtual void setClearColor( const QColor &color ) = 0;
72  virtual void setFrustumCullingEnabled( bool enabled ) = 0;
74  virtual void setRootEntity( Qt3DCore::QEntity *root ) = 0;
75 
77  virtual Qt3DRender::QRenderSettings *renderSettings() = 0;
79  virtual Qt3DRender::QCamera *camera() = 0;
81  virtual QSize size() const = 0;
83  virtual void setSize( QSize s ) = 0;
84 
90  void requestCaptureImage();
91 
97  virtual QSurface *surface() const = 0;
98 
104  QgsShadowRenderingFrameGraph *frameGraph() { return mFrameGraph; }
105 
113  void setRenderCaptureEnabled( bool enabled );
114 
119  bool renderCaptureEnabled() const;
120  signals:
122  void imageCaptured( const QImage &image );
123 
124  protected:
125  QgsShadowRenderingFrameGraph *mFrameGraph = nullptr;
126 };
127 
128 
129 #endif // QGSABSTRACT3DENGINE_H
void imageCaptured(const QImage &image)
Emitted after a call to requestCaptureImage() to return the captured image.
virtual void setClearColor(const QColor &color)=0
Sets background color of the scene.
virtual Qt3DRender::QRenderSettings * renderSettings()=0
Returns access to the engine's render settings (the frame graph can be accessed from here)
virtual Qt3DRender::QCamera * camera()=0
Returns pointer to the engine's camera entity.
virtual QSurface * surface() const =0
Returns the surface of the engine.
virtual void setSize(QSize s)=0
Sets the size of the rendering area (in pixels)
QgsShadowRenderingFrameGraph * frameGraph()
Returns the shadow rendering frame graph object used to render the scene.
virtual void setFrustumCullingEnabled(bool enabled)=0
Sets whether frustum culling is enabled (this should make rendering faster by not rendering entities ...
virtual void setRootEntity(Qt3DCore::QEntity *root)=0
Sets root entity of the 3D scene.
virtual QSize size() const =0
Returns size of the engine's rendering area in pixels.