QgsWindow3DEngine Class Reference

3 On-screen 3D engine: it creates OpenGL window (QWindow) and displays rendered 3D scene there. More...

#include <qgswindow3dengine.h>

Inheritance diagram for QgsWindow3DEngine:

Public Member Functions
	QgsWindow3DEngine (QObject *parent=nullptr)
	Constructor for QgsWindow3DEngine with the specified parent object. More...
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	setShadowRenderingEnabled (bool enabled)
	Sets whether shadow rendering is enabled. More...
bool	shadowRenderingEnabled ()
	Returns whether shadow rendering is enabled. More...
QgsShadowRenderingFrameGraph *	shadowRenderingFrameGraph ()
	Returns the frame graph object. More...
QSize	size () const override
	Returns size of the engine's rendering area in pixels. More...
QSurface *	surface () const override
	Returns the surface of the engine. More...
QWindow *	window ()
	Returns the internal 3D window where all the rendered output is displayed. More...
Public Member Functions inherited from QgsAbstract3DEngine
	QgsAbstract3DEngine (QObject *parent=nullptr)
	Constructor for QgsAbstract3DEngine with the specified parent object. 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 On-screen 3D engine: it creates OpenGL window (QWindow) and displays rendered 3D scene there.

The window can be embedded into a QWidget-based application with QWidget::createWindowContainer().

Note

Not available in Python bindings

Since

QGIS 3.4

Definition at line 49 of file qgswindow3dengine.h.

Constructor & Destructor Documentation

QgsWindow3DEngine()

QgsWindow3DEngine::QgsWindow3DEngine

(

QObject *

parent = nullptr

)

Constructor for QgsWindow3DEngine with the specified parent object.

Definition at line 25 of file qgswindow3dengine.cpp.

Member Function Documentation

camera()

Qt3DRender::QCamera * QgsWindow3DEngine::camera ( )

overridevirtual

Returns pointer to the engine's camera entity.

Implements QgsAbstract3DEngine.

Definition at line 87 of file qgswindow3dengine.cpp.

renderSettings()

Qt3DRender::QRenderSettings * QgsWindow3DEngine::renderSettings ( )

overridevirtual

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

Implements QgsAbstract3DEngine.

Definition at line 82 of file qgswindow3dengine.cpp.

requestCaptureImage()

void QgsWindow3DEngine::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 46 of file qgswindow3dengine.cpp.

setClearColor()

void QgsWindow3DEngine::setClearColor ( const QColor &  color )

overridevirtual

Sets background color of the scene.

Implements QgsAbstract3DEngine.

Definition at line 63 of file qgswindow3dengine.cpp.

setFrustumCullingEnabled()

void QgsWindow3DEngine::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 68 of file qgswindow3dengine.cpp.

setRootEntity()

void QgsWindow3DEngine::setRootEntity ( Qt3DCore::QEntity *  root )

overridevirtual

Sets root entity of the 3D scene.

Implements QgsAbstract3DEngine.

Definition at line 74 of file qgswindow3dengine.cpp.

setShadowRenderingEnabled()

void QgsWindow3DEngine::setShadowRenderingEnabled

(

bool

enabled

)

Sets whether shadow rendering is enabled.

Definition at line 57 of file qgswindow3dengine.cpp.

shadowRenderingEnabled()

bool QgsWindow3DEngine::shadowRenderingEnabled ( )

inline

Returns whether shadow rendering is enabled.

Definition at line 70 of file qgswindow3dengine.h.

shadowRenderingFrameGraph()

QgsShadowRenderingFrameGraph* QgsWindow3DEngine::shadowRenderingFrameGraph ( )

inline

Returns the frame graph object.

Definition at line 63 of file qgswindow3dengine.h.

size()

QSize QgsWindow3DEngine::size ( ) const

overridevirtual

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

Implements QgsAbstract3DEngine.

Definition at line 92 of file qgswindow3dengine.cpp.

surface()

QSurface * QgsWindow3DEngine::surface ( ) const

overridevirtual

Returns the surface of the engine.

Since

QGIS 3.14

Implements QgsAbstract3DEngine.

Definition at line 97 of file qgswindow3dengine.cpp.

window()

QWindow * QgsWindow3DEngine::window

(

)

Returns the internal 3D window where all the rendered output is displayed.

Definition at line 41 of file qgswindow3dengine.cpp.

---

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

• /build/qgis-3.16.0+99unstable/src/3d/qgswindow3dengine.h
• /build/qgis-3.16.0+99unstable/src/3d/qgswindow3dengine.cpp