QGIS API Documentation  3.6.0-Noosa (5873452)
Public Member Functions | List of all members
QgsOffscreen3DEngine Class Reference

3 Off-screen 3D engine implementation. More...

#include <qgsoffscreen3dengine.h>

Inheritance diagram for QgsOffscreen3DEngine:
Inheritance graph
[legend]

Public Member Functions

 QgsOffscreen3DEngine ()
 
 ~QgsOffscreen3DEngine () override
 
Qt3DRender::QCamera * camera () override
 Returns pointer to the engine's camera entity. More...
 
Qt3DRender::QRenderSettings * renderSettings () override
 Returns access to the engine's render settings (the frame graph can be accessed from here) More...
 
void requestCaptureImage () override
 Starts a request for an image rendered by the engine. More...
 
void setClearColor (const QColor &color) override
 Sets background color of the scene. More...
 
void setFrustumCullingEnabled (bool enabled) override
 Sets whether frustum culling is enabled (this should make rendering faster by not rendering entities outside of camera's view) More...
 
void setRootEntity (Qt3DCore::QEntity *root) override
 Sets root entity of the 3D scene. More...
 
void setSize (QSize s)
 Sets the size of the rendering area (in pixels) More...
 
QSize size () const override
 Returns size of the engine's rendering area in pixels. More...
 

Additional Inherited Members

- Signals inherited from QgsAbstract3DEngine
void imageCaptured (const QImage &image)
 Emitted after a call to requestCaptureImage() to return the captured image. More...
 

Detailed Description

3 Off-screen 3D engine implementation.

It is useful for recording rendered 3D scenes of arbitrary size.

Note
While the on-screen 3D engine also allows capturing of images, its limitation is that the captured images are of the size of the on-screen window.
Since
QGIS 3.4

Definition at line 61 of file qgsoffscreen3dengine.h.

Constructor & Destructor Documentation

◆ QgsOffscreen3DEngine()

QgsOffscreen3DEngine::QgsOffscreen3DEngine ( )

Definition at line 38 of file qgsoffscreen3dengine.cpp.

◆ ~QgsOffscreen3DEngine()

QgsOffscreen3DEngine::~QgsOffscreen3DEngine ( )
override

Definition at line 100 of file qgsoffscreen3dengine.cpp.

Member Function Documentation

◆ camera()

Qt3DRender::QCamera * QgsOffscreen3DEngine::camera ( )
overridevirtual

Returns pointer to the engine's camera entity.

Implements QgsAbstract3DEngine.

Definition at line 222 of file qgsoffscreen3dengine.cpp.

◆ renderSettings()

Qt3DRender::QRenderSettings * QgsOffscreen3DEngine::renderSettings ( )
overridevirtual

Returns access to the engine's render settings (the frame graph can be accessed from here)

Implements QgsAbstract3DEngine.

Definition at line 217 of file qgsoffscreen3dengine.cpp.

◆ requestCaptureImage()

void QgsOffscreen3DEngine::requestCaptureImage ( )
overridevirtual

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.

Implements QgsAbstract3DEngine.

Definition at line 232 of file qgsoffscreen3dengine.cpp.

◆ setClearColor()

void QgsOffscreen3DEngine::setClearColor ( const QColor &  color)
overridevirtual

Sets background color of the scene.

Implements QgsAbstract3DEngine.

Definition at line 117 of file qgsoffscreen3dengine.cpp.

◆ setFrustumCullingEnabled()

void QgsOffscreen3DEngine::setFrustumCullingEnabled ( bool  enabled)
overridevirtual

Sets whether frustum culling is enabled (this should make rendering faster by not rendering entities outside of camera's view)

Implements QgsAbstract3DEngine.

Definition at line 122 of file qgsoffscreen3dengine.cpp.

◆ setRootEntity()

void QgsOffscreen3DEngine::setRootEntity ( Qt3DCore::QEntity *  root)
overridevirtual

Sets root entity of the 3D scene.

Implements QgsAbstract3DEngine.

Definition at line 204 of file qgsoffscreen3dengine.cpp.

◆ setSize()

void QgsOffscreen3DEngine::setSize ( QSize  s)

Sets the size of the rendering area (in pixels)

Definition at line 106 of file qgsoffscreen3dengine.cpp.

◆ size()

QSize QgsOffscreen3DEngine::size ( ) const
overridevirtual

Returns size of the engine's rendering area in pixels.

Implements QgsAbstract3DEngine.

Definition at line 227 of file qgsoffscreen3dengine.cpp.


The documentation for this class was generated from the following files: