QgsWindow3DEngine Class Reference

3 More...

#include <qgswindow3dengine.h>

Inheritance diagram for QgsWindow3DEngine:

Public Member Functions
	QgsWindow3DEngine (Qgs3DMapCanvas *parent)
	Constructor for QgsWindow3DEngine with the specified parent Qgs3DMapCanvas.
Qt3DRender::QCamera *	camera () override
	Returns pointer to the engine's camera entity.
Qt3DRender::QRenderSettings *	renderSettings () override
	Returns access to the engine's render settings (the frame graph can be accessed from here)
Qt3DCore::QEntity *	root () const
	Returns the root entity.
void	setClearColor (const QColor &color) override
	Sets background color of the scene.
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)
void	setRootEntity (Qt3DCore::QEntity *root) override
	Sets root entity of the 3D scene.
void	setShadowRenderingEnabled (bool enabled)
	Sets whether shadow rendering is enabled.
void	setSize (QSize s) override
	Sets the size of the rendering area (in pixels)
bool	shadowRenderingEnabled ()
	Returns whether shadow rendering is enabled.
QSize	size () const override
	Returns size of the engine's rendering area in pixels.
QSurface *	surface () const override
	Returns the surface of the engine.
QWindow *	window ()
	Returns the internal 3D window where all the rendered output is displayed.
Public Member Functions inherited from QgsAbstract3DEngine
	QgsAbstract3DEngine (QObject *parent=nullptr)
	Constructor for QgsAbstract3DEngine with the specified parent object.
QString	dumpFrameGraph () const
	Dump frame graph as string.
void	dumpFrameGraphToConsole () const
	Dump the current frame graph and scene graph to the console.
QString	dumpSceneGraph () const
	Dump scene graph as string.
QgsFrameGraph *	frameGraph ()
	Returns the shadow rendering frame graph object used to render the scene.
bool	renderCaptureEnabled () const
	Returns whether it will be possible to render to an image.
void	requestCaptureImage ()
	Starts a request for an image rendered by the engine.
void	requestDepthBufferCapture ()
	Starts a request for an image containing the depth buffer data of the engine.
void	setRenderCaptureEnabled (bool enabled)
	Sets whether it will be possible to render to an image.

Additional Inherited Members
Signals inherited from QgsAbstract3DEngine
void	depthBufferCaptured (const QImage &image)
	Emitted after a call to requestDepthBufferCapture() to return the captured depth buffer.
void	imageCaptured (const QImage &image)
	Emitted after a call to requestCaptureImage() to return the captured image.
void	sizeChanged ()
	Emitted after a call to setSize()
Protected Attributes inherited from QgsAbstract3DEngine
QgsFrameGraph *	mFrameGraph = nullptr

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 45 of file qgswindow3dengine.h.

Constructor & Destructor Documentation

QgsWindow3DEngine()

QgsWindow3DEngine::QgsWindow3DEngine

(

Qgs3DMapCanvas *

parent

)

Constructor for QgsWindow3DEngine with the specified parent Qgs3DMapCanvas.

Definition at line 26 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 81 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 76 of file qgswindow3dengine.cpp.

root()

Qt3DCore::QEntity * QgsWindow3DEngine::root

(

)

const

Returns the root entity.

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 57 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 62 of file qgswindow3dengine.cpp.

setRootEntity()

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

overridevirtual

Sets root entity of the 3D scene.

Implements QgsAbstract3DEngine.

Definition at line 68 of file qgswindow3dengine.cpp.

setShadowRenderingEnabled()

void QgsWindow3DEngine::setShadowRenderingEnabled

(

bool

enabled

)

Sets whether shadow rendering is enabled.

Definition at line 51 of file qgswindow3dengine.cpp.

setSize()

void QgsWindow3DEngine::setSize ( QSize  s )

overridevirtual

Sets the size of the rendering area (in pixels)

Implements QgsAbstract3DEngine.

Definition at line 96 of file qgswindow3dengine.cpp.

shadowRenderingEnabled()

bool QgsWindow3DEngine::shadowRenderingEnabled ( )

inline

Returns whether shadow rendering is enabled.

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 86 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 91 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.41.0+git20241225+af5edcb665c+99sid/src/3d/qgswindow3dengine.h
• /build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/3d/qgswindow3dengine.cpp