QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgsoffscreen3dengine.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsoffscreen3dengine.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 QGSOFFSCREEN3DENGINE_H
17 #define QGSOFFSCREEN3DENGINE_H
18 
19 #include "qgsabstract3dengine.h"
20 
21 #include <QSize>
22 
23 class QOffscreenSurface;
24 
25 namespace Qt3DCore
26 {
27  class QAspectEngine;
28  class QNode;
29 }
30 
31 namespace Qt3DRender
32 {
33  class QCameraSelector;
34  class QClearBuffers;
35  class QRenderAspect;
36  class QRenderCapture;
37  class QRenderCaptureReply;
38  class QRenderTarget;
39  class QRenderTargetSelector;
40  class QRenderTargetOutput;
41  class QRenderSurfaceSelector;
42  class QTexture2D;
43  class QViewport;
44 }
45 
46 namespace Qt3DLogic
47 {
48  class QLogicAspect;
49 }
50 
51 #define SIP_NO_FILE
52 
64 class _3D_EXPORT QgsOffscreen3DEngine : public QgsAbstract3DEngine
65 {
66  Q_OBJECT
67  public:
69  ~QgsOffscreen3DEngine() override;
70 
72  void setSize( QSize s );
73 
74  void setClearColor( const QColor &color ) override;
75  void setFrustumCullingEnabled( bool enabled ) override;
76  void setRootEntity( Qt3DCore::QEntity *root ) override;
77 
78  Qt3DRender::QRenderSettings *renderSettings() override;
79  Qt3DRender::QCamera *camera() override;
80  QSize size() const override;
81  QSurface *surface() const override;
82 
83  void requestCaptureImage() override;
84 
85  private:
86  void createRenderTarget();
87  void createFrameGraph();
88 
89  private:
90 
91  QSize mSize = QSize( 640, 480 );
92  Qt3DRender::QCamera *mCamera = nullptr;
93  QOffscreenSurface *mOffscreenSurface = nullptr;
94  Qt3DRender::QRenderCaptureReply *mReply = nullptr;
95 
96  // basic Qt3D stuff
97  Qt3DCore::QAspectEngine *mAspectEngine = nullptr; // The aspect engine, which holds the scene and related aspects.
98  Qt3DRender::QRenderAspect *mRenderAspect = nullptr; // The render aspect, which deals with rendering the scene.
99  Qt3DLogic::QLogicAspect *mLogicAspect = nullptr; // The logic aspect, which runs jobs to do with synchronising frames.
100  Qt3DRender::QRenderSettings *mRenderSettings = nullptr; // The render settings, which control the general rendering behavior.
101  Qt3DCore::QNode *mSceneRoot = nullptr; // The scene root, which becomes a child of the engine's root entity.
102  Qt3DCore::QEntity *mRoot = nullptr;
103 
104  // render target stuff
105  Qt3DRender::QRenderTarget *mTextureTarget = nullptr;
106  Qt3DRender::QRenderTargetOutput *mTextureOutput = nullptr;
107  Qt3DRender::QTexture2D *mTexture = nullptr;
108  Qt3DRender::QRenderTargetOutput *mDepthTextureOutput = nullptr;
109  Qt3DRender::QTexture2D *mDepthTexture = nullptr;
110 
111  // frame graph stuff
112  Qt3DRender::QRenderSurfaceSelector *mSurfaceSelector = nullptr;
113  Qt3DRender::QRenderTargetSelector *mRenderTargetSelector = nullptr;
114  Qt3DRender::QViewport *mViewport = nullptr;
115  Qt3DRender::QClearBuffers *mClearBuffers = nullptr;
116  Qt3DRender::QCameraSelector *mCameraSelector = nullptr;
117  Qt3DRender::QRenderCapture *mRenderCapture = nullptr; // The render capture node, which is appended to the frame graph.
118 
119 };
120 
121 #endif // QGSOFFSCREEN3DENGINE_H
QgsAbstract3DEngine::setRootEntity
virtual void setRootEntity(Qt3DCore::QEntity *root)=0
Sets root entity of the 3D scene.
QgsAbstract3DEngine::setClearColor
virtual void setClearColor(const QColor &color)=0
Sets background color of the scene.
QgsAbstract3DEngine::size
virtual QSize size() const =0
Returns size of the engine's rendering area in pixels.
Qt3DLogic
Definition: qgs3dmapscene.h:35
Qt3DCore
Definition: qgsabstract3drenderer.h:31
Qt3DRender
Definition: qgs3dmapscene.h:27
qgsabstract3dengine.h
QgsAbstract3DEngine
3 Base class for 3D engine implementation.
Definition: qgsabstract3dengine.h:58
QgsAbstract3DEngine::camera
virtual Qt3DRender::QCamera * camera()=0
Returns pointer to the engine's camera entity.
QgsAbstract3DEngine::setFrustumCullingEnabled
virtual void setFrustumCullingEnabled(bool enabled)=0
Sets whether frustum culling is enabled (this should make rendering faster by not rendering entities ...
QgsAbstract3DEngine::requestCaptureImage
virtual void requestCaptureImage()=0
Starts a request for an image rendered by the engine.
QgsAbstract3DEngine::renderSettings
virtual Qt3DRender::QRenderSettings * renderSettings()=0
Returns access to the engine's render settings (the frame graph can be accessed from here)
QgsOffscreen3DEngine
3 Off-screen 3D engine implementation.
Definition: qgsoffscreen3dengine.h:65
QgsAbstract3DEngine::surface
virtual QSurface * surface() const =0
Returns the surface of the engine.