3 More...
#include <qgsabstract3dengine.h>
Signals | |
| void | imageCaptured (const QImage &image) |
| Emitted after a call to requestCaptureImage() to return the captured image. More... | |
Public Member Functions | |
| QgsAbstract3DEngine (QObject *parent=nullptr) | |
| Constructor for QgsAbstract3DEngine with the specified parent object. More... | |
| virtual Qt3DRender::QCamera * | camera ()=0 |
| Returns pointer to the engine's camera entity. More... | |
| QgsShadowRenderingFrameGraph * | frameGraph () |
| Returns the shadow rendering frame graph object used to render the scene. More... | |
| bool | renderCaptureEnabled () const |
| Returns whether it will be possible to render to an image. More... | |
| virtual Qt3DRender::QRenderSettings * | renderSettings ()=0 |
| Returns access to the engine's render settings (the frame graph can be accessed from here) More... | |
| void | requestCaptureImage () |
| Starts a request for an image rendered by the engine. More... | |
| virtual void | setClearColor (const QColor &color)=0 |
| Sets background color of the scene. More... | |
| virtual void | setFrustumCullingEnabled (bool enabled)=0 |
| Sets whether frustum culling is enabled (this should make rendering faster by not rendering entities outside of camera's view) More... | |
| void | setRenderCaptureEnabled (bool enabled) |
| Sets whether it will be possible to render to an image. More... | |
| virtual void | setRootEntity (Qt3DCore::QEntity *root)=0 |
| Sets root entity of the 3D scene. More... | |
| virtual void | setSize (QSize s)=0 |
| Sets the size of the rendering area (in pixels) More... | |
| virtual QSize | size () const =0 |
| Returns size of the engine's rendering area in pixels. More... | |
| virtual QSurface * | surface () const =0 |
| Returns the surface of the engine. More... | |
Protected Attributes | |
| QgsShadowRenderingFrameGraph * | mFrameGraph = nullptr |
Detailed Description
3
Base class for 3D engine implementation. A 3D engine is responsible for setting up rendering with Qt3D. This means mainly:
- creating Qt3D aspect engine and registering rendering aspect
- setting up a camera, render settings and frame graph
We have two implementations:
- QgsWindow3DEngine - used for rendering on display (has a QWindow that can be embedded into QWidget)
- QgsOffscreen3DEngine - renders scene to images
- Note
- Not available in Python bindings
- Since
- QGIS 3.4
Definition at line 59 of file qgsabstract3dengine.h.
Constructor & Destructor Documentation
◆ QgsAbstract3DEngine()
| QgsAbstract3DEngine::QgsAbstract3DEngine | ( | QObject * | parent = nullptr | ) |
Constructor for QgsAbstract3DEngine with the specified parent object.
Definition at line 23 of file qgsabstract3dengine.cpp.
Member Function Documentation
◆ camera()
|
pure virtual |
Returns pointer to the engine's camera entity.
Implemented in QgsWindow3DEngine, and QgsOffscreen3DEngine.
◆ frameGraph()
|
inline |
Returns the shadow rendering frame graph object used to render the scene.
- Since
- QGIS 3.18
Definition at line 104 of file qgsabstract3dengine.h.
◆ imageCaptured
|
signal |
Emitted after a call to requestCaptureImage() to return the captured image.
◆ renderCaptureEnabled()
| bool QgsAbstract3DEngine::renderCaptureEnabled | ( | ) | const |
Returns whether it will be possible to render to an image.
- Since
- QGIS 3.18
Definition at line 48 of file qgsabstract3dengine.cpp.
◆ renderSettings()
|
pure virtual |
Returns access to the engine's render settings (the frame graph can be accessed from here)
Implemented in QgsWindow3DEngine, and QgsOffscreen3DEngine.
◆ requestCaptureImage()
| void QgsAbstract3DEngine::requestCaptureImage | ( | ) |
Starts a request for an image rendered by the engine.
The function does not block - when the rendered image is captured, it is returned in imageCaptured() signal. Only one image request can be active at a time.
Definition at line 29 of file qgsabstract3dengine.cpp.
◆ setClearColor()
|
pure virtual |
Sets background color of the scene.
Implemented in QgsWindow3DEngine, and QgsOffscreen3DEngine.
◆ setFrustumCullingEnabled()
|
pure virtual |
Sets whether frustum culling is enabled (this should make rendering faster by not rendering entities outside of camera's view)
Implemented in QgsWindow3DEngine, and QgsOffscreen3DEngine.
◆ setRenderCaptureEnabled()
| void QgsAbstract3DEngine::setRenderCaptureEnabled | ( | bool | enabled | ) |
Sets whether it will be possible to render to an image.
- Note
- for QgsWindow3DEngine render capture will be disabled by default and for QgsOffscreen3DEngine it is enabled by default
- Since
- QGIS 3.18
Definition at line 43 of file qgsabstract3dengine.cpp.
◆ setRootEntity()
|
pure virtual |
Sets root entity of the 3D scene.
Implemented in QgsWindow3DEngine, and QgsOffscreen3DEngine.
◆ setSize()
|
pure virtual |
Sets the size of the rendering area (in pixels)
Implemented in QgsWindow3DEngine, and QgsOffscreen3DEngine.
◆ size()
|
pure virtual |
Returns size of the engine's rendering area in pixels.
Implemented in QgsWindow3DEngine, and QgsOffscreen3DEngine.
◆ surface()
|
pure virtual |
Returns the surface of the engine.
- Since
- QGIS 3.14
Implemented in QgsWindow3DEngine, and QgsOffscreen3DEngine.
Member Data Documentation
◆ mFrameGraph
|
protected |
Definition at line 125 of file qgsabstract3dengine.h.
The documentation for this class was generated from the following files:
- /build/qgis-3.20.0+99unstable/src/3d/qgsabstract3dengine.h
- /build/qgis-3.20.0+99unstable/src/3d/qgsabstract3dengine.cpp
