QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
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
23class QOffscreenSurface;
24
25namespace Qt3DCore
26{
27 class QAspectEngine;
28 class QNode;
29}
30
31namespace 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
46namespace Qt3DLogic
47{
48 class QLogicAspect;
49}
50
51
52#define SIP_NO_FILE
53
66{
67 Q_OBJECT
68 public:
70 ~QgsOffscreen3DEngine() override;
71
72 void setSize( QSize s ) override;
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 private:
84
85 QSize mSize = QSize( 640, 480 );
86 Qt3DRender::QCamera *mCamera = nullptr;
87 QOffscreenSurface *mOffscreenSurface = nullptr;
88
89 // basic Qt3D stuff
90 Qt3DCore::QAspectEngine *mAspectEngine = nullptr; // The aspect engine, which holds the scene and related aspects.
91 Qt3DRender::QRenderAspect *mRenderAspect = nullptr; // The render aspect, which deals with rendering the scene.
92 Qt3DLogic::QLogicAspect *mLogicAspect = nullptr; // The logic aspect, which runs jobs to do with synchronising frames.
93 Qt3DRender::QRenderSettings *mRenderSettings = nullptr; // The render settings, which control the general rendering behavior.
94 Qt3DCore::QNode *mSceneRoot = nullptr; // The scene root, which becomes a child of the engine's root entity.
95 Qt3DCore::QEntity *mRoot = nullptr;
96};
97
98#endif // QGSOFFSCREEN3DENGINE_H
virtual QSurface * surface() const =0
Returns the surface of the engine.
virtual Qt3DRender::QCamera * camera()=0
Returns pointer to the engine's camera entity.
virtual void setClearColor(const QColor &color)=0
Sets background color of the scene.
virtual void setSize(QSize s)=0
Sets the size of the rendering area (in pixels)
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.
virtual Qt3DRender::QRenderSettings * renderSettings()=0
Returns access to the engine's render settings (the frame graph can be accessed from here)