3 Base class for 3D engine implementation. More...

#include <qgsabstract3dengine.h>

Inheritance diagram for QgsAbstract3DEngine:

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

Public Member Functions
virtual Qt3DRender::QCamera *	camera ()=0
	Returns pointer to the engine's camera entity. More...

virtual Qt3DRender::QRenderSettings *	renderSettings ()=0
	Returns access to the engine's render settings (the frame graph can be accessed from here) More...

virtual void	requestCaptureImage ()=0
	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...

virtual void	setRootEntity (Qt3DCore::QEntity *root)=0
	Sets root entity of the 3D scene. More...

virtual QSize	size () const =0
	Returns size of the engine's rendering area in pixels. More...

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

Since: QGIS 3.4

Definition at line 50 of file qgsabstract3dengine.h.

Member Function Documentation

◆ camera()

virtual Qt3DRender::QCamera* QgsAbstract3DEngine::camera ( )

pure virtual

Returns pointer to the engine's camera entity.

Implemented in QgsOffscreen3DEngine, and QgsWindow3DEngine.

◆ imageCaptured

void QgsAbstract3DEngine::imageCaptured ( const QImage & image )

signal

Emitted after a call to requestCaptureImage() to return the captured image.

◆ renderSettings()

virtual Qt3DRender::QRenderSettings* QgsAbstract3DEngine::renderSettings ( )

pure virtual

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

Implemented in QgsOffscreen3DEngine, and QgsWindow3DEngine.

◆ requestCaptureImage()

virtual void QgsAbstract3DEngine::requestCaptureImage ( )

pure virtual

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.

Implemented in QgsOffscreen3DEngine, and QgsWindow3DEngine.